opentelemetry-trace-export-.../README.md
Marc Cataford 252c30cbac
All checks were successful
/ static_analysis (push) Successful in 57s
docs: add notice about read mirror
2024-10-18 23:05:46 -04:00

34 lines
1 KiB
Markdown

# opentelemetry-trace-export-forgejo-action
Handles the export of OTel traces from Forgejo Actions.
# Read mirror & usage
If you'd like to use this in your flows, kindly use the [Gitlab mirror
URL](https://gitlab.com/mcataford/opentelemetry-trace-export-forgejo-action).
---
# Usage
The action pulls action run metadata from non-documented Forgejo APIs and run context data; as long as it runs as the last step, it should capture details from every job in the pipeline.
```yml
jobs:
stepA:
...
stepB:
...
export-otel-traces:
...
needs: [stepA, stepB]
steps:
- uses: https://forge.karnov.club/marc/opentelemetry-trace-export-forgejo-action
with:
otlp-endpoint: <GRPC endpoint to send traces to>
otlp-service-name: <Service name to attach to traces>
forgejo-token: <Action-scoped token>
forgejo-base-url: <Base url of the Forgejo instance where the actions are running>
run-id: <Current CI run ID>
repo-name: <Current repository name>
```