austenstone/GitHub Actions Telemetry to OpenTelemetry

Capture GitHub Actions runner telemetry and export it to an OpenTelemetry endpoint, with optional summaries and custom-image support.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
otlp-endpointFull OTLP HTTP metrics endpoint, for example https://your-collector.example.com/v1/metricsno
otlp-traces-endpointOptional OTLP HTTP traces endpoint. Defaults to the metrics endpoint with /v1/traces.no
otlp-headersComma, newline, or semicolon separated HTTP headers in key=value formatno
github-tokenGitHub token used to enrich traces with workflow job and step metadatano
summary-onlySample locally and write only the job summary without requiring any OTLP endpointnofalse
service-nameOpenTelemetry service.name resource attributenogithub-runner-telemetry
metric-prefixPrefix used for emitted metric namesnogithub.runner
sample-interval-msSampling interval in millisecondsno5000
export-timeout-msExport timeout in millisecondsno10000
include-networkRecord aggregated network throughput metricsnotrue
include-filesystemRecord filesystem utilization and throughput metricsnotrue
include-loadRecord load average metrics when the operating system supports themnotrue
enable-job-summaryAppend a markdown recommendation summary to the workflow job summarynotrue
enable-tracesExport workflow and job trace spans to the OTLP traces endpointnotrue
enable-github-api-enrichmentUse the GitHub API to enrich workflow traces with job and step spansnotrue
recommendation-cpu-thresholdCPU p95 threshold that should trigger a larger runner recommendationno85
recommendation-memory-thresholdMemory max threshold that should trigger a larger runner recommendationno80
recommendation-disk-thresholdDisk max threshold that should trigger a larger runner recommendationno85
additional-resource-attributesExtra resource attributes in key=value format separated by commas, semicolons, or newlinesno
namedescription
telemetry-directoryDirectory used for transient sample and summary files
samples-pathJSONL file containing sampled runner vitals
summary-pathJSON file containing the final recommendation summary
raw-bundle-pathJSON file containing the raw telemetry bundle with config, samples, summary, and optional trace metadata