Skip to content
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

Documented error metrics #597

Merged
merged 2 commits into from
Dec 26, 2024
Merged

Documented error metrics #597

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b914da8
Documented error metrics
deepakprabhakara Dec 25, 2024
ee2c6e0
tweak
deepakprabhakara Dec 26, 2024
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
25 changes: 17 additions & 8 deletions docs/jackson/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,20 @@ Please check the [Environment Variables](./deploy/env-variables.md#opentelemetry

## Metrics

| Name | Description | Type |
| --------------------------- | ---------------------------------------- | ----- |
| `jackson.connection.create` | Number of SSO Connection create requests | Count |
| `jackson.connection.get` | Number of SSO Connection get requests | Count |
| `jackson.connection.delete` | Number of SSO Connection delete requests | Count |
| `jackson.oauth.authorize` | Number of oauth authorize requests | Count |
| `jackson.oauth.token` | Number of oauth token requests | Count |
| `jackson.oauth.userinfo` | Number of oauth user info requests | Count |
| Name | Description | Type | Tags |
| --------------------------- | ---------------------------------------- | ----- | ---- |
| `jackson.connection.create` | Number of SSO Connection create requests | Count | ---- |
| `jackson.connection.get` | Number of SSO Connection get requests | Count | ---- |
| `jackson.connection.delete` | Number of SSO Connection delete requests | Count | ---- |
| `jackson.oauth.authorize` | Number of oauth authorize requests | Count | ---- |
| `jackson.oauth.token` | Number of oauth token requests | Count | ---- |
| `jackson.oauth.userinfo` | Number of oauth user info requests | Count | ---- |

From `v1.35.1` the following additional metrics are available:

| Name | Description | Type | Tags |
| --------------------------- | ---------------------------------------- | ----- | ---- |
| `jackson.oauth.authorize.error` | Number of oauth authorize errors | Count | **protocol**: `saml`,`oidc`,`saml-federated`,`oidc-federated` ; **login_type**: `sp-initiated`,`idp-initiated` |
| `jackson.oauth.token.error` | Number of oauth token errors | Count | **protocol**: `saml`,`oidc`,`saml-federated`,`oidc-federated` ; **login_type**: `sp-initiated`,`idp-initiated` |
| `jackson.oauth.userinfo.error` | Number of oauth user info errors | Count | **protocol**: `saml`,`oidc`,`saml-federated`,`oidc-federated` ; **login_type**: `sp-initiated`,`idp-initiated` |
| `jackson.oauth.response.error` | Number of oauth response errors | Count | **protocol**: `saml`,`oidc`,`saml-federated`,`oidc-federated` ; **login_type**: `sp-initiated`,`idp-initiated` |
Loading