Skip to content

Commit c01c4d1

Browse files
corentinmusardcorentinmusard
authored
Add attributes on the workflow and job spans (#34)
1 parent bb1630c commit c01c4d1

File tree

12 files changed

+689
-437
lines changed

12 files changed

+689
-437
lines changed

‎CHANGELOG.md

+39-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [1.13.0] - 2024-12-31
11+
12+
### Added
13+
14+
- Add attributes on the workflow span:
15+
- `github.referenced_workflows`
16+
- `github.url`
17+
- `github.status`
18+
- `github.node_id`
19+
- `github.check_suite_id`
20+
- `github.check_suite_node_id`
21+
- `github.jobs_url`
22+
- `github.logs_url`
23+
- `github.check_suite_url`
24+
- `github.artifacts_url`
25+
- `github.cancel_url`
26+
- `github.rerun_url`
27+
- `github.head_branch`
28+
- `github.path`
29+
- `github.display_title`
30+
- Add attributes on the job spans:
31+
- `github.job.run_url`
32+
- `github.job.node_id`
33+
- `github.job.head_sha`
34+
- `github.job.url`
35+
- `github.job.html_url`
36+
- `github.job.status`
37+
- `github.job.runner_id`
38+
- `github.job.created_at`
39+
- `github.job.check_run_url`
40+
- `github.job.workflow_name`
41+
- `github.job.head_branch`
42+
43+
### Fixed
44+
45+
- Return the correct value for `github.head_commit.author.name` and `github.head_commit.committer.name`
46+
1047
## [1.12.1] - 2024-12-31
1148

1249
### Fixed
@@ -70,7 +107,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
70107
- Support for `https` endpoints (proto over http).
71108
- Update to node 20.x
72109

73-
[unreleased]: https://github.com/corentinmusard/otel-cicd-action/compare/v1.12.1...HEAD
110+
[unreleased]: https://github.com/corentinmusard/otel-cicd-action/compare/v1.13.0...HEAD
111+
[1.13.0]: https://github.com/corentinmusard/otel-cicd-action/compare/v1.12.1...v1.13.0
74112
[1.12.1]: https://github.com/corentinmusard/otel-cicd-action/compare/v1.12.0...v1.12.1
75113
[1.12.0]: https://github.com/corentinmusard/otel-cicd-action/compare/v1.11.0...v1.12.0
76114
[1.11.0]: https://github.com/corentinmusard/otel-cicd-action/compare/v1.10.0...v1.11.0

‎README.md

+1-69
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ permissions:
9494
| ------- | ------------------------------------------- |
9595
| traceId | The OpenTelemetry Trace ID of the root span |
9696

97-
[Sample OpenTelemetry Output](./src/__assets__/output.txt).
97+
Look at [Sample OpenTelemetry Output](./src/__assets__/output.txt) for the list of attributes and their values.
9898

9999
#### Honeycomb Example Trace
100100

@@ -159,74 +159,6 @@ jobs:
159159
runId: ${{ github.event.workflow_run.id }}
160160
```
161161

162-
## Trace Unique Fields
163-
164-
| name | type | description |
165-
| --------------------------------------- | -------- | ----------------------------------------------------- |
166-
| name | string | Workflow/Job/Step name |
167-
| service.instance.id | string | {repo_full_name}/{workflow_id}/{run_id}/{run_num} |
168-
| service.name | string | Github Workflow Name |
169-
| service.namespace | string | Github Repo Full Name |
170-
| service.version | string | Github Workflow Run HEAD SHA |
171-
| github.workflow_id | integer | Github Workflow ID |
172-
| github.workflow | string | Github Workflow Name |
173-
| github.workflow_url | string | Github Workflow URL |
174-
| github.run_attempt | integer | Github Workflow Run Attempt |
175-
| github.run_id | integer | Github Workflow Run ID |
176-
| github.run_number | integer | Github Workflow Run Number |
177-
| github.created_at | integer | Github Workflow Run Created Timestamp |
178-
| github.updated_at | integer | Github Workflow Run Updated Timestamp |
179-
| github.run_started_at | integer | Github Workflow Run Started Timestamp |
180-
| github.html_url | string | Github Workflow Run HTML URL |
181-
| github.author_email | string | **_DEPRECATED_**: use github.head_commit.author.email |
182-
| github.author_name | string | **_DEPRECATED_**: use github.head_commit.author.name |
183-
| github.conclusion | string | Github Workflow Run Conclusion |
184-
| github.event | string | Github Workflow Run Event Name |
185-
| github.git_refs_url | string | Github Workflow Run refs url |
186-
| github.head_commit.id | string | Github Workflow Run HEAD commit id |
187-
| github.head_commit.tree_id | string | Github Workflow Run HEAD commit tree id |
188-
| github.head_commit.author.name | string | Github Workflow Run HEAD author name |
189-
| github.head_commit.author.email | string | Github Workflow Run HEAD author name |
190-
| github.head_commit.committer.name | string | Github Workflow Run HEAD committer name |
191-
| github.head_commit.committer.email | string | Github Workflow Run HEAD committer name |
192-
| github.head_commit.message | string | Github Workflow Run HEAD commit message |
193-
| github.head_commit.timestamp | string | Github Workflow Run HEAD commit timestamp |
194-
| github.head_sha | string | Github Workflow Run HEAD SHA |
195-
| github.head_ref | string | Github Workflow Run HEAD REF |
196-
| github.base_sha | string | Github Workflow Run Base SHA |
197-
| github.base_ref | string | Github Workflow Run Base REF |
198-
| github.pull_requests.{X}.id | string | Github Pull Request ID |
199-
| github.pull_requests.{X}.number | integer | Github Pull Request number |
200-
| github.pull_requests.{X}.url | string | Github Pull Request url |
201-
| github.pull_requests.{X}.labels | string[] | Github Pull Request labels |
202-
| github.pull_requests.{X}.head.sha | string | Github Pull Request HEAD sha |
203-
| github.pull_requests.{X}.head.ref | string | Github Pull Request HEAD ref |
204-
| github.pull_requests.{X}.head.repo.id | string | Github Pull Request HEAD Repository id |
205-
| github.pull_requests.{X}.head.repo.url | string | Github Pull Request HEAD Repository url |
206-
| github.pull_requests.{X}.head.repo.name | string | Github Pull Request HEAD Repository name |
207-
| github.pull_requests.{X}.base.sha | string | Github Pull Request base sha |
208-
| github.pull_requests.{X}.base.ref | string | Github Pull Request base ref |
209-
| github.pull_requests.{X}.base.repo.id | string | Github Pull Request base Repository id |
210-
| github.pull_requests.{X}.base.repo.url | string | Github Pull Request base Repository url |
211-
| github.pull_requests.{X}.base.repo.name | string | Github Pull Request base Repository name |
212-
| github.job.id | float | Github Job Run ID |
213-
| github.job.name | string | Github Job Run Name |
214-
| github.job.started_at | string | Github Job Run started_at |
215-
| github.job.completed_at | string | Github Job Run completed_at |
216-
| github.job.conclusion | string | Github Job Run Conclusion |
217-
| github.job.labels | string | Github Job Run Labels. Comma separated values |
218-
| github.job.run_attempt | integer | Github Job Run Run Attempt |
219-
| github.job.run_id | integer | Github Job Run Run ID |
220-
| github.job.runner_group_id | integer | Github Job Runner Group ID |
221-
| github.job.runner_group_name | string | Github Job Runner Group Name |
222-
| github.job.runner_name | string | Github Job Runner Name |
223-
| github.job.step.status | string | GitHub Step Run Status |
224-
| github.job.step.conclusion | string | Github Step Run Conclusion |
225-
| github.job.step.name | string | Github Step Run Name |
226-
| github.job.step.number | integer | Github Step Run Number |
227-
| github.job.step.started_at | string | Github Step Run started_at |
228-
| github.job.step.completed_at | string | Github Step Run completed_at |
229-
230162
[ci-img]: https://github.com/corentinmusard/otel-cicd-action/actions/workflows/build.yml/badge.svg?branch=main
231163
[ci]: https://github.com/corentinmusard/otel-cicd-action/actions/workflows/build.yml?query=branch%3Amain
232164
[license-img]: https://img.shields.io/github/license/corentinmusard/otel-cicd-action

‎action.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ inputs:
2525
required: false
2626
outputs:
2727
traceId:
28-
description: The OpenTelemetry Trace ID for this Trace
28+
description: The OpenTelemetry Trace ID of the root span
2929

3030
branding:
3131
icon: bar-chart-2

0 commit comments

Comments
 (0)