From b914da8ed152b7182f5a3bbb6660ed6bd0d959ca Mon Sep 17 00:00:00 2001 From: Deepak Prabhakara Date: Wed, 25 Dec 2024 11:09:49 +0000 Subject: [PATCH 1/2] Documented error metrics --- docs/jackson/observability.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/jackson/observability.md b/docs/jackson/observability.md index e1ffa7cc..8fbbd6d3 100644 --- a/docs/jackson/observability.md +++ b/docs/jackson/observability.md @@ -12,11 +12,15 @@ 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 | ---- | +| `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` | From ee2c6e012131a4ba19b707b75e6ca97694bed810 Mon Sep 17 00:00:00 2001 From: Deepak Prabhakara Date: Thu, 26 Dec 2024 10:14:05 +0000 Subject: [PATCH 2/2] tweak --- docs/jackson/observability.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/jackson/observability.md b/docs/jackson/observability.md index 8fbbd6d3..efb81dcf 100644 --- a/docs/jackson/observability.md +++ b/docs/jackson/observability.md @@ -20,6 +20,11 @@ Please check the [Environment Variables](./deploy/env-variables.md#opentelemetry | `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` |