https://github.com/getsentry/sentry-github-actions-app
This app allows your organization to instrument Github Actions with Sentry. You can use this to get insight of what parts of your CI are slow or failing often
https://github.com/getsentry/sentry-github-actions-app
github instrumentation sentry tag-non-production
Last synced: 9 months ago
JSON representation
This app allows your organization to instrument Github Actions with Sentry. You can use this to get insight of what parts of your CI are slow or failing often
- Host: GitHub
- URL: https://github.com/getsentry/sentry-github-actions-app
- Owner: getsentry
- License: mit
- Created: 2022-03-25T19:15:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T13:16:00.000Z (11 months ago)
- Last Synced: 2025-03-22T06:47:09.505Z (9 months ago)
- Topics: github, instrumentation, sentry, tag-non-production
- Language: Python
- Homepage:
- Size: 104 KB
- Stars: 21
- Watchers: 4
- Forks: 8
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Sentry GitHub Actions App
[](https://codecov.io/gh/getsentry/sentry-github-actions-app)
**NOTE**: If this is a project you would like us to invest in, please let us know in [this issue](https://github.com/getsentry/sentry-github-actions-app/issues/46). You can try this app by following the steps in the "Try it out" section below.
[This app](https://github.com/apps/sentry-github-app-alpha) allows your organization to instrument GitHub Actions with Sentry. You can use this to get insights of what parts of your CI are slow or failing often.
It works by listening to GitHub workflow events via a webhook configured in a GitHub App. These events are then stored in Sentry as performance transactions. The best value for this project is when you have [Sentry's Discover](https://docs.sentry.io/product/discover-queries/) and [Dashboards](https://docs.sentry.io/product/dashboards/) in order to slice the data and answer the questions you care about. In a sense, this project turns GitHub's CI into an app which Sentry monitors, thus, you can use many of the features you're already familiar with.
**NOTE**: The Discover feature is only available on either a Business or Trial Plan.
**NOTE**: The Dashboards feature is only available on the Team Plan or higher.
There's likely products out there that can give you insights into GitHub's CI, however, this may be cheaper, it saves you having to add another vendor and your developers are already familiar with using Sentry.
## Examples
This screenshot shows that you can group GitHub Actions through various tags in Sentry's Discover:
This screenshot shows the transaction view for an individual GitHub Action showing each step of the job:
## Features
Here's a list of benefits you will get if you use this project:
- Visualize a GitHub job and the breakdown per step
- For instance, it makes it easy to see what percentage of the jobs are dedicated to set up versus running tests
- Create CI alerts
- For instance, if your main branch has a failure rate above a certain threshold
- Notice when `on: schedule` workflows fail which currently GitHub does not make it easy to notice
- Create widgets and dashboards showing your CI data
- For instance you can show: slowest jobs, most failing jobs, jobs requirying re-runs, repos consuming most CI
- Some of the main tags by which you can slice the data: workflow file, repo, branch, commit, job_status, pull_request, run_attempt
Watch this video showing the features described above:
https://user-images.githubusercontent.com/44410/187217254-ad7c2eba-f4d4-4a08-9733-54cf92f466ec.mp4
## Try it out
Steps to follow:
1. Create a Sentry project to gather your GitHub CI data
1. You don't need to select a platform in the wizard or any alerts
2. Find the DSN key under the settings of the project you created
2. Create a private repo named `.sentry`
3. Create a file in that repo called `sentry_config.ini` with these contents (adjust your DSN value)
```ini
[sentry-github-actions-app]
; DSN value of the Sentry project you created in step (1) above.
dsn = https://foo@bar.ingest.sentry.io/foobar
```
4. Install [this GitHub App](https://github.com/apps/sentry-github-app-alpha)
1. **"All repositories"** - this is the easiest option; all repositories will have telemetry from GitHub Actions sent.
2. **"Only select repositories"**
1. Ensure that the `.sentry` private repository (created in step 2 above) is selected
2. Select any projects that are desired to have telemetry from all containing GitHub Actions sent.
- **Note:** Regardless of which is selected, we only request **workflow jobs** and a **single file** permissions.
**NOTE**: In other words, we won't be able to access any of your code.
Give us feedback in [this issue](https://github.com/getsentry/sentry-github-actions-app/issues/46).
## Local development
Prerequisites:
- ngrok (for local dev)
Set up:
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install wheel
pip install -r requirements.txt -r requirements-dev.txt
```
You can ingest a single job without webhooks by using the cli. For example:
```shell
# This is a normal URL of a job on GitHub
python3 cli.py https://github.com/getsentry/sentry/runs/5759197422?check_suite_focus=true
# From test fixture
python3 cli.py tests/fixtures/jobA/job.json
```
Steps to ingest events from a repository:
- Install ngrok, authenticate and start it up (`ngrok http 5001`)
- Take note of the URL
- Create a GitHub webhook for the repo you want to analyze
- Choose `Workflow jobs` events & make sure to choose `application/json`
- Put Ngrok's URL there
Table of commands:
| Command | Description |
| ---------------------------------- | ---------------------------------------------- |
| flask run -p 5001 | Start the Flask app on |
| pre-commit install | Install pre-commit hooks |
| tox | Run tests in isolated environment |
| pytest | Run Python tests |
| pytest --cov=src --cov-report=html | Generate code coverage. |
## Sentry staff info
Google Cloud Build will automatically build a Docker image when the code merges on `main`. Log-in to Google Cloud Run and deploy the latest image.