docs: add jwt_authn filter statistics section#43935
Merged
agrawroh merged 1 commit intoenvoyproxy:mainfrom Mar 13, 2026
Merged
Conversation
The jwt_authn filter defines 7 counter metrics (allowed, denied, cors_preflight_bypassed, jwks_fetch_success, jwks_fetch_failed, jwt_cache_hit, jwt_cache_miss) but these are not documented. Add a Statistics section following the same format used by other filter docs (RBAC, local rate limit, ext_authz). Fixes envoyproxy#28051 Signed-off-by: kovan <xaum.io@gmail.com>
|
Docs for this Pull Request will be rendered here: https://storage.googleapis.com/envoy-cncf-pr/43935/docs/index.html The docs are (re-)rendered each time the CI |
|
Hi @kovan, welcome and thank you for your contribution. We will try to review your Pull Request as quickly as possible. In the meantime, please take a look at the contribution guidelines if you have not done so already. |
agrawroh
approved these changes
Mar 13, 2026
bmjask
pushed a commit
to bmjask/envoy
that referenced
this pull request
Mar 14, 2026
## Summary Add a Statistics section to the jwt_authn filter documentation listing all 7 counter metrics defined in `source/extensions/filters/http/jwt_authn/stats.h`: | Metric | Description | |--------|-------------| | `allowed` | Total requests that passed JWT authentication | | `denied` | Total requests that failed JWT authentication | | `cors_preflight_bypassed` | Total CORS preflight requests that bypassed JWT authentication | | `jwks_fetch_success` | Total successful JWKS remote fetches | | `jwks_fetch_failed` | Total failed JWKS remote fetch attempts | | `jwt_cache_hit` | Total JWT cache hits where a previously validated token was reused | | `jwt_cache_miss` | Total JWT cache misses requiring full token validation | Follows the same RST format (namespace description + csv-table) used by other filter docs (RBAC, local rate limit, ext_authz). ## Test plan - [ ] Documentation builds correctly - [ ] Statistics table renders in the generated docs Fixes envoyproxy#28051 Signed-off-by: kovan <xaum.io@gmail.com> Signed-off-by: bjmask <11672696+bjmask@users.noreply.github.com>
fishcakez
pushed a commit
to fishcakez/envoy
that referenced
this pull request
Mar 25, 2026
## Summary Add a Statistics section to the jwt_authn filter documentation listing all 7 counter metrics defined in `source/extensions/filters/http/jwt_authn/stats.h`: | Metric | Description | |--------|-------------| | `allowed` | Total requests that passed JWT authentication | | `denied` | Total requests that failed JWT authentication | | `cors_preflight_bypassed` | Total CORS preflight requests that bypassed JWT authentication | | `jwks_fetch_success` | Total successful JWKS remote fetches | | `jwks_fetch_failed` | Total failed JWKS remote fetch attempts | | `jwt_cache_hit` | Total JWT cache hits where a previously validated token was reused | | `jwt_cache_miss` | Total JWT cache misses requiring full token validation | Follows the same RST format (namespace description + csv-table) used by other filter docs (RBAC, local rate limit, ext_authz). ## Test plan - [ ] Documentation builds correctly - [ ] Statistics table renders in the generated docs Fixes envoyproxy#28051 Signed-off-by: kovan <xaum.io@gmail.com>
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
2 participants
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
Add a Statistics section to the jwt_authn filter documentation listing all 7 counter metrics defined in
source/extensions/filters/http/jwt_authn/stats.h:alloweddeniedcors_preflight_bypassedjwks_fetch_successjwks_fetch_failedjwt_cache_hitjwt_cache_missFollows the same RST format (namespace description + csv-table) used by other filter docs (RBAC, local rate limit, ext_authz).
Test plan
Fixes #28051