https://github.com/planetscale/telemetry-buildkite-plugin
https://github.com/planetscale/telemetry-buildkite-plugin
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/planetscale/telemetry-buildkite-plugin
- Owner: planetscale
- License: apache-2.0
- Created: 2024-08-16T21:04:11.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-05-22T19:23:04.000Z (about 1 month ago)
- Last Synced: 2026-05-22T21:30:17.483Z (about 1 month ago)
- Language: Shell
- Size: 352 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Buildkite Job Telemetry Reporter
Capture and report telemetry (CPU/memory/disk/network) from Buildkite jobs.
Metrics are collected with `dstat` on 10 second intervals and added to the job log
at the end of the job.
## Example
Add the following to your `pipeline.yml`:
```yaml
steps:
- command: ./run_build.sh
plugins:
- planetscale/telemetry#v0.0.7: {}
```
The are no configuration options at this time.
## Developing
To run the linters:
```shell
make lint
```
To run the tests:
```shell
make test
```
## Releases
A new version is automatically released on all main branch merges. We use
[autotag](https://github.com/pantheon-systems/autotag) to generate tags. Autotag
can be configured via commit messages. By default, it will increment the patch
version. To increment the minor or major version, include [minor] or [major] in the
first line of a commit message.
## Contributing
1. Fork the repo
2. Make changes
3. Run the tests
4. Commit and push your changes
5. Send a pull request
## TODO
This should be rewritten as a standalone app with a nicer summary and graphs attached
to the job via `buildkite-agent annotate`. For now, the 10-second interval output of
`dstat` is good enough.
Inspiration: https://github.com/catchpoint/workflow-telemetry-action