Skip to content

review: document the Sentry OTLP secrets as a hard install prerequisite #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwbron merged 2 commits into from
Jul 13, 2026
Merged

review: document the Sentry OTLP secrets as a hard install prerequisite #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
462e7ca
review: document the Sentry OTLP secrets as a hard install prerequisite
jwbron Jul 10, 2026
68a9fc3
Merge branch 'main' into review-otlp-secrets-docs
jwbron Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/review-otlp-secrets-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"review": patch
---

Document the `GH_AW_OTEL_SENTRY_ENDPOINT` / `GH_AW_OTEL_SENTRY_AUTHORIZATION` secrets as a hard install prerequisite (README required-secrets section plus the comment on the `observability:` block). A consuming repo without them does not degrade gracefully: the compiled lock feeds the empty endpoint into the MCP gateway's OTLP config, whose schema rejects it, and the agent job dies at startup (observed on Khan/actions#241). Repos without Sentry must comment out the `observability:` block in their installed review.md and recompile.
9 changes: 9 additions & 0 deletions workflows/review/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,15 @@ measurements to run after the suite exists.
- `ANTHROPIC_API_KEY` — used by the `claude` engine.
- `KHAN_ACTIONS_BOT_TOKEN` — referenced by `config.md`'s `add-reviewer` (the default
`GITHUB_TOKEN` cannot request organization teams as reviewers).
- `GH_AW_OTEL_SENTRY_ENDPOINT` and `GH_AW_OTEL_SENTRY_AUTHORIZATION` — the Sentry
OTLP traces endpoint and `x-sentry-auth` header value read by the
`observability:` block (value formats are documented at the block in
`review.md`). Hard-required while that block is present: a missing secret
compiles to an empty endpoint URL, the MCP gateway's OTLP config schema
rejects it, and the agent job dies at startup instead of skipping trace
export (observed on Khan/actions#241). A repo without these secrets must
comment out the `observability:` block in its installed `review.md` as a
local edit (which `gh aw update` preserves) and recompile.

## Versioning

Expand Down
5 changes: 5 additions & 0 deletions workflows/review/review.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ network:
# (Settings → Secrets and variables → Actions): GH_AW_OTEL_SENTRY_ENDPOINT — the Sentry
# OTLP traces endpoint with `/v1/traces` stripped (…/api/<project>/integration/otlp) — and
# GH_AW_OTEL_SENTRY_AUTHORIZATION — the `sentry sentry_key=<public-key>` header value.
# Both secrets are hard-required while this block is present: a missing one compiles to
# an empty value that the MCP gateway's OTLP config schema rejects, so the agent job
# dies at startup instead of skipping trace export. A repo without them must comment
# this block out in its installed review.md (a local edit `gh aw update` preserves)
# and recompile.
observability:
otlp:
endpoint:
Expand Down
Loading