Skip to content

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

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
roncodingenthusiast merged 5 commits into from
Jun 20, 2023
Merged

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

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
452d08d
[NET-3095] add jwt-authn metrics docs
roncodingenthusiast Jun 20, 2023
1f1f222
fix public_listener url
roncodingenthusiast Jun 20, 2023
8ef9ed3
Merge branch 'main' into NET-3095
roncodingenthusiast Jun 20, 2023
28e7e77
Update website/content/docs/connect/config-entries/jwt-provider.mdx
roncodingenthusiast Jun 20, 2023
4c37710
fix wording with PR feedback
roncodingenthusiast Jun 20, 2023
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
18 changes: 17 additions & 1 deletion website/content/docs/connect/config-entries/jwt-provider.mdx
View file
Open in desktop
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>