Skip to content

Commit

Permalink
chore: update readme for github resource detector
Browse files Browse the repository at this point in the history
Update README of GitHub Resource Detector to clarify the source of the data.

Part Of #2055

Signed-off-by: maryliag <marylia.gutierrez@grafana.com>
  • Loading branch information
maryliag committed Mar 28, 2024
1 parent 85cbc8d commit a9a1dce
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions detectors/node/opentelemetry-resource-detector-github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,21 @@ async function run() {
run()
```

## Available detectors

### GitHub Detector

| 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](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables)
Expand Down

0 comments on commit a9a1dce

Please sign in to comment.