workflow-telemetry-action
A GitHub Action to track and monitor the resource metrics of your GitHub Action workflow runs. If the run is triggered via a Pull Request, it will create a comment on the connected PR with the results and/or publishes the results to the job summary. The action collects the following metrics:
- CPU Load (user and system) in percentage
- Memory usage (used and free) in MB
- Network I/O (read and write) in MB
- Disk I/O (read and write) in MB
Example Output
An example output of a simple workflow run will look like this.
Usage
To use the action, add the following step before the steps you want to track.
- name: Collect Workflow Telemetry
uses: thundra-io/workflow-telemetry-action@v1
Configuration
Option | Requirement | Description |
---|---|---|
github_token |
Optional | An alternative GitHub token, other than the default provided by GitHub Actions runner. |
stat_frequency |
Optional | Statistic collection frequency in seconds. Must be a number. Defaults to 5 . |
comment_on_pr |
Optional | Set to true to publish the results as comment to the PR (applicable if workflow run is triggered by PR). Defaults to true . |
job_summary |
Optional | Set to true to publish the results as part of the job summary page of the workflow run. Defaults to true . |
theme |
Optional | Set to dark to generate charts compatible with Github dark mode. Defaults to light . |