Add jwt-authn metrics to jwt-provider docs (#17816)

* [NET-3095] add jwt-authn metrics docs
This commit is contained in:
Ronald 2023-06-20 15:46:16 -04:00 committed by GitHub
parent 2a94ffa571
commit ee95bc7266
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 1 deletions

View File

@ -952,6 +952,22 @@ Defines behavior for caching the validation result of previously encountered JWT
</Tab>
</Tabs>
## Metrics
Envoy proxies expose metrics that can track JWT authentication details. Use the following Envoy metrics:
```yaml
http.public_listener.jwt_authn.allowed
http.public_listener.jwt_authn.cors_preflight_bypassed
http.public_listener.jwt_authn.denied
http.public_listener.jwt_authn.jwks_fetch_failed
http.public_listener.jwt_authn.jwks_fetch_success
http.public_listener.jwt_authn.jwt_cache_hit
http.public_listener.jwt_authn.jwt_cache_miss
```
~> **Note:** Currently, Envoy does not reference these metrics in their documentation. Refer to [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/) for more information about exposed metrics.
## Examples
The following examples demonstrate common JWT provider configuration patterns for specific use cases.
@ -1023,4 +1039,4 @@ spec:
```
</Tab>
</Tabs>
</Tabs>