Skip to content

docs: record the standing axiom admin token and metrics dataset api - #606

Merged
zgeoff merged 2 commits into
mainfrom
docs/axiom-admin-token
Jul 16, 2026
Merged

docs: record the standing axiom admin token and metrics dataset api#606
zgeoff merged 2 commits into
mainfrom
docs/axiom-admin-token

Conversation

@zgeoff

@zgeoff zgeoff commented Jul 16, 2026

Copy link
Copy Markdown
Owner

Description

Aligns the deployment and observability docs with the provisioned Axiom reality.

  • The vault's admin-token (create/read/update on datasets, monitors, notifiers, dashboards — no deletes) is the standing credential for agent-driven administration; short-lived UI tokens remain only for destructive operations
  • The v2 dataset API creates the metrics dataset directly (kind: otel:metrics:v1) — drops the claim that the UI is required
  • The notifier's real name is vers alarms, not vers alerts

Testing

  • bun run typecheck passes
  • bun run test passes
  • bun run lint passes
  • New tests added for new functionality (docs only)

Review in cubic

The vault's admin-token (create/read/update on datasets, monitors, notifiers,
dashboards - no deletes) replaces short-lived UI tokens for agent-driven
administration; the v2 dataset API creates the metrics dataset directly with
kind otel:metrics:v1, so the UI-only claim goes. The notifier's real name is
vers alarms, not vers alerts.
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 304c2096-237e-4f52-9269-0a8a78a1795f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The documentation updates revise Axiom token sourcing, explicitly provision the vers-metrics OTLP dataset, and replace the vers alerts notifier reference with vers alarms across deployment and observability guidance.

Changes

Observability documentation

Layer / File(s) Summary
Axiom telemetry provisioning
docs/architecture/deployment.md
Provisioning instructions read the long-lived admin-token from 1Password and create the vers-metrics dataset with kind otel:metrics:v1 through the Axiom v2 API.
Monitor notification routing
docs/architecture/deployment.md, docs/architecture/observability.md
Monitor setup and threshold guidance now route notifications to vers alarms, including vers.verification.lag.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • zgeoff/vers#591: Updates related observability and deployment documentation for Axiom metrics provisioning and notifier naming.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly matches the main docs update about the standing Axiom admin token and metrics dataset API.
Description check ✅ Passed The description accurately summarizes the documentation changes and aligns with the pull request objectives.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/axiom-admin-token

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/architecture/deployment.md`:
- Around line 348-356: Add strict shell mode before the Axiom provisioning
commands and update both curl invocations in the dataset-creation loop and
metrics creation request to use fail-fast, show-error behavior. Keep the
existing endpoints, authorization, and payloads unchanged so any provisioning
failure stops the script visibly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: bbd07e8c-a445-42af-a090-66ba64bf5455

📥 Commits

Reviewing files that changed from the base of the PR and between 152b4a2 and aff1ea2.

📒 Files selected for processing (2)
  • docs/architecture/deployment.md
  • docs/architecture/observability.md

Comment thread docs/architecture/deployment.md

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

All reported issues were addressed across 2 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/architecture/deployment.md Outdated
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.

1 participant