Add OTLP job log export#3979
Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
5833518 to
60aa8fe
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 60aa8fe29d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
60aa8fe to
2566837
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2566837108
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
25d9724 to
a4d79b0
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a4d79b0c8d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
852196b to
8851f51
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8851f514f1
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
8851f51 to
061c4c5
Compare
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7d6cfdf486
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review Please focus on the new control-line parity change (latest commit |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2d124cc3e2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review Updated since the last review with commit
Validated end-to-end against a real build on |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b7e9eb9e4e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
Hey @catkins just wondering if this is ready for review or still needed? |
b7e9eb9 to
a0a4224
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a0a4224486
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
I found blockers on existing threads: the bootstrap flag can still be enabled from job env when the agent option is off, stdout/stderr OTLP wrapping still keeps separate redaction buffers, and the default batch processor can silently drop log records under load.
Want to dig deeper?
The full session log is attached to this Buildkite build. Download the session file and open a new pi session with it:
Download the buildsworth logs from build 5004, then answer my questions about the findings.
There was a problem hiding this comment.
Two of the previous blockers are fixed: the bootstrap env is now forced from agent config, and the log processor no longer uses the dropping batch queue. The stdout/stderr redaction concern is still open on the existing thread because the WithStringSearch path still splits the OTLP redaction state, so I'm leaving changes requested.
Want to dig deeper?
The full session log is attached to this Buildkite build. Download the session file and open a new pi session with it:
Download the buildsworth logs from build 5034, then answer my questions about the findings.
Previous concerns have been addressed.
There was a problem hiding this comment.
The previous stdout/stderr redaction blocker is fixed, but I found one remaining redaction-state split across separate command runs, so I'm leaving changes requested.
Want to dig deeper?
The full session log is attached to this Buildkite build. Download the session file and open a new pi session with it:
Download the buildsworth logs from build 5120, then answer my questions about the findings.
Previous concerns have been addressed.
There was a problem hiding this comment.
I found one new blocker after the previous redaction split was fixed: the OTLP redactor now preserves state across command wrappers, but it doesn't flush at the same boundaries as the customer-facing redactor, so partial matches can be delayed or attributed to the next phase instead of matching the Buildkite log.
Want to dig deeper?
The full session log is attached to this Buildkite build. Download the session file and open a new pi session with it:
Download the buildsworth logs from build 5123, then answer my questions about the findings.
Previous concerns have been addressed.
There was a problem hiding this comment.
The previous redaction-flush blocker is fixed, and I don't see any new blockers. I left one non-blocking note on the existing control-output parity thread; because this touches the secrets/log-export path I'm leaving a comment rather than approving.
Want to dig deeper?
The full session log is attached to this Buildkite build. Download the session file and open a new pi session with it:
Download the buildsworth logs from build 5127, then answer my questions about the findings.
Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019ebe62-7ccf-774b-ba96-19d000353bdb Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019ebe62-7ccf-774b-ba96-19d000353bdb Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Previously OTLP job log export was split across the process boundary: the agent process emitted records when tracing was not OpenTelemetry, and the bootstrap process emitted them when it was. That produced two near-identical implementations, a duplicated buildkite.* attribute schema, and two different sources of phase/hook truth (brittle log-text regex parsing in the agent vs structured HookConfig in the bootstrap). The same --job-logs-otlp flag also yielded materially different output depending on the unrelated tracing backend. Make the bootstrap process the single home for OTLP job log export: - Remove the agent-side emitter (agent/otlp_job_logger.go) and its wiring in job_runner.go / run_job.go. - Activate the bootstrap OTLP logger whenever --job-logs-otlp is set, regardless of tracing backend. Records are trace-correlated when OpenTelemetry tracing is enabled and uncorrelated otherwise. The agent still propagates BUILDKITE_JOB_LOGS_OTLP to the bootstrap. Amp-Thread-ID: https://ampcode.com/threads/T-019ebf08-2dbd-710f-ad6d-5bc1c842bb0a Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: Chris Atkins <chris.a@buildkite.com>
The bootstrap OTLP job log writer wrapped the shell's stdout writer, which is itself the secret redactor. Because the OTLP writer sat upstream of the redactor, it emitted raw pre-redaction bytes to the OTLP backend while the customer-facing job log was correctly redacted. Confirmed live against a local ClickStack: a redacted env var appeared verbatim in OTLP records. Route the OTLP copy through its own replacer.Replacer seeded with the live needle set from the job's redactor Mux, so OTLP records carry the same [REDACTED] markers as the job log. Streaming redaction also handles secrets split across multiple writes. - Add replacer.Mux.Needles() to expose the current needle set. - Split otlpJobLogWriter into a tee that feeds a redactor whose downstream is a line-buffering OTLP emitter. - Add regression tests for inline and split-across-writes secrets. Amp-Thread-ID: https://ampcode.com/threads/T-019ebf08-2dbd-710f-ad6d-5bc1c842bb0a Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Tee the redacted shell logger output (section headers, prompts, comments, warnings) into the OTLP exporter so exported records match the downloadable Buildkite job log and the UI stream. Previously only child-process output was mirrored, so OTLP destinations were missing the control lines customers see. Amp-Thread-ID: https://ampcode.com/threads/T-019ebf08-2dbd-710f-ad6d-5bc1c842bb0a Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Address adversarial review findings: - Sync the per-command OTLP redactor with the live redactor Mux on each write so secrets added mid-command (e.g. via the Job API) are redacted in OTLP output, not just secrets known when the command writer was created. - Hold the teeWriter lock across the whole write so detaching the OTLP control sink cannot race with an in-flight write, preventing control output from landing on the emitter after it has been flushed and the provider shut down. Amp-Thread-ID: https://ampcode.com/threads/T-019ebf08-2dbd-710f-ad6d-5bc1c842bb0a Co-authored-by: Amp <amp@ampcode.com> Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Co-authored-by: Chris Atkins <chris.a@buildkite.com>
Co-authored-by: Chris Atkins <chris.a@buildkite.com>
6dc004a to
e03ce51
Compare
Previous concerns have been addressed.
There was a problem hiding this comment.
Previous blocking threads look addressed, and I don't see any new blockers from this pass. Because this change touches the job-log export and secret-redaction path, I'm leaving this as a comment rather than approving.
Want to dig deeper?
The full session log is attached to this Buildkite build. Download the session file and open a new pi session with it:
Download the buildsworth logs from build 6036, then answer my questions about the findings.
| } | ||
|
|
||
| // teeWriter writes to a primary writer and, when configured, also to a |
There was a problem hiding this comment.
This file is already huge, can we have teeWriter in a separate file?
| cli.BoolFlag{ | ||
| Name: "job-logs-otlp", | ||
| EnvVar: "BUILDKITE_JOB_LOGS_OTLP", | ||
| Hidden: true, |
There was a problem hiding this comment.
I don't think we bother hiding flags, even in bootstrap, unless they are deprecated or not yet ready.
| } | ||
|
|
||
| func (e *otlpLineEmitter) emit(line string) { | ||
| now := time.Now() |
There was a problem hiding this comment.
The ANSI timestamper writes timestamp at the start of each line, and also injects additional timestamps every so often for lines that take a long time to be produced by the command. The now computed here is at the end of each line. That might be a discrepancy the especially log-curious customers notice.
| // Keep the OTLP redactor's needles in sync with the live job redactor | ||
| // before redacting, so secrets added mid-command (e.g. via the Job API) | ||
| // are redacted in OTLP output too. Replacer.Add deduplicates, so re-adding | ||
| // the full needle set each write is safe. |
There was a problem hiding this comment.
This problem is solved elsewhere by adding all redactors the executor's mux, which is updated with new needles only when they change. The replacer's Add method is not engineered to be called super frequently (worst case is quadratic in number of needles).
Description
Adds an opt-in job log OTLP sink. When
--job-logs-otlp/BUILDKITE_JOB_LOGS_OTLPis enabled, the agent emits job output as OpenTelemetry log records using the existing OTLP exporter environment configuration. This is an additional sink: the normal Buildkite job log is still streamed to the control plane unchanged. The difference from that stream is that OTLP records carry native OTLP timestamps rather than timestamps encoded into the ANSI/OSC job-log body.The OTLP endpoint and transport are intentionally inherited from the OpenTelemetry exporter configuration rather than adding Buildkite-specific endpoint flags. For logs, set
OTEL_EXPORTER_OTLP_LOGS_ENDPOINTfor a log-specific endpoint orOTEL_EXPORTER_OTLP_ENDPOINTfor the generic endpoint; protocol selection followsOTEL_EXPORTER_OTLP_LOGS_PROTOCOL/OTEL_EXPORTER_OTLP_PROTOCOL.The log records carry native OTLP timestamps plus a small set of Buildkite attributes for correlation: organization, pipeline, branch, queue, agent, build, job, current phase, and current hook scope/plugin where known. Trace correlation uses the native OTLP
LogRecordtrace context fields rather than duplicatingtrace_id/span_idas log attributes.Parity with the Buildkite job log
The OTLP sink mirrors the same visible content customers see in the Buildkite UI / downloadable job log, so an OTLP destination is not confusingly different from Buildkite:
~~~), prompts ($), comments (#) and warnings — is mirrored by teeing the redacted shell logger output into the exporter.Both paths emit the same bytes (including ANSI colour codes) that land in the downloadable Buildkite log. The only intended difference is the timestamp transport: OTLP records use the native
LogRecordtimestamp instead of the\x1b_bk;t=…OSC markers Buildkite encodes into the raw log body. The human-visible content is identical in both destinations.Control output is bootstrap narration rather than the output of a specific traced hook/command, so those records carry the base
buildkite.*attributes but no per-hook span context; child-process records remain trace-correlated to their hook/command span.Architecture: bootstrap-only
OTLP job log export lives entirely in the bootstrap process, which is the single home for this feature. This is a deliberate choice: the bootstrap is the process that actually runs the hooks and command, so it has structured phase/hook metadata and the active hook/command span directly, with no need to reconstruct them from the job-log text downstream. Keeping emission here also means a single emitter, a single
buildkite.*attribute schema, and behaviour that does not vary with the (otherwise unrelated) tracing backend.The bootstrap emits records whenever
--job-logs-otlpis enabled, regardless of tracing backend:TraceId/SpanIdas the corresponding exported hook/command span.--tracing-propagate-traceparentonly controls accepting the Buildkite control-plane traceparent; it is not required for local agent trace/log correlation.flowchart TD subgraph agent["Agent process"] AS["buildkite-agent start<br/>--job-logs-otlp"] end AS -->|"BUILDKITE_JOB_LOGS_OTLP=true"| RUN subgraph bootstrap["Bootstrap process — single home for OTLP export"] RUN["Executor.Run<br/>JobLogsOTLP enabled?"] -->|"yes (any tracing backend)"| WIRE HC["hook / command<br/>stdout + stderr"] --> SH["shell OutputInterceptor<br/>(per hook/command, structured attrs)"] CTRL["bootstrap control output<br/>headers / prompts / comments / warnings"] --> SL["shell logger"] WIRE(("wire sinks")) WIRE --> SH WIRE --> SL SH --> TEE{{"tee raw output"}} TEE --> JR["job-log redactor<br/>replacer.Mux"] TEE --> OR["OTLP redactor<br/>replacer seeded with live needles"] JR --> JLOG["Buildkite job log stream"] OR --> EM["line emitter<br/>+ buildkite.* attributes"] SL --> LR["logger redactor"] LR --> LTEE{{"tee redacted control output"}} LTEE --> JLOG LTEE --> CEM["control line emitter<br/>+ base buildkite.* attributes"] EM --> EXP["OTLP log exporter<br/>(batch)"] CEM --> EXP end SPAN["active hook/command span<br/>only when OTel tracing enabled"] -. "native TraceId / SpanId" .-> EM EXP -->|"OTLP/gRPC or HTTP"| BE[("OTLP backend")] classDef redact fill:#fde2e2,stroke:#d33; class JR,OR,LR redact;Both sinks share the same redaction (
replacer, highlighted), so secrets are[REDACTED]in the OTLP records exactly as in the job log. Control output is teed after the logger redactor, so it is never re-redacted and never leaks pre-redaction bytes. Trace context is attached to child-process OTLP records only when OpenTelemetry tracing is enabled (dotted edge); otherwise records are emitted uncorrelated.Redaction
OTLP records are redacted with the same secret needles as the customer-facing job log. The child-process OTLP copy is routed through its own
replacer.Replacer, seeded from the job's live redactorMux, so secret values are replaced with[REDACTED]before they reach the OTLP backend (including secrets split across multiple writes). Control output is mirrored from the post-redaction side of the shell logger redactor, so it inherits the same redaction without a second pass.Relevant OpenTelemetry references:
Context
Slack context: https://buildkite-corp.slack.com/archives/C05R3MTRK38/p1780282420246339
This is a spike for moving high-rate job-log consumption toward agent-side OTLP log export, using the existing OpenTelemetry SDK plumbing in the agent.
Changes
--job-logs-otlpandBUILDKITE_JOB_LOGS_OTLPtobuildkite-agent start, propagated to the bootstrap subprocess.LogRecords with native timestamps and structured Buildkite hook/command attributes.LogRecordfields, not duplicated log attributes.--tracing-propagate-traceparentopt-in.CLI help excerpt:
Testing
go test ./...). Buildkite employees may check this if the pipeline has run automatically.go tool gofumpt -extra -w .)Additional verification:
go build ./...,golangci-lint run ./internal/job/go test -race ./internal/job/ ./internal/replacer/ ./internal/shell/(one pre-existing, unrelated git failure —TestVerifyCommit/fails_when_commit_is_not_on_branch— reproduces on a clean tree).TestOTLPJobLoggerRedactsSecrets,TestOTLPJobLoggerRedactsSecretsSplitAcrossWrites,TestOTLPJobLoggerControlWriter,TestOTLPJobLoggerControlWriterReused.Validated end-to-end with a real build on a local Buildkite (
buildkite.localhost) exporting to a local ClickStack (ClickHouse + OpenTelemetry collector). A locally-built agent ran a job with a secret env var, then the downloadable Buildkite log (via the v2 REST API) was compared againstdefault.otel_logs/default.otel_tracesfor the same job id:~~~ Preparing working directory,$ git clone …,# Creating …,~~~ Running commands) all appear verbatim — including ANSI colour codes — in the OTLP records. The only difference is the OTLP records use native timestamps instead of the\x1b_bk;t=…OSC markers in the raw Buildkite log body.leak=[REDACTED]in both the downloadable Buildkite log and the OTLP record bodies.checkoutanddefault command hookspans via native OTLP trace context; control-narration records were emitted with base attributes and no span context, as intended.Affiliation (optional, external contributors)
Buildkite.
Disclosures / Credits
Codex and Amp assisted with implementation, adversarial review, local verification, and drafting this PR description.