Skip to content

Commit b65b0cb

Browse files
authored
Remove stale copilot-otel.jsonl references from docs and specs (#53724)
1 parent 8ae9c54 commit b65b0cb

9 files changed

Lines changed: 14 additions & 15 deletions

File tree

.changeset/patch-remove-copilot-otel-jsonl-docs.md

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/skills/otel-queries/SKILL.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@ Prefer sources in this order unless the user says otherwise:
3636

3737
1. Local artifacts or mirrors already in the workspace.
3838
2. `/tmp/gh-aw/otel.jsonl` for gh-aw spans.
39-
3. `/tmp/gh-aw/copilot-otel.jsonl` for Copilot CLI spans.
40-
4. Live OTLP backend data through an MCP server or supported tool.
41-
5. Static code inspection only, when no telemetry is available.
39+
3. Live OTLP backend data through an MCP server or supported tool — Copilot CLI spans are exported directly to the configured OTLP backend (no local file mirror) and must be queried there, filtered by the `github.run_id` resource attribute.
40+
4. Static code inspection only, when no telemetry is available.
4241

4342
Use the cheapest source that can disconfirm the current hypothesis.
4443

.github/workflows/smoke-otel-backends.lock.yml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/smoke-otel-backends.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,6 @@ echo "OTEL_EXPORTER_OTLP_ENDPOINT=${OTEL_EXPORTER_OTLP_ENDPOINT:+set}"
114114
echo "OTEL_EXPORTER_OTLP_HEADERS=${OTEL_EXPORTER_OTLP_HEADERS:+set}"
115115
echo "GH_AW_OTLP_ENDPOINTS=${GH_AW_OTLP_ENDPOINTS:+set}"
116116
echo "OTEL_SERVICE_NAME=${OTEL_SERVICE_NAME:-}"
117-
echo "COPILOT_OTEL_FILE_EXPORTER_PATH=${COPILOT_OTEL_FILE_EXPORTER_PATH:-}"
118117

119118
echo "=== OTEL configured backend hosts ==="
120119
if [ -n "${GH_AW_OTLP_ENDPOINTS:-}" ]; then

docs/src/content/docs/guides/open-telemetry.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,8 @@ You usually do not need to configure or memorize these built-in attributes. They
124124
When observability is enabled, trace data is also mirrored to local JSONL files and uploaded in the `agent` artifact:
125125

126126
- `otel.jsonl` for spans emitted by gh-aw JavaScript helpers
127-
- `copilot-otel.jsonl` for spans emitted by Copilot CLI
127+
128+
Copilot CLI inherits the standard OpenTelemetry environment variables (`OTEL_EXPORTER_OTLP_ENDPOINT`, `OTEL_EXPORTER_OTLP_HEADERS`, `OTEL_SERVICE_NAME`, `OTEL_RESOURCE_ATTRIBUTES`) and exports its own spans directly to the configured OTLP backend. Query them there, filtered by the `github.run_id` resource attribute (see [ADR-34450](https://github.com/github/gh-aw/blob/main/docs/adr/34450-inject-otel-resource-attributes-for-child-otel-sdk-correlation.md)).
128129

129130
See [Artifacts](/gh-aw/reference/artifacts/) for artifact download details.
130131

@@ -228,17 +229,14 @@ await otlp.logSpan('my-scanner', {
228229

229230
Attribute values are sanitized automatically before the payload is exported or mirrored. Matching secret-like keys are redacted, and very long string values are truncated. The same sanitization is applied to both OTLP export and the local JSONL mirror.
230231

231-
For debugging, every span emitted by `logSpan` is appended as a sanitized JSON line to `/tmp/gh-aw/otel.jsonl`, even when `OTEL_EXPORTER_OTLP_ENDPOINT` is not set. When OTLP is configured, Copilot CLI spans are written to `/tmp/gh-aw/copilot-otel.jsonl` and forwarded to configured endpoints at the end of the run. Both files are included in the `agent` artifact when OTLP is enabled.
232+
For debugging, every span emitted by `logSpan` is appended as a sanitized JSON line to `/tmp/gh-aw/otel.jsonl`, even when `OTEL_EXPORTER_OTLP_ENDPOINT` is not set. This file is included in the `agent` artifact when OTLP is enabled. Copilot CLI spans are not mirrored to a local file; they are exported directly to the configured OTLP backend and should be queried there.
232233

233234
```bash
234235
# Download agent artifacts for a run
235236
gh aw logs <run-id> --artifacts agent
236237
237238
# Inspect spans emitted by your tool
238239
cat otel.jsonl | jq 'select(.resourceSpans[].scopeSpans[].spans[].name | startswith("my-tool"))'
239-
240-
# Inspect Copilot CLI spans
241-
cat copilot-otel.jsonl | jq '.resourceSpans'
242240
```
243241

244242
<details>

docs/src/content/docs/reference/artifacts.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,6 @@ The unified `agent` artifact contains agent job outputs:
148148
- GitHub API rate limit logs (`github_rate_limits.jsonl`)
149149
- Token usage summary (`agent_usage.json`) — aggregated totals only; per-request data is in `firewall-audit-logs`
150150
- `otel.jsonl` — OTLP span mirror written by gh-aw's JavaScript span exporters when `observability.otlp` is configured
151-
- `copilot-otel.jsonl` — OTLP spans emitted by Copilot CLI when `observability.otlp` is configured
152151

153152
For OTLP configuration, runtime environment variables, and span semantics, see the [OpenTelemetry guide](/gh-aw/guides/open-telemetry/).
154153

docs/src/content/docs/reference/open-telemetry.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,6 @@ These attributes are emitted when experiments are active for a run.
259259
When observability is enabled, trace data is also mirrored to local JSONL files and uploaded in the <code>agent</code> artifact:
260260

261261
- <code>otel.jsonl</code> for spans emitted by gh-aw JavaScript helpers
262-
- <code>copilot-otel.jsonl</code> for spans emitted by Copilot CLI
263262

264263
See the [OpenTelemetry guide](/gh-aw/guides/open-telemetry/) for setup and [Artifacts](/gh-aw/reference/artifacts/) for artifact download details.
265264

scratchpad/layout.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,6 @@ Common file paths referenced in workflow files:
194194
| `/tmp/gh-aw/aw_info.json` | File | Workflow info JSON | Workflow metadata and configuration |
195195
| `/tmp/gh-aw/awf-config.json` | File | AWF config JSON | Agentic Workflow Firewall (AWF) configuration file |
196196
| `/tmp/gh-aw/base` | Directory | Base checkout | Base repository checkout for git diff operations |
197-
| `/tmp/gh-aw/copilot-otel.jsonl` | File | Copilot OTEL log | OpenTelemetry spans from Copilot engine requests |
198197
| `/tmp/gh-aw/cache-memory` | Directory | Cache memory storage | Persistent cache data across runs |
199198
| `/tmp/gh-aw/cache-memory-chroma` | Directory | Chroma cache storage | Chroma vector database cache |
200199
| `/tmp/gh-aw/cache-memory-focus-areas` | Directory | Focus areas cache | Cached focus area data |
@@ -649,7 +648,6 @@ GitHub Actions runner images used across compiled workflows:
649648
├── cache-memory-repo-audits/ # Audit cache
650649
├── comment-memory/ # Comment memory
651650
│ └── default.md
652-
├── copilot-otel.jsonl # Copilot OpenTelemetry spans
653651
├── experiments/ # A/B experiments
654652
│ ├── assignments.json
655653
│ └── state.json

specs/otel-observability-spec.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@ Mirror-write failure MUST produce a structured diagnostic but SHOULD NOT fail th
753753

754754
The mirror writer MUST create parent directories with restrictive permissions, MUST use append-safe writes, SHOULD tolerate concurrent writers, MUST NOT write exporter credentials, MUST apply the same content-capture and redaction policy as remote export, and SHOULD rotate or bound file size.
755755

756-
When telemetry artifacts are uploaded, the artifact SHOULD contain `otel.jsonl`, runtime-specific companion files such as `copilot-otel.jsonl` when present, and no secret headers or credentials. A manifest containing schema version, signal counts, byte sizes, and redaction mode MAY be added as an optional companion file.
756+
When telemetry artifacts are uploaded, the artifact SHOULD contain `otel.jsonl` and no secret headers or credentials. As of the removal in PR #32280, gh-aw does not produce a runtime-specific companion mirror file for Copilot CLI spans; Copilot CLI is expected to export its spans directly to the configured OTLP backend using the injected `OTEL_EXPORTER_OTLP_ENDPOINT`/`OTEL_EXPORTER_OTLP_HEADERS`/`OTEL_RESOURCE_ATTRIBUTES` environment variables (see ADR-34450). A manifest containing schema version, signal counts, byte sizes, and redaction mode MAY be added as an optional companion file.
757757

758758
---
759759

@@ -953,6 +953,8 @@ context is added to outcome spans or links.
953953

954954
### Version 0.4.0 (Working Draft, June 18, 2026)
955955

956+
- **Removed** (documentation correction, August 2026): References to a `copilot-otel.jsonl` local mirror/companion artifact. PR #32280 removed the file-export pipeline that produced it (`COPILOT_OTEL_FILE_EXPORTER_PATH` injection, artifact inclusion, and forwarding script); Copilot CLI spans are now expected to be exported directly to the configured OTLP backend and queried there.
957+
956958
- **Changed**: Reframed 0.4.0 as a non-breaking compatibility revision rather than a replacement telemetry standard.
957959
- **Preserved**: `observability.otlp`, direct OTLP export, `OTEL_EXPORTER_OTLP_ENDPOINT`, `OTEL_EXPORTER_OTLP_HEADERS`, `GITHUB_AW_OTEL_TRACE_ID`, `GITHUB_AW_OTEL_PARENT_SPAN_ID`, `TRACEPARENT` compatibility, built-in setup/conclusion spans, `gen_ai.system`, `gen_ai.usage.total_tokens`, and raw OTLP JSONL mirror behavior.
958960
- **Clarified**: Standard OpenTelemetry attributes such as `gen_ai.provider.name` and CI/CD attributes may be emitted as additive aliases, not replacements for existing fields.

0 commit comments

Comments
 (0)