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
+17-1Lines changed: 17 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,26 @@
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 and/or publishes the results to the job summary. The action collects the following metrics:
3
+
A GitHub Action to track and monitor the resource metrics and process activities of your GitHub Action workflow runs.
4
+
If the run is triggered via a Pull Request, it will create a comment on the connected PR with the results
5
+
and/or publishes the results to the job summary.
4
6
7
+
The action collects the following metrics:
5
8
- CPU Load (user and system) in percentage
6
9
- Memory usage (used and free) in MB
7
10
- Network I/O (read and write) in MB
8
11
- Disk I/O (read and write) in MB
9
12
13
+
And traces the process executions with the following information (only supported on `Ubuntu`):
14
+
- Name
15
+
- Id
16
+
- Parent id
17
+
- User id
18
+
- Start time
19
+
- Duration (in ms)
20
+
- Exit code
21
+
- File name
22
+
- Arguments
23
+
10
24
### Example Output
11
25
12
26
An example output of a simple workflow run will look like this.
@@ -28,6 +42,8 @@ To use the action, add the following step before the steps you want to track.
28
42
| --- | --- | ---
29
43
| `github_token` | Optional | An alternative GitHub token, other than the default provided by GitHub Actions runner.
30
44
| `stat_frequency` | Optional | Statistic collection frequency in seconds. Must be a number. Defaults to `5`.
45
+
| `min_proc_duration` | Optional | Puts minimum limit for process execution duration to be traced. Must be a number. Defaults to `-1` which means process duration filtering is not applied.
46
+
| `trace_sys_procs` | Optional | Enables tracing default system processes (`aws`, `cat`, `sed`, ...). Defaults to `false`.
31
47
| `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
48
| `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`.
33
49
| `theme` | Optional | Set to `dark` to generate charts compatible with Github **dark** mode. Defaults to `light`.
Copy file name to clipboardExpand all lines: action.yml
+9Lines changed: 9 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,14 @@ inputs:
10
10
description: "Statistic collection frequency in seconds. Must be a number. Defaults to '5'."
11
11
default: 5
12
12
required: false
13
+
min_proc_duration:
14
+
description: "Puts minimum limit for process execution duration to be traced. Must be a number. Defaults to '-1' which means process duration filtering is not applied."
15
+
default: -1
16
+
required: false
17
+
trace_sys_procs:
18
+
description: "Enables tracing default system processes ('aws', 'cat', 'sed', ...). Defaults to 'false'."
19
+
default: 'false'
20
+
required: false
13
21
comment_on_pr:
14
22
description: "Set to `true` to publish the results as comment to the PR (applicable if workflow run is triggered from PR). Defaults to 'true'."
15
23
default: 'true'
@@ -22,6 +30,7 @@ inputs:
22
30
description: "Set to `dark` to generate charts compatible with Github dark mode. Defaults to 'light'."
0 commit comments