From 6f16f277e0dca6860b54f3324521fc222117c804 Mon Sep 17 00:00:00 2001 From: reubsinit Date: Tue, 11 Aug 2026 10:16:40 +1000 Subject: [PATCH] Update otel docs to include group, limit and priority --- .../observability/opentelemetry.md | 102 +++++++++--------- 1 file changed, 53 insertions(+), 49 deletions(-) diff --git a/pages/pipelines/integrations/observability/opentelemetry.md b/pages/pipelines/integrations/observability/opentelemetry.md index 4a4b5a4763d..71f7455c1cf 100644 --- a/pages/pipelines/integrations/observability/opentelemetry.md +++ b/pages/pipelines/integrations/observability/opentelemetry.md @@ -74,55 +74,59 @@ The following attributes are included in OpenTelemetry traces from the Buildkite [Span attributes](https://opentelemetry.io/docs/concepts/signals/traces/#attributes) are specific to certain span types: -| Key | Spans | Description | -| ------------------------------------ | ---------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| `buildkite.build.number` | All | Build number | -| `buildkite.build.commit` | All | Build commit SHA | -| `buildkite.build.message` | All | Build commit message | -| `buildkite.build.branch` | All | Build branch | -| `buildkite.build.source` | All | Build source (`ui`, `api`, `webhook`, etc.) | -| `buildkite.build.graphql_id` | All | Build GraphQL ID | -| `buildkite.build.web_url` | All | Build web URL | -| `buildkite.build.creator.id` | All (when build creator exists) | Build creator ID | -| `buildkite.build.creator.email` | All (when build creator exists) | Build creator email | -| `buildkite.build.creator.name` | All (when build creator exists) | Build creator name | -| `buildkite.build.creator.graphql_id` | All (when build creator exists) | Build creator GraphQL ID | -| `buildkite.build.state` | `buildkite.build`, `buildkite.build.stage` | Build state (running, passed, failed, etc.) | -| `buildkite.build.blocked_state` | `buildkite.build`, `buildkite.build.stage` (when blocked) | Build blocked state (if blocked) | -| `buildkite.build.stage` | `buildkite.build.stage`, `buildkite.job`, `buildkite.step.group`, `buildkite.step` | Build stage/phase number | -| `buildkite.step.id` | `buildkite.job`, `buildkite.step`, `buildkite.step.group` | Step ID | -| `buildkite.step.key` | `buildkite.job`, `buildkite.step`, `buildkite.step.group` | Step key | -| `buildkite.step.command` | `buildkite.job`, `buildkite.step` (command steps only) | Step command script | -| `buildkite.step.label` | `buildkite.job`, `buildkite.step`, `buildkite.step.group` | Step label | -| `buildkite.step.type` | `buildkite.step`, `buildkite.step.group` | Step type | -| `buildkite.step.matrix` | `buildkite.step`, `buildkite.step.group` (matrix steps) | Whether step uses matrix (true) | -| `buildkite.step.group.label` | `buildkite.step`, `buildkite.step.group` (group steps) | Group step label | -| `buildkite.step.group.key` | `buildkite.step`, `buildkite.step.group` (group steps) | Group step key | -| `buildkite.step.web_url` | `buildkite.step`, `buildkite.step.group` | Step web URL | -| `buildkite.job.id` | `buildkite.job` | Job ID | -| `buildkite.job.graphql_id` | `buildkite.job` | Job GraphQL ID | -| `buildkite.job.web_url` | `buildkite.job` | Job web URL | -| `buildkite.job.type` | `buildkite.job` | Job type (script, manual, waiter, etc.) | -| `buildkite.job.label` | `buildkite.job` | Job label/name | -| `buildkite.job.command` | `buildkite.job` | Job command | -| `buildkite.job.agent_query_rules` | `buildkite.job` | Job agent query rules | -| `buildkite.job.exit_status` | `buildkite.job` | Job exit status | -| `buildkite.job.passed` | `buildkite.job` | Whether job passed | -| `buildkite.job.soft_failed` | `buildkite.job` | Whether job soft failed | -| `buildkite.job.state` | `buildkite.job` | Job state | -| `buildkite.job.runnable_at` | `buildkite.job` | When job became runnable | -| `buildkite.job.started_at` | `buildkite.job` | When job started | -| `buildkite.job.finished_at` | `buildkite.job` | When job finished | -| `buildkite.job.wait_time_ms` | `buildkite.job` | Job wait time in milliseconds | -| `buildkite.job.unblocked_by` | `buildkite.job` (when unblocked) | User who unblocked job (object with uuid, graphql_id, name) | -| `buildkite.job.retried_in_job_id` | `buildkite.job` (when retried) | ID of retry job (if retried) | -| `buildkite.job.signal_reason` | `buildkite.job` (when terminated by signal) | Signal reason (if terminated by signal) | -| `buildkite.job.matrix` | `buildkite.job` (matrix jobs only) | Job matrix configuration (JSON) | -| `buildkite.agent.name` | `buildkite.job` (when agent assigned) | Agent name | -| `buildkite.agent.id` | `buildkite.job` (when agent assigned) | Agent ID | -| `buildkite.agent.queue` | `buildkite.job` (when agent assigned) | Agent queue | -| `buildkite.agent.meta_data` | `buildkite.job` (when agent assigned) | Agent metadata | -| `error.type` | All (when error status) | Error type description | +| Key | Spans | Description | +| ---------------------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------- | +| `buildkite.build.number` | All | Build number | +| `buildkite.build.commit` | All | Build commit SHA | +| `buildkite.build.message` | All | Build commit message | +| `buildkite.build.branch` | All | Build branch | +| `buildkite.build.source` | All | Build source (`ui`, `api`, `webhook`, etc.) | +| `buildkite.build.graphql_id` | All | Build GraphQL ID | +| `buildkite.build.web_url` | All | Build web URL | +| `buildkite.build.creator.id` | All (when build creator exists) | Build creator ID | +| `buildkite.build.creator.email` | All (when build creator exists) | Build creator email | +| `buildkite.build.creator.name` | All (when build creator exists) | Build creator name | +| `buildkite.build.creator.graphql_id` | All (when build creator exists) | Build creator GraphQL ID | +| `buildkite.build.state` | `buildkite.build`, `buildkite.build.stage` | Build state (running, passed, failed, etc.) | +| `buildkite.build.blocked_state` | `buildkite.build`, `buildkite.build.stage` (when blocked) | Build blocked state (if blocked) | +| `buildkite.build.stage` | `buildkite.build.stage`, `buildkite.job`, `buildkite.step.group`, `buildkite.step` | Build stage/phase number | +| `buildkite.step.id` | `buildkite.job`, `buildkite.step`, `buildkite.step.group` | Step ID | +| `buildkite.step.key` | `buildkite.job`, `buildkite.step`, `buildkite.step.group` | Step key | +| `buildkite.step.command` | `buildkite.job`, `buildkite.step` (command steps only) | Step command script | +| `buildkite.step.label` | `buildkite.job`, `buildkite.step`, `buildkite.step.group` | Step label | +| `buildkite.step.type` | `buildkite.step`, `buildkite.step.group` | Step type | +| `buildkite.step.matrix` | `buildkite.step`, `buildkite.step.group` (matrix steps) | Whether step uses matrix (true) | +| `buildkite.step.group.label` | `buildkite.step`, `buildkite.step.group` (group steps) | Group step label | +| `buildkite.step.group.key` | `buildkite.step`, `buildkite.step.group` (group steps) | Group step key | +| `buildkite.step.web_url` | `buildkite.step`, `buildkite.step.group` | Step web URL | +| `buildkite.job.id` | `buildkite.job` | Job ID | +| `buildkite.job.graphql_id` | `buildkite.job` | Job GraphQL ID | +| `buildkite.job.web_url` | `buildkite.job` | Job web URL | +| `buildkite.job.type` | `buildkite.job` | Job type (script, manual, waiter, etc.) | +| `buildkite.job.label` | `buildkite.job` | Job label/name | +| `buildkite.job.command` | `buildkite.job` | Job command | +| `buildkite.job.agent_query_rules` | `buildkite.job` | Job agent query rules | +| `buildkite.job.exit_status` | `buildkite.job` | Job exit status | +| `buildkite.job.passed` | `buildkite.job` | Whether job passed | +| `buildkite.job.soft_failed` | `buildkite.job` | Whether job soft failed | +| `buildkite.job.state` | `buildkite.job` | Job state | +| `buildkite.job.runnable_at` | `buildkite.job` | When job became runnable | +| `buildkite.job.started_at` | `buildkite.job` | When job started | +| `buildkite.job.finished_at` | `buildkite.job` | When job finished | +| `buildkite.job.wait_time_ms` | `buildkite.job` | Job wait time in milliseconds | +| `buildkite.job.priority.number` | `buildkite.job` | Job priority | +| `buildkite.job.concurrency_wait_time_ms` | `buildkite.job` (when concurrency-limited) | Time job spent waiting on a concurrency group, in milliseconds | +| `buildkite.job.unblocked_by` | `buildkite.job` (when unblocked) | User who unblocked job (object with uuid, graphql_id, name) | +| `buildkite.job.retried_in_job_id` | `buildkite.job` (when retried) | ID of retry job (if retried) | +| `buildkite.job.signal_reason` | `buildkite.job` (when terminated by signal) | Signal reason (if terminated by signal) | +| `buildkite.job.concurrency.group` | `buildkite.job` (when in a concurrency group) | Concurrency group key | +| `buildkite.job.concurrency.limit` | `buildkite.job` (when in a concurrency group) | Concurrency group limit | +| `buildkite.job.matrix` | `buildkite.job` (matrix jobs only) | Job matrix configuration (JSON) | +| `buildkite.agent.name` | `buildkite.job` (when agent assigned) | Agent name | +| `buildkite.agent.id` | `buildkite.job` (when agent assigned) | Agent ID | +| `buildkite.agent.queue` | `buildkite.job` (when agent assigned) | Agent queue | +| `buildkite.agent.meta_data` | `buildkite.job` (when agent assigned) | Agent metadata | +| `error.type` | All (when error status) | Error type description | ### Headers