{"id":20314915,"url":"https://github.com/catchpoint/foresight-workflow-kit-action","last_synced_at":"2025-04-11T17:21:42.914Z","repository":{"id":41963118,"uuid":"509166489","full_name":"catchpoint/foresight-workflow-kit-action","owner":"catchpoint","description":null,"archived":false,"fork":false,"pushed_at":"2023-02-04T12:52:08.000Z","size":10191,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-03-14T18:35:57.236Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/catchpoint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-30T17:06:37.000Z","updated_at":"2023-11-21T14:26:40.000Z","dependencies_parsed_at":"2023-02-18T16:31:01.032Z","dependency_job_id":null,"html_url":"https://github.com/catchpoint/foresight-workflow-kit-action","commit_stats":{"total_commits":42,"total_committers":7,"mean_commits":6.0,"dds":0.5238095238095238,"last_synced_commit":"bb70175d6decdc28fd1d6f2bbd0c7a5350985939"},"previous_names":["runforesight/foresight-workflow-kit-action"],"tags_count":13,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catchpoint%2Fforesight-workflow-kit-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catchpoint%2Fforesight-workflow-kit-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catchpoint%2Fforesight-workflow-kit-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catchpoint%2Fforesight-workflow-kit-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/catchpoint","download_url":"https://codeload.github.com/catchpoint/foresight-workflow-kit-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248447699,"owners_count":21105161,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T18:17:11.046Z","updated_at":"2025-04-11T17:21:42.893Z","avatar_url":"https://github.com/catchpoint.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# foresight-workflow-kit-action\n\nA 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:\n\n- CPU Load (user and system) in percentage\n- Memory usage (used and free) in MB\n- Network I/O (receive and transmit) in MB\n- Disk I/O (read and write) in MB\n\n## Usage\n\nTo use the action, add the following step before the steps you want to track.\n\n```yaml\n- name: Collect Workflow Telemetry\n  uses: runforesight/foresight-workflow-kit-action@v1\n  with:\n    api_key: \u003cforesight_api_key\u003e\n```\n\n## Configuration\n\n| Option                | Requirement       | Description\n| ---                   | ---               | ---\n| `api_key`        | Optional          |  Foresight API Key. Foresight API key is **required** for private repositories but **optional** for public open-source repositories  \n| `github_token`        | Optional          | An alternative GitHub token, other than the default provided by GitHub Actions runner.\n| `min_proc_duration`      | Optional          | Minimum duration value in milliseconds to trace processes. Must be a number. Defaults to '-1' (no min value).\n| `trace_sys_procs`      | Optional          | Enables tracing default system processes ('aws', 'cat', 'sed', ...). Defaults to 'false'.\n| `stat_frequency`      | Optional          | Statistic collection frequency in seconds. Must be a number. Defaults to `5`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatchpoint%2Fforesight-workflow-kit-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatchpoint%2Fforesight-workflow-kit-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatchpoint%2Fforesight-workflow-kit-action/lists"}