Skip to content

Add OpenTelemetry reference page and centralize observability docs#32233

Merged
pelikhan merged 2 commits into
mainfrom
copilot/add-open-telemetry-reference-page
May 15, 2026
Merged

Add OpenTelemetry reference page and centralize observability docs#32233
pelikhan merged 2 commits into
mainfrom
copilot/add-open-telemetry-reference-page

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 15, 2026

New Feature

This PR adds a dedicated OpenTelemetry reference page and consolidates observability guidance into that single source of truth. Existing docs now link to the new page instead of duplicating OTLP configuration details.

What does this feature do?

  • Canonical OpenTelemetry reference
    • Added docs/src/content/docs/reference/open-telemetry.md covering:
      • observability.otlp schema and endpoint/header forms
      • injected runtime env vars
      • agent span attributes and semantic convention notes
      • OTEL trace artifact files and related links

Why is this feature needed?

  • Centralized observability documentation
    • Removes fragmented OTLP/observability details spread across multiple pages.
    • Makes updates to telemetry behavior easier and less error-prone by maintaining one authoritative reference.

Implementation details

  • Frontmatter reference slimmed down
    • Replaced the long Observability section in reference/frontmatter.md with a concise summary and link to the new OpenTelemetry page.
  • Cross-doc link updates
    • Updated references in:
      • guides/custom-otlp-attributes.md
      • reference/artifacts.md
      • reference/glossary.md
    • Added OpenTelemetry to related links in reference/frontmatter.md.
observability:
  otlp:
    endpoint: ${{ secrets.OTLP_ENDPOINT }}
    headers:
      Authorization: ${{ secrets.OTLP_TOKEN }}

Copilot AI and others added 2 commits May 15, 2026 00:14
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan pelikhan marked this pull request as ready for review May 15, 2026 00:22
Copilot AI review requested due to automatic review settings May 15, 2026 00:22
@pelikhan pelikhan merged commit d141015 into main May 15, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/add-open-telemetry-reference-page branch May 15, 2026 00:22
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a dedicated OpenTelemetry reference page and updates existing documentation to link to it instead of duplicating OTLP/observability configuration details.

Changes:

  • Added a new canonical OpenTelemetry reference page covering observability.otlp, runtime env vars, span attributes, and trace artifacts.
  • Slimmed the Observability section in the Frontmatter reference and updated cross-links in related docs to point to the new page.
  • Updated the Agent Factory status table (but several command/engine entries are now inconsistent with the actual workflow triggers/engines).
Show a summary per file
File Description
docs/src/content/docs/reference/open-telemetry.md New canonical OpenTelemetry/OTLP reference page.
docs/src/content/docs/reference/frontmatter.md Replaced detailed OTLP section with a short summary + link to OpenTelemetry reference.
docs/src/content/docs/reference/glossary.md Simplified observability glossary entry to point to the OpenTelemetry reference.
docs/src/content/docs/reference/artifacts.md Added link to OpenTelemetry reference from artifact trace file docs.
docs/src/content/docs/guides/custom-otlp-attributes.md Updated related-doc link to point to the new OpenTelemetry reference.
docs/src/content/docs/agent-factory-status.mdx Agent list table updated, but multiple command/agent values are now incorrect vs workflow frontmatter.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (12)

docs/src/content/docs/agent-factory-status.mdx:21

  • Approach Validator supports a centralized slash command (on.slash_command.name: approach-validator in .github/workflows/approach-validator.md), but this row shows - in the Command column. Update the Command column to /approach-validator (or whatever alias is intended) so the table matches the actual trigger.
| [Approach Validator](https://github.com/github/gh-aw/blob/main/.github/workflows/approach-validator.md) | claude | [![Approach Validator](https://github.com/github/gh-aw/actions/workflows/approach-validator.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/approach-validator.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:31

  • Brave Web Search Agent is invoked via the /brave slash command (on.slash_command.name: brave in .github/workflows/brave.md), but the Command column here is -. Update the row to list /brave.
| [Brave Web Search Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/brave.md) | copilot | [![Brave Web Search Agent](https://github.com/github/gh-aw/actions/workflows/brave.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/brave.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:123

  • Documentation Unbloat is triggered via the /unbloat slash command (on.slash_command.name: unbloat in .github/workflows/unbloat-docs.md), but the Command column here is -. Update this row to show /unbloat.
| [Documentation Unbloat](https://github.com/github/gh-aw/blob/main/.github/workflows/unbloat-docs.md) | claude | [![Documentation Unbloat](https://github.com/github/gh-aw/actions/workflows/unbloat-docs.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/unbloat-docs.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:139

  • Grumpy Code Reviewer is invoked via the /grumpy slash command (on.slash_command.name: grumpy in .github/workflows/grumpy-reviewer.md), but the Command column here is -. Update the row to list /grumpy so the table reflects the actual trigger.
| [Grumpy Code Reviewer 🔥](https://github.com/github/gh-aw/blob/main/.github/workflows/grumpy-reviewer.md) | codex | [![Grumpy Code Reviewer 🔥](https://github.com/github/gh-aw/actions/workflows/grumpy-reviewer.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/grumpy-reviewer.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:151

  • Mergefest is invoked via the /mergefest slash command (on.slash_command.name: mergefest in .github/workflows/mergefest.md), but the Command column here is -. Update this row to show /mergefest.
| [Mergefest](https://github.com/github/gh-aw/blob/main/.github/workflows/mergefest.md) | copilot | [![Mergefest](https://github.com/github/gh-aw/actions/workflows/mergefest.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/mergefest.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:160

  • Plan Command is invoked via the /plan slash command (on.slash_command.name: plan in .github/workflows/plan.md), but the Command column here is -. Update the row to list /plan.
| [Plan Command](https://github.com/github/gh-aw/blob/main/.github/workflows/plan.md) | copilot | [![Plan Command](https://github.com/github/gh-aw/actions/workflows/plan.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/plan.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:161

  • Poem Bot is invoked via the /poem-bot slash command (on.slash_command.name: poem-bot in .github/workflows/poem-bot.md), but the Command column here is -. Update the row to list /poem-bot.
| [Poem Bot - A Creative Agentic Workflow](https://github.com/github/gh-aw/blob/main/.github/workflows/poem-bot.md) | copilot | [![Poem Bot - A Creative Agentic Workflow](https://github.com/github/gh-aw/actions/workflows/poem-bot.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/poem-bot.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:162

  • PR Code Quality Reviewer supports the /review slash command (on.slash_command.name: review in .github/workflows/pr-code-quality-reviewer.md), but the Command column here is -. Update the row to list /review.
| [PR Code Quality Reviewer](https://github.com/github/gh-aw/blob/main/.github/workflows/pr-code-quality-reviewer.md) | copilot | [![PR Code Quality Reviewer](https://github.com/github/gh-aw/actions/workflows/pr-code-quality-reviewer.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/pr-code-quality-reviewer.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:163

  • PR Nitpick Reviewer supports the /nit slash command (on.slash_command.name: nit in .github/workflows/pr-nitpick-reviewer.md), but the Command column here is -. Update the row to list /nit.
| [PR Nitpick Reviewer 🔍](https://github.com/github/gh-aw/blob/main/.github/workflows/pr-nitpick-reviewer.md) | copilot | [![PR Nitpick Reviewer 🔍](https://github.com/github/gh-aw/actions/workflows/pr-nitpick-reviewer.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/pr-nitpick-reviewer.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:174

  • Resource Summarizer Agent is invoked via the /summarize slash command (on.slash_command.name: summarize in .github/workflows/pdf-summary.md), but the Command column here is -. Update this row to show /summarize.
| [Resource Summarizer Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/pdf-summary.md) | copilot | [![Resource Summarizer Agent](https://github.com/github/gh-aw/actions/workflows/pdf-summary.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/pdf-summary.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:180

  • Security Review Agent is invoked via the /security-review slash command (on.slash_command.name: security-review in .github/workflows/security-review.md), but the Command column here is -. Update the row to list /security-review.
| [Security Review Agent 🔒](https://github.com/github/gh-aw/blob/main/.github/workflows/security-review.md) | copilot | [![Security Review Agent 🔒](https://github.com/github/gh-aw/actions/workflows/security-review.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/security-review.lock.yml) | - | - |

docs/src/content/docs/agent-factory-status.mdx:234

  • Workflow Craft Agent is documented with the command /my, but the workflow is triggered via the /craft slash command (on.slash_command.name: craft in .github/workflows/craft.md). Update the Command column to /craft to avoid sending readers to a non-existent command.
| [Workflow Craft Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/craft.md) | copilot | [![Workflow Craft Agent](https://github.com/github/gh-aw/actions/workflows/craft.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/craft.lock.yml) | - | `/my` |
  • Files reviewed: 6/6 changed files
  • Comments generated: 2

| [[aw] Failure Investigator (6h)](https://github.com/github/gh-aw/blob/main/.github/workflows/aw-failure-investigator.md) | claude | [![[aw] Failure Investigator (6h)](https://github.com/github/gh-aw/actions/workflows/aw-failure-investigator.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/aw-failure-investigator.lock.yml) | `every 6h` | - |
| [/cloclo](https://github.com/github/gh-aw/blob/main/.github/workflows/cloclo.md) | claude | [![/cloclo](https://github.com/github/gh-aw/actions/workflows/cloclo.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/cloclo.lock.yml) | - | `/cloclo` |
| [ACE Editor Session](https://github.com/github/gh-aw/blob/main/.github/workflows/ace-editor.md) | copilot | [![ACE Editor Session](https://github.com/github/gh-aw/actions/workflows/ace-editor.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/ace-editor.lock.yml) | - | `/ace` |
| [ACE Editor Session](https://github.com/github/gh-aw/blob/main/.github/workflows/ace-editor.md) | copilot | [![ACE Editor Session](https://github.com/github/gh-aw/actions/workflows/ace-editor.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/ace-editor.lock.yml) | - | - |
| [Deployment Incident Monitor](https://github.com/github/gh-aw/blob/main/.github/workflows/deployment-incident-monitor.md) | copilot | [![Deployment Incident Monitor](https://github.com/github/gh-aw/actions/workflows/deployment-incident-monitor.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/deployment-incident-monitor.lock.yml) | - | - |
| [Design Decision Gate 🏗️](https://github.com/github/gh-aw/blob/main/.github/workflows/design-decision-gate.md) | claude | [![Design Decision Gate 🏗️](https://github.com/github/gh-aw/actions/workflows/design-decision-gate.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/design-decision-gate.lock.yml) | - | - |
| [Dev](https://github.com/github/gh-aw/blob/main/.github/workflows/dev.md) | pi | [![Dev](https://github.com/github/gh-aw/actions/workflows/dev.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/dev.lock.yml) | `daily around 9:00` | - |
| [Dev](https://github.com/github/gh-aw/blob/main/.github/workflows/dev.md) | copilot | [![Dev](https://github.com/github/gh-aw/actions/workflows/dev.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/dev.lock.yml) | `daily around 9:00` | - |
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.

3 participants