Skip to content

docs(cryptify): document /metrics endpoint and X-Cryptify-Source header#105

Merged
rubenhensen merged 1 commit into
mainfrom
docs/cryptify-metrics-endpoint
May 19, 2026
Merged

docs(cryptify): document /metrics endpoint and X-Cryptify-Source header#105
rubenhensen merged 1 commit into
mainfrom
docs/cryptify-metrics-endpoint

Conversation

@dobby-coder
Copy link
Copy Markdown
Contributor

@dobby-coder dobby-coder Bot commented May 19, 2026

Documents Cryptify's Prometheus /metrics endpoint and the new X-Cryptify-Source channel-tagging header in docs/repos/cryptify.md. All identifiers verified against the cryptify#102 / #165 merge commits.

Changes

  • Add metrics_scan_interval_secs row to the configuration table (default 60).
  • Repin the src/config.rs source link to the #165 merge commit so the line range covers the new field.
  • Add a GET /metrics bullet to the API surface list for parity with docs/guide/architecture.md and docs/repos/postguard.md.
  • Add a ## Metrics section with the five Prometheus series, the storage-scan cadence, and the six pre-seeded channels (website, staging-website, outlook, thunderbird, api, unknown) from cryptify#165, including the PromQL increase() rationale.
  • Add a ### Channel detection sub-section covering the X-Cryptify-Source -> bearer/api-key -> Origin -> User-Agent -> unknown priority chain, the [a-z0-9_-] / 32-char sanitization, and the client-side header settings from postguard-website#228, postguard-outlook-addon#96, and postguard-tb-addon#121.

Reviewer quickstart

git fetch origin && git checkout docs/cryptify-metrics-endpoint && npm install && npx vitepress dev docs

Open http://localhost:5173/repos/cryptify and look for the new Metrics section between the existing API and Development sections.

Verification

  • npx vitepress build docs succeeds in ~6.8 s.
  • Built dist/repos/cryptify.html contains the five metric names, the header name, the new config field, and GET /metrics.

Closes #103

Adds the metrics_scan_interval_secs config row, a Metrics section
covering the five Prometheus series shipped in cryptify#102 and the
pre-seeded channels from cryptify#165, a channel-detection sub-section
covering the X-Cryptify-Source priority chain and sanitization, and a
GET /metrics bullet on the API list for parity with architecture.md
and postguard.md.

Closes #103
@dobby-coder dobby-coder Bot requested a review from rubenhensen May 19, 2026 04:53
@rubenhensen rubenhensen merged commit 30dcb3d into main May 19, 2026
2 checks passed
@rubenhensen rubenhensen deleted the docs/cryptify-metrics-endpoint branch May 19, 2026 07:21
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(cryptify): document Prometheus /metrics endpoint and X-Cryptify-Source header

1 participant