You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# workflow-telemetry-action
2
2
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:
4
4
5
5
- CPU Load (user and system) in percentage
6
6
- 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.
21
21
- name: Collect Workflow Telemetry
22
22
uses: thundra-io/workflow-telemetry-action@v1
23
23
```
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