GitHub Actions workflow telemetry integration

Test the integration

Send and verify events with GitHub Actions workflow telemetry integration

Use GitHub Actions workflow telemetry integration where your app knows the final result. Collect only the fields you need, then verify a test event before building charts.

1
Choose the outcome
CI workflow reliability
2
Define the contract
workflow_name, job_name, run_id, run_attempt, status, duration_ms, repository, and release
3
Log the final result
Use if: always() so failed jobs still produce a final record. Use continue-on-error: true if a telemetry delivery failure should not fail the workflow.
4
Check the stored event
Exercise a known fixture, then inspect github_workflow_completed for one correctly typed terminal row.

Before you start

A write-scoped Telemetry key stored as a GitHub Actions secret
A final step guarded with always() and configured not to override the workflow outcome when telemetry delivery fails
An allowlist of GitHub-provided variables that excludes event payloads, tokens, actor data, commit messages, and pull-request content

Delivery setup

Install and initialize server-side

Use the cURL examples with explicit connection and request timeouts. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.

1Create one reusable server-side client. Set its timeout and retry limit.
2Log an event when the operation succeeds, fails, retries, or times out.
3Send test events with known results and inspect the stored rows before enabling an alert.

Snippet

Start with one structured event

Add this shape where the workflow completes, fails, or retries. Then build the dashboard from real fields.

github-actions

GitHub Actions workflow telemetry integration event

bash

# Use in a final GitHub Actions step with:
# if: ${{ always() }}
# continue-on-error: true
# env:
#   TELEMETRY_API_KEY: ${{ secrets.TELEMETRY_WRITE_KEY }}
#   JOB_STATUS: ${{ job.status }}

jq -n   --arg workflow_name "$GITHUB_WORKFLOW"   --arg job_name "$GITHUB_JOB"   --arg run_id "$GITHUB_RUN_ID"   --arg run_attempt "$GITHUB_RUN_ATTEMPT"   --arg status "$JOB_STATUS"   --arg repository "$GITHUB_REPOSITORY"   --arg release "$GITHUB_SHA"   '{
    table: "github_workflow_completed",
    data: {
      workflow_name: $workflow_name,
      job_name: $job_name,
      run_id: $run_id,
      run_attempt: ($run_attempt | tonumber),
      status: $status,
      repository: $repository,
      release: $release
    }
  }' |
curl --fail-with-body --connect-timeout 2 --max-time 5   --request POST "https://api.telemetry.sh/log"   --header "Authorization: ${TELEMETRY_API_KEY}"   --header "Content-Type: application/json"   --data-binary @-

Event schema

workflow_name, job_name, run_id, run_attempt, status, duration_ms, repository, and release

trigger_type, runner_environment, scheduled, retry_recovered, and controlled error_type when approved

No GITHUB_TOKEN, secrets context, github.event payload, environment dump, commit message, branch supplied by an untrusted fork, or arbitrary step output

Check your setup

Checkpoint 1

Use if: always() so failed jobs still produce a final record. Use continue-on-error: true if a telemetry delivery failure should not fail the workflow.

Checkpoint 2

GitHub warns that contexts can contain sensitive information and that some context values should be treated as untrusted input. Expand only the documented allowlist into shell environment variables.

Checkpoint 3

Use GITHUB_RUN_ID as the logical run identifier and GITHUB_RUN_ATTEMPT to distinguish reruns. Measure duration from a controlled start timestamp rather than inferring it from unrelated events.

Verification

Prove the event arrived

Run this after exercising known success and failure cases. Replace the fallback table name if your final event contract differs from the snippet.

github-actions-verification

GitHub Actions workflow telemetry integration verification query

sql

SELECT *
FROM github_workflow_completed
ORDER BY timestamp_utc DESC
LIMIT 20;

Confirm one terminal row per logical outcome, with the expected status, identifiers, units, and UTC time.

Inspect the inferred schema and verify that retries do not change field types or generate a new logical event ID.

Search the stored fields for credentials, raw payloads, prompts, private content, and unbounded error messages.

Exercise a provider timeout, ingestion rejection, and process shutdown before treating the dashboard as complete.

Implementation references

Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.

Test telemetry in CI Missed schedule SQL Workflow correlation SQL GitHub Actions contexts GitHub Actions variables

Where to log

Keep the outcome event small and recoverable

This pattern provides

Record the outcome as an event you can query with SQL.
Stable fields for dashboards, alerts, and cross-event correlation.
Test events for checking success, failure, retries, and timeouts.

This pattern does not provide

An OTLP exporter, automatic collection pipeline, or replacement for detailed traces and diagnostic logs.
Exactly-once delivery merely because the payload contains an event ID.
Permission to collect raw provider payloads, user content, credentials, or regulated data.

Delivery and idempotency Batching and shutdown Troubleshoot ingestion

Example event schemas

Check what each event records, when to send it, and which field types it needs. Review the example payload and privacy checklist before using it in production.

Async reliability11 fields