Skip to content

Commit

Permalink
Add jwt-authn metrics to jwt-provider docs (#17816)
Browse files Browse the repository at this point in the history
* [NET-3095] add jwt-authn metrics docs
  • Loading branch information
roncodingenthusiast authored Jun 20, 2023
1 parent 2a94ffa commit ee95bc7
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion website/content/docs/connect/config-entries/jwt-provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -1023,4 +1039,4 @@ spec:
```

</Tab>
</Tabs>
</Tabs>

0 comments on commit ee95bc7

Please sign in to comment.