-
Notifications
You must be signed in to change notification settings - Fork 359
fix: use actual job name in OTLP span names (#fix-span-names) #24648
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -4,7 +4,7 @@ | |||||||
| /** | ||||||||
| * action_setup_otlp.cjs | ||||||||
| * | ||||||||
| * Sends a gh-aw.job.setup OTLP span and writes the trace/span IDs to | ||||||||
| * Sends a `gh-aw.<jobName>.setup` OTLP span and writes the trace/span IDs to | ||||||||
|
||||||||
| * Sends a `gh-aw.<jobName>.setup` OTLP span and writes the trace/span IDs to | |
| * Sends a `gh-aw.<jobName>.setup` OTLP span when a job name is configured, | |
| * or falls back to `gh-aw.job.setup`, and writes the trace/span IDs to |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -16,7 +16,7 @@ const fs = require("fs"); | |||||||||||||||||||
| // Wrap everything in an async IIFE so that the OTLP span is fully sent before | ||||||||||||||||||||
| // the cleanup deletes /tmp/gh-aw/ (which contains aw_info.json and otel.jsonl). | ||||||||||||||||||||
| (async () => { | ||||||||||||||||||||
| // Send a gh-aw.job.conclusion span to the configured OTLP endpoint, if any. | ||||||||||||||||||||
| // Send a gh-aw.<jobName>.conclusion span to the configured OTLP endpoint, if any. | ||||||||||||||||||||
| // Delegates to action_conclusion_otlp.cjs so that script mode (clean.sh) and | ||||||||||||||||||||
| // dev/release mode share the same implementation. Non-fatal: errors are | ||||||||||||||||||||
| // handled inside sendJobConclusionSpan via console.warn. | ||||||||||||||||||||
|
Comment on lines
+19
to
22
|
||||||||||||||||||||
| // Send a gh-aw.<jobName>.conclusion span to the configured OTLP endpoint, if any. | |
| // Delegates to action_conclusion_otlp.cjs so that script mode (clean.sh) and | |
| // dev/release mode share the same implementation. Non-fatal: errors are | |
| // handled inside sendJobConclusionSpan via console.warn. | |
| // Send a job conclusion span to the configured OTLP endpoint, if any: | |
| // gh-aw.<jobName>.conclusion when INPUT_JOB_NAME is set, otherwise | |
| // gh-aw.job.conclusion. Delegates to action_conclusion_otlp.cjs so that | |
| // script mode (clean.sh) and dev/release mode share the same implementation. | |
| // Non-fatal: errors are handled inside sendJobConclusionSpan via console.warn. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this description,
gh-aw.<job-name>.setupreads like it might literally include the input name (job-name) rather than the value of the job name. Elsewhere in the code/comments you usegh-aw.<jobName>...; consider using the same placeholder here (or explicitly say “”) to avoid confusion.This issue also appears on line 23 of the same file.