docs(cryptify): document /metrics endpoint and X-Cryptify-Source header#105
Merged
Conversation
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
rubenhensen
approved these changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents Cryptify's Prometheus
/metricsendpoint and the newX-Cryptify-Sourcechannel-tagging header indocs/repos/cryptify.md. All identifiers verified against the cryptify#102 / #165 merge commits.Changes
metrics_scan_interval_secsrow to the configuration table (default60).src/config.rssource link to the #165 merge commit so the line range covers the new field.GET /metricsbullet to the API surface list for parity withdocs/guide/architecture.mdanddocs/repos/postguard.md.## Metricssection 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 PromQLincrease()rationale.### Channel detectionsub-section covering theX-Cryptify-Source-> bearer/api-key ->Origin->User-Agent->unknownpriority 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
Open
http://localhost:5173/repos/cryptifyand look for the new Metrics section between the existing API and Development sections.Verification
npx vitepress build docssucceeds in ~6.8 s.dist/repos/cryptify.htmlcontains the five metric names, the header name, the new config field, andGET /metrics.Closes #103