chore: update readme for github resource detector (#2064)

Update README of GitHub Resource Detector to clarify the source of the data. Refs: #2055 Signed-off-by: maryliag <[email protected]>
open-telemetry · Apr 9, 2024 · eaa99f8 · eaa99f8
1 parent 88514d9
commit eaa99f8
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/detectors/node/opentelemetry-resource-detector-github/README.md b/detectors/node/opentelemetry-resource-detector-github/README.md
@@ -33,6 +33,21 @@ async function run() {
 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](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables)