From ee95bc72660b756454327da5a2f8e0dc2cb71288 Mon Sep 17 00:00:00 2001 From: Ronald Date: Tue, 20 Jun 2023 15:46:16 -0400 Subject: [PATCH] Add jwt-authn metrics to jwt-provider docs (#17816) * [NET-3095] add jwt-authn metrics docs --- .../connect/config-entries/jwt-provider.mdx | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/website/content/docs/connect/config-entries/jwt-provider.mdx b/website/content/docs/connect/config-entries/jwt-provider.mdx index b31427af4f..8867a3e4f9 100644 --- a/website/content/docs/connect/config-entries/jwt-provider.mdx +++ b/website/content/docs/connect/config-entries/jwt-provider.mdx @@ -952,6 +952,22 @@ Defines behavior for caching the validation result of previously encountered JWT +## 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: ``` - \ No newline at end of file +