Skip to content

[PB-2160] Update OTel docs to include group, limit and priority - #3150

Open
reubsinit wants to merge 1 commit into
mainfrom
pb-2160-update-docs-on-otel-span-attrs
Open

[PB-2160] Update OTel docs to include group, limit and priority#3150
reubsinit wants to merge 1 commit into
mainfrom
pb-2160-update-docs-on-otel-span-attrs

Update otel docs to include group, limit and priority

6f16f27
Select commit
Loading
Failed to load commit list.
buildsworth-bk-app / Buildsworth review succeeded Aug 11, 2026 in 2m 13s

Review submitted — approved

Review summary

Change reviewed

PR #3150 updates the OpenTelemetry span-attribute reference in pages/pipelines/integrations/observability/opentelemetry.md. It documents the three job attributes requested by PB-2160:

  • buildkite.job.priority.number
  • buildkite.job.concurrency.group
  • buildkite.job.concurrency.limit

The change also documents the existing buildkite.job.concurrency_wait_time_ms attribute. The rest of the diff realigns the Markdown table to fit the longer keys and descriptions.

Verification performed

I read the full PR diff and the complete OpenTelemetry page, and checked the PB-2160 issue and PR description for the intended behavior. I also inspected the related implementation in buildkite/buildkite PR #32240 and its tests:

  • The priority key matches the implementation and is always emitted from job.priority.
  • The concurrency group and limit keys match the implementation and are emitted together when the job uses a concurrency group.
  • The documented group value is customer-facing: the implementation removes the internal custom/ prefix.
  • The concurrency wait-time key already exists on the product repository's main branch. Its description and conditional availability are consistent with the model and span tests.

The related product PR was approved and reported a clean merge state, but remained open when this review ran. The docs PR links that dependency, so publication of the new attributes still depends on coordinating with the product rollout.

Checks inspected or run:

  • Buildkite docs build #8809 passed.
  • npx markdownlint-cli2@0.3 pages/pipelines/integrations/observability/opentelemetry.md passed with no errors.
  • git diff --check origin/main...HEAD passed.
  • The changed file ends with a newline and contains no CRLF or consecutive blank-line issues.

I did not run the full RSpec suite or a local site render. Vale was not installed in the review environment, so I relied on the passing Buildkite lint jobs for the repository's complete prose checks.

Findings and verdict

I found no actionable correctness, documentation, or formatting issues. The documented keys and conditions match the corresponding implementation, and the repository CI passed. I submitted an APPROVE review with no inline comments.

Review: #3150 (review)

Trigger source: automatic.

View more details on buildsworth-bk-app