Skip to content

docs: add jwt_authn filter statistics section #43935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agrawroh merged 1 commit into from
Mar 13, 2026
Merged

docs: add jwt_authn filter statistics section #43935

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/root/configuration/http/http_filters/jwt_authn_filter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,3 +216,22 @@ In this example the `tenants` claim is an object, therefore the JWT claim ("sub"
x-jwt-claim-sub: <JWT Claim>
x-jwt-claim-nested-key: <JWT Claim>
x-jwt-tenants: <Base64 encoded JSON JWT Claim>

Statistics
----------

The JWT authentication filter outputs statistics in the ``http.<stat_prefix>.jwt_authn.`` namespace.
The :ref:`stat prefix <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stat_prefix>`
comes from the owning HTTP connection manager.

.. csv-table::
:header: Name, Type, Description
:widths: 1, 1, 2

allowed, Counter, Total requests that passed JWT authentication
denied, Counter, Total requests that failed JWT authentication
cors_preflight_bypassed, Counter, Total CORS preflight requests that bypassed JWT authentication
jwks_fetch_success, Counter, Total successful JWKS (JSON Web Key Set) remote fetches
jwks_fetch_failed, Counter, Total failed JWKS remote fetch attempts
jwt_cache_hit, Counter, Total JWT cache hits where a previously validated token was reused
jwt_cache_miss, Counter, Total JWT cache misses requiring full token validation
Loading