Skip to content

Remove stale copilot-otel.jsonl references from docs and specs - #53724

Merged
pelikhan merged 3 commits into
mainfrom
copilot/fix-docs-reference-copilot-otel
Aug 18, 2026
Merged

Remove stale copilot-otel.jsonl references from docs and specs#53724
pelikhan merged 3 commits into
mainfrom
copilot/fix-docs-reference-copilot-otel

Conversation

Copilot AI commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

The copilot-otel.jsonl file-export pipeline (Copilot CLI OTEL spans mirrored to a local file and forwarded to OTLP endpoints) was removed from the compiler and runtime in PR #32280, but the docs, spec, and skills content were never updated to match — leaving users to expect an artifact that no code produces.

Documentation

  • docs/src/content/docs/guides/open-telemetry.mdx: dropped copilot-otel.jsonl from the artifact list and the cat copilot-otel.jsonl | jq example; added an explanation that Copilot CLI inherits standard OTel env vars (OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS, OTEL_SERVICE_NAME, OTEL_RESOURCE_ATTRIBUTES) and exports spans directly to the configured OTLP backend, queryable by github.run_id (see ADR-34450)
  • docs/src/content/docs/reference/artifacts.md: removed the copilot-otel.jsonl bullet from the agent artifact contents
  • docs/src/content/docs/reference/open-telemetry.mdx: removed the corresponding line item

Spec

Skills and internal references

  • .github/skills/otel-queries/SKILL.md: removed the local mirror path from the telemetry-source priority list; Copilot CLI spans now point to the OTLP backend directly
  • scratchpad/layout.md: removed both filesystem-layout rows referencing the file
  • .github/workflows/smoke-otel-backends.md: removed the stale COPILOT_OTEL_FILE_EXPORTER_PATH env echo (no code sets this var anymore) and recompiled the paired .lock.yml

A patch changeset is included describing the documentation correction.

Copilot AI and others added 2 commits August 18, 2026 15:16
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix documentation referencing removed copilot-otel.jsonl artifact Remove stale copilot-otel.jsonl references from docs and specs Aug 18, 2026
Copilot AI requested a review from pelikhan August 18, 2026 15:17
@pelikhan
pelikhan marked this pull request as ready for review August 18, 2026 15:22
Copilot AI balanced review requested due to automatic review settings August 18, 2026 15:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Removes stale references to the retired Copilot CLI telemetry mirror and documents direct OTLP export behavior.

Changes:

  • Updates guides, references, specifications, and skills.
  • Removes the obsolete smoke-workflow environment check and recompiles its lock file.
  • Adds a patch changeset.
Show a summary per file
File Description
.changeset/patch-remove-copilot-otel-jsonl-docs.md Records the documentation correction.
.github/skills/otel-queries/SKILL.md Directs Copilot span queries to OTLP backends.
.github/workflows/smoke-otel-backends.md Removes the obsolete environment-variable check.
.github/workflows/smoke-otel-backends.lock.yml Updates generated workflow metadata.
docs/src/content/docs/guides/open-telemetry.mdx Documents direct Copilot OTLP export.
docs/src/content/docs/reference/artifacts.md Removes the retired artifact entry.
docs/src/content/docs/reference/open-telemetry.mdx Removes the retired mirror reference.
scratchpad/layout.md Removes obsolete filesystem entries.
specs/otel-observability-spec.md Updates artifact requirements and changelog.

Review details

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

  • Files reviewed: 9/9 changed files
  • Comments generated: 0
  • Review effort level: Balanced

@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Design Decision Gate 🏗️ completed the design decision gate check.

No ADR enforcement needed: PR #53724 does not have the 'implementation' label and has 0 new lines of code in business logic directories (threshold: 100).

🏗️ ADR gate enforced by Design Decision Gate 🏗️

@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅

🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer

@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

PR Code Quality Reviewer completed the code quality review.

🔎 Code quality review by PR Code Quality Reviewer

@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Ponytail Reviewer completed successfully!

Lean already. Ship.

Generated by Ponytail Reviewer for #53724

@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Test Quality Sentinel completed test quality analysis.

No test files were added or modified in this PR. Test Quality Sentinel skipped.

🧪 Test quality analysis by Test Quality Sentinel

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean, consistent documentation and spec cleanup. All references to the stale copilot-otel.jsonl artifact have been removed across docs, specs, skills, and the scratchpad layout — replaced with accurate guidance directing users to query Copilot CLI spans from the configured OTLP backend. The changeset entry and spec changelog accurately attribute the removal to PR #32280. No issues found.

🧵 Reviewed using Impeccable skills by Impeccable Skills Reviewer · sonnet46 · 15.6 AIC · ⌖ 8.77 AIC · ⊞ 5.7K

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skills-Based Review 🧠

Applied /grill-with-docs — this is a documentation correction removing stale copilot-otel.jsonl references. The changes are accurate, internally consistent, and well-described in the PR body.

📋 Summary

Positive Highlights

  • ✅ All references removed consistently across docs, specs, skills, workflow, and scratchpad
  • ✅ Spec changelog entry documents the removal with context and PR reference — good practice
  • ✅ Replacement text correctly directs users to the OTLP backend with the github.run_id filter hint and ADR-34450 link
  • ✅ Lock file correctly recompiled after workflow change
  • ✅ Changeset included

Minor Observation

In docs/src/content/docs/reference/open-telemetry.mdx, after removing the copilot-otel.jsonl list item, the bullet list now contains only one item (otel.jsonl). This is fine but could optionally be converted to prose for readability. Not a blocker.

🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · sonnet46 · 19 AIC · ⌖ 9.82 AIC · ⊞ 7.8K
Comment /matt to run again

@github-actions github-actions Bot mentioned this pull request Aug 18, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Comment Memory

reviewed_at: 2026-08-18T16:38:26Z
review_event: COMMENT
top_themes:
  - docs/spec cleanup only
  - no changed-line correctness regressions found
files_reviewed:
  - .changeset/patch-remove-copilot-otel-jsonl-docs.md
  - .github/skills/otel-queries/SKILL.md
  - .github/workflows/smoke-otel-backends.lock.yml
  - .github/workflows/smoke-otel-backends.md
  - docs/src/content/docs/guides/open-telemetry.mdx
  - docs/src/content/docs/reference/artifacts.md
  - docs/src/content/docs/reference/open-telemetry.mdx
  - scratchpad/layout.md
  - specs/otel-observability-spec.md
comment_count: 0

Note

This comment is managed by comment memory.

It stores persistent context for this thread in the code block at the top of this comment.
Edit only the text inside the backtick fences; workflow metadata and the footer are regenerated automatically.

Learn more about comment memory

🔎 Code quality review by PR Code Quality Reviewer · gpt54 · 4.04 AIC · ⌖ 7.91 AIC · ⊞ 4.5K ·
Comment /review to run again

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verdict

COMMENT — this is a documentation/spec cleanup and I did not find any changed-line correctness, security, or maintainability issue that blocks merge.

Themes checked
  • Verified the docs/specs consistently stop promising a copilot-otel.jsonl artifact.
  • Checked that the workflow change only removes a stale debug echo for an env var that no longer exists.
  • Looked for mismatches between the guide, artifact reference, skill guidance, and spec wording; nothing in the diff introduces a contradictory runtime claim.
  • grumpy-coder did not return usable output, so this verdict is based on the direct review only.

🔎 Code quality review by PR Code Quality Reviewer · gpt54 · 4.04 AIC · ⌖ 7.91 AIC · ⊞ 4.5K
Comment /review to run again

@pelikhan
pelikhan merged commit b65b0cb into main Aug 18, 2026
49 of 51 checks passed
@pelikhan
pelikhan deleted the copilot/fix-docs-reference-copilot-otel branch August 18, 2026 16:47
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.87.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs still reference copilot-otel.jsonl artifact removed in #32280

3 participants