Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cronitorio/monitor-github-actions
Add monitoring and logging to your Github Actions
https://github.com/cronitorio/monitor-github-actions
Last synced: 5 days ago
JSON representation
Add monitoring and logging to your Github Actions
- Host: GitHub
- URL: https://github.com/cronitorio/monitor-github-actions
- Owner: cronitorio
- License: mit
- Created: 2022-09-23T03:46:25.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-27T23:08:34.000Z (over 1 year ago)
- Last Synced: 2024-10-14T06:05:33.604Z (about 1 month ago)
- Language: JavaScript
- Size: 567 KB
- Stars: 8
- Watchers: 4
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Monitor Github Actions by Cronitor
Automatically monitor Github Actions Workflows using [Cronitor.io](https://cronitor.io) and a simple Github Action.
## Features
- #### Automatically sync workflows to Cronitor when they run, no manual configuration.
- #### Send telemetry to Cronitor when jobs start, complete and fail.
- #### Monitor every workflow in your repo, or easily limit to specific workflows.
## Usage
1. #### Add a ``CRONITOR_API_KEY`` secret in your repo, copying your Cronitor API key from https://cronitor.io/app/settings/api
2. #### Add a new ``cronitor.yml`` workflow to your repo, copying this example yaml. Push the new workflow to your ``main`` branch.
3. #### Done! The Cronitor Monitoring Relay will be invoked automatically for every workflow that runs in your repo.
```yaml
name: Cronitor Monitoring Relay
on:
workflow_run:
workflows: ['*']
types: [requested,completed]
jobs:
send-telemetry:
runs-on: ubuntu-latest
name: Send Telemetry
steps:
- name: Send execution details to the Cronitor for Github Actions agent
uses: cronitorio/monitor-github-actions@v7
with:
event: ${{ toJSON(github.event) }}
github_token: ${{ secrets.GITHUB_TOKEN }}
cronitor_key: ${{ secrets.CRONITOR_API_KEY }}
cronitor_group: actions
cronitor_notify: devops-alerts
```
## Parameters
| Parameter name | Required | Description |
|---------------------|----------|----------------------------------------------------|
| ``event`` | Yes | Triggering event (passed from ``github.event``) |
| ``cronitor_key`` | Yes | Your Cronitor API key |
| ``github_token`` | No | To relay workflow logs, pass your ``GITHUB_TOKEN`` |
| ``cronitor_group`` | No | Add monitors to a Cronitor group |
| ``cronitor_notify`` | No | A notification list to use for alerts |
Note: Log relay is coming soon.
## Monitoring Specific Workflows
By default, when you add the YAML for the Cronitor Monitoring Relay as an Action, it will be invoked automatically for every
workflow that runs in this repo. If you want to limit which workflows are monitored by Cronitor, you can specify those
directly in the ``on`` clause of your Cronitor workflow yaml:
```yaml
on:
workflow_run:
workflows: [job1,job2]
types: [requested,completed]
```
## Configuring Alerts
### Recipients
Alert recipients can be managed directly from this configuration file using the optional ``cronitor_notify`` input.
Provide a [notification list](https://cronitor.io/app/settings/alerts) using its key, or specify a single recipient, e.g.
`email:[email protected]`.
### Alert Settings
After adding the Cronitor Relay yaml, your workflows will appear on your Cronitor dashboard the first time they run. From the
dashboard, you will be able to customize alert preferences, including:
- Be alerted only if a workflow persistently fails
- Be alerted if a workflow does not run or complete at least once in a given time span.
- Be alerted on workflow execution time and avoid surprise charges from Github.