Skip to content

Commit 796ee5e

Browse files
author
Serkan ÖZAL
authored
Update README.md
1 parent 42d68c2 commit 796ee5e

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# workflow-telemetry-action
22

3-
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. The action collects the following metrics:
3+
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:
44

55
- CPU Load (user and system) in percentage
66
- Memory usage (used and free) in MB
@@ -21,3 +21,12 @@ To use the action, add the following step before the steps you want to track.
2121
- name: Collect Workflow Telemetry
2222
uses: thundra-io/workflow-telemetry-action@v1
2323
```
24+
25+
## Configuration
26+
27+
| Option | Requirement | Description
28+
| --- | --- | ---
29+
| `github_token` | Optional | An alternative GitHub token, other than the default provided by GitHub Actions runner.
30+
| `stat_frequency` | Optional | Statistic collection frequency in seconds. Must be a number. Defaults to `5`.
31+
| `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`.
32+
| `job_summary` | Optional | Set to `true` to publish the results as part of the [job summary page](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/) of the workflow run. Defaults to `true`.

0 commit comments

Comments
 (0)