Repository navigation
feat(observability): protect /metrics with admin session or bearer token (Phase 10) - #512
Open
JesseJohn7 wants to merge 1 commit into
Open
JesseJohn7 wants to merge 1 commit into
JesseJohn7 wants to merge 1 commit into
Conversation
|
@JesseJohn7 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
Summary
Restricts
GET /metricsto authorized scrapers. The endpoint is refused by default and never exposed publicly.Changes
app/observability/auth.py:METRICS_BEARER_TOKEN(constant-time comparison, minimum 16 characters, can be set via app config or environment).401(withWWW-Authenticate: Bearer) for missing or invalid credentials,403for a signed-in non-admin.app/observability/routes.pyenforces the check after the existingMETRICS_ENABLEDswitch (404 when disabled). Refusals carry no metric data andCache-Control: no-store..env.exampleanddocs/observability.mddocumentMETRICS_BEARER_TOKEN, access rules and a Prometheus scrape config.Tests
tests/test_metrics_auth.py: anonymous refused, refused by default with no token, no leakage in refusals, valid/wrong/case-insensitive/non-bearer tokens, short tokens ignored, token from environment, wrong token refused even with an admin session, admin session allowed, non-admin 403, anonymous 401, disabled endpoint 404.tests/test_metrics.pyupdated to scrape with a token.ruff check .,black --check .andpytestpass locally.Depends on #476 (metrics endpoint).
Closes #477