@opentelemetry/resource-detector-github

OpenTelemetry Resource Detector for GitHub Actions

Resource detector for GitHub Actions.

Detects GITHUB_* environment variables specified here and adds as attributes on a resource.

This is useful for collecting telemetry in GitHub Actions-powered CI/CD workflows.

The OpenTelemetry Resource is an immutable representation of the entity producing telemetry. For example, a process producing telemetry that is running in a container on Kubernetes has a Pod name, it is in a namespace and possibly is part of a Deployment which also has a name. All three of these attributes can be included in the Resource.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @opentelemetry/resource-detector-github

Usage

const { gitHubDetector } = require('@opentelemetry/opentelemetry-resource-detector-github')

async function run() {
  // Initialize GitHub Resource Detector
  const resource = await gitHubDetector.detect();
};

run()

Available detectors

GitHub Detector

Resource Attribute	Description
github.actor	Value of Process Environment Variable GITHUB_ACTOR
github.base_ref	Value of Process Environment Variable GITHUB_BASE_REF
github.head_ref	Value of Process Environment Variable GITHUB_HEAD_REF
github.ref	Value of Process Environment Variable GITHUB_REF
github.run_id	Value of Process Environment Variable GITHUB_RUN_ID
github.run_number	Value of Process Environment Variable GITHUB_RUN_NUMBER
github.sha	Value of Process Environment Variable GITHUB_SHA
github.workflow	Value of Process Environment Variable GITHUB_WORKFLOW

Useful links

• GitHub Action Environment Variables
• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.