Skip to content

Commit fa73bb4

Browse files
committed
fix: span status and message
1 parent 576871e commit fa73bb4

6 files changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
# Export Job Telemetry
22

3-
This GitHub Action exports telemetry data for a GitHub Actions job, including resource attributes and timing information, using OpenTelemetry.
3+
This GitHub Action is designed to export telemetry data for a GitHub Actions job, including resource attributes and timing information, using OpenTelemetry. To minimise API calls to the GitHub API and to ensure deterministic trace and span IDs, instrument your workflow with [https://github.com/krzko/set-up-telemetry](https://github.com/krzko/set-up-telemetry).
4+
5+
This action is intended to be used in conjunction with the [OpenTelemetry Collector GitHub Actions Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/27460). This receiver processes GitHub Actions webhook events to observe workflows and jobs, converting them into trace telemetry for detailed observability.
46

57
## Features
68

79
- Export trace data in OpenTelemetry format.
810
- Capture and report the start and end times of the GitHub Actions job.
911
- Include custom resource attributes for enhanced observability.
12+
- Utilises deterministic Trace and Span IDs to align with the OpenTelemetry Collector GitHub Actions Receiver.
13+
14+
## GitHub Actions Receiver
15+
16+
The GitHub Actions Receiver processes GitHub Actions webhook events to observe workflows and jobs. It handles `workflow_job` and `workflow_run` event payloads, transforming them into trace telemetry. This allows the observation of workflow execution times, success, and failure rates. If a secret is configured (recommended), it validates the payload ensuring data integrity before processing.
17+
18+
For more details on the receiver, see the GitHub issue: [OpenTelemetry Collector Contrib #27460](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/27460).
1019

1120
## Usage
1221

@@ -31,7 +40,7 @@ jobs:
3140
steps:
3241
- name: Set up telemetry
3342
id: set-up-telemetry
34-
uses: krzko/set-up-telemetry@v0.1.0
43+
uses: krzko/set-up-telemetry@v0.2.0
3544

3645
- name: Checkout
3746
uses: actions/checkout@v4
@@ -40,7 +49,7 @@ jobs:
4049

4150
- name: Export job telemetry
4251
if: always()
43-
uses: krzko/export-job-telemetry@v0.1.0
52+
uses: krzko/export-job-telemetry@v0.2.0
4453
with:
4554
job-status: ${{ job.status }}
4655
otel-exporter-otlp-endpoint: ${{ env.otel-exporter-otlp-endpoint }}
@@ -54,7 +63,7 @@ jobs:
5463
steps:
5564
- name: Set up telemetry
5665
id: set-up-telemetry
57-
uses: krzko/set-up-telemetry@v0.1.0
66+
uses: krzko/set-up-telemetry@v0.2.0
5867

5968
- name: Checkout
6069
uses: actions/checkout@v4
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
-272 Bytes
Binary file not shown.
-640 Bytes
Binary file not shown.
2.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)