--- title: Monitoring metrics description: This section describes the monitoring metrics for common REST, JMX, or Graphite interfaces as well as the Prometheus monitoring metrics. component: pingam version: 8 page_id: pingam:maintenance:monitoring-metrics canonical_url: https://docs.pingidentity.com/pingam/8/maintenance/monitoring-metrics.html keywords: ["Monitoring"] page_aliases: ["monitoring-metric-types.adoc", "maintenance-guide:monitoring-metrics.adoc"] section_ids: metric-types: Metric types Summary: Summary Timer: Timer Gauge: Gauge DistinctCounter: Distinct counter ref-authentication-metrics: Authentication metrics ref-authorization-metrics: Authorization metrics ref-blacklisting-metrics: Denylisting metrics ref-CTS-metrics: CTS metrics ref-JVM-metrics: JVM metrics ref-oauth2-metrics: OAuth 2.0 metrics ref-scripting-metrics: Scripting metrics ref-session-metrics: Session metrics --- # Monitoring metrics This section describes the monitoring metrics for common REST, JMX, or Graphite interfaces as well as the Prometheus monitoring metrics. ## Metric types The following metric types are available. ### Summary The summary metric samples observations, providing a count of observations, sum total of observed amounts, average rate of events, and moving average rates across sliding time windows. * Fields * Prometheus fields | Field | Description | | ----------- | --------------------------------------------------------------------------------------------------------------------------------- | | `_id` | The metric ID. | | `_type` | The metric type. | | `count` | The number of events recorded for this metric. | | `total` | The sum of the values of events recorded for this metric. As the increment is always 1, the total and the count are always equal. | | `m1_rate` | The one-minute average rate. | | `m5_rate` | The five-minute average rate. | | `m15_rate` | The fifteen-minute average rate. | | `mean_rate` | The average rate. | | `units` | A description of the units the metric is presented in. | ***Example*** ```json { "_id" : "authentication.success", "_type" : "summary", "count" : 2, "total" : 2.0, "m1_rate" : 3.2668341885586836E-14, "m5_rate" : 7.794695663154025E-5, "m15_rate" : 0.01377545747021923, "mean_rate" : 8.238608027596704E-4, "units" : "events/second" } ``` The Prometheus endpoints don't provide rate-based statistics because rates can be calculated from the time-series data. | Field | Description | | -------- | -------------------------------------------------------------------------------------------------------------------------- | | `# TYPE` | The metric ID and type formatted as a comment. | | `_count` | The number of events recorded. | | `_sum` | The sum of the number of events recorded. This metric is output as \_total for the deprecated /metrics/prometheus endpoint | ***Example*** ```none # TYPE am_authentication summary am_authentication_count{outcome="success"} 2.0 am_authentication_sum{outcome="success"} 2.0 ``` ### Timer The timer metric combines rate and duration information. * Fields * Prometheus fields | Field | Description | | ---------------- | ------------------------------------------------------------- | | `_id` | The metric ID. | | `_type` | The metric type. | | `count` | The number of events recorded for this metric. | | `total` | The sum of the durations recorded for this metric. | | `min` | The minimum duration recorded for this metric. | | `max` | The maximum duration recorded for this metric. | | `mean` | The mean average duration recorded for this metric. | | `stddev` | The standard deviation of durations recorded for this metric. | | `duration_units` | The units used for measuring the durations in the metric. | | `p50` | 50% of the durations recorded are at or below this value. | | `p75` | 75% of the durations recorded are at or below this value. | | `p95` | 95% of the durations recorded are at or below this value. | | `p98` | 98% of the durations recorded are at or below this value. | | `p99` | 99% of the durations recorded are at or below this value. | | `p999` | 99.9% of the durations recorded are at or below this value. | | `m1_rate` | The one-minute average rate. | | `m5_rate` | The five-minute average rate. | | `m15_rate` | The fifteen-minute average rate. | | `mean_rate` | The average rate. | | `rate_units` | The units used for measuring the rate of the metric. | | | | | - | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | Duration-based values, such as `min`, `max`, and `p50`, are weighted towards newer data. By representing approximately the last five minutes of data, the timers make it easier to see recent changes in behavior, rather than a uniform average of recordings since the server was started. | ***Example*** ```json { "_id" : "cts.connection.success", "_type" : "timer", "count" : 486, "total" : 80.0, "min" : 0.0, "max" : 1.0, "mean" : 0.1905615495053855, "stddev" : 0.39274399467782056, "duration_units" : "milliseconds", "p50" : 0.0, "p75" : 0.0, "p95" : 1.0, "p98" : 1.0, "p99" : 1.0, "p999" : 1.0, "m1_rate" : 0.1819109974890356, "m5_rate" : 0.05433445522996721, "m15_rate" : 0.03155662103953588, "mean_rate" : 0.020858521722211427, "rate_units" : "calls/second" } ``` The Prometheus endpoints don't provide rate-based statistics because rates can be calculated from the time-series data. | Field | Description | | -------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `# TYPE` | The metric ID, and type. Formatted as a comment. The Timer metric type is reported as a Summary type. | | `_count` | The number of events recorded. | | `_sum` | The sum of the number of events recorded. This metric is output as \_total for the deprecated /metrics/prometheus endpoint | | `{quantile="0.5"}` | 50% of the durations are at or below this value. | | `{quantile="0.75"}` | 75% of the durations are at or below this value. | | `{quantile="0.95"}` | 95% of the durations are at or below this value. | | `{quantile="0.98"}` | 98% of the durations are at or below this value. | | `{quantile="0.99"}` | 99% of the durations are at or below this value. | | `{quantile="0.999"}` | 99.9% of the durations are at or below this value. | | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | Duration-based quantile values are weighted towards newer data. By representing approximately the last five minutes of data, the timers make it easier to see recent changes in behavior, rather than a uniform average of recordings since the server was started. | ***Example*** ```none # TYPE am_cts_connection_seconds summary am_cts_connection_seconds{outcome="success",quantile="0.5",} 0.0 am_cts_connection_seconds{outcome="success",quantile="0.75",} 0.0 am_cts_connection_seconds{outcome="success",quantile="0.95",} 0.001 am_cts_connection_seconds{outcome="success",quantile="0.98",} 0.001 am_cts_connection_seconds{outcome="success",quantile="0.99",} 0.001 am_cts_connection_seconds{outcome="success",quantile="0.999",} 0.001 am_cts_connection_count{outcome="success",} 492.0 am_cts_connection_seconds_sum{outcome="success",} 0.081 ``` ### Gauge The gauge metric is a numerical value that can increase or decrease. The value for a gauge is calculated when requested, and represents the state of the metric at that specific time. * Fields * Prometheus fields | Field | Description | | ------- | -------------------------------- | | `_id` | The metric ID. | | `_type` | The metric type. | | `value` | The current value of the metric. | ***Example*** ```json { "_id" : "jvm.used-memory", "_type" : "gauge", "value" : 2.13385216E9 } ``` | Field | Description | | ------------- | ---------------------------------------------------------------------------- | | `# TYPE` | The metric ID, and type. Formatted as a comment. | | `{Metric ID}` | The current value. Large values may be represented in scientific E-notation. | ***Example*** ```none # TYPE am_jvm_used_memory_bytes gauge am_jvm_used_memory_bytes 2.13385216E9 ``` ### Distinct counter Metric providing an estimate of the number of *unique* values recorded. For example, this could be used to estimate the number of unique users who have authenticated, or unique client IP addresses. | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------- | | | The `DistinctCounter` metric is calculated per instance of AM, and can't be aggregated across multiple instances to get a site-wide view. | * Fields * Prometheus fields | Field | Description | | ------- | ---------------------------------------------------------------------------------------------------------------------- | | `_id` | The metric ID. | | `_type` | The metric type. Note that the `distinctCounter` type is reported as a `gauge` type. The output formats are identical. | | `value` | The calculated estimate of the number of unique values recorded in the metric. | ***Example*** ```json { "_id" : "authentication.unique-uuid.success", "_type" : "gauge", "value" : 3.0 } ``` | Field | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `# TYPE` | The metric ID, and type. Note that the `distinctCounter` type is reported as a `gauge` type. The output formats are identical. Formatted as a comment. | | `{Metric ID}` | The calculated estimate of the number of unique values recorded in the metric. | ***Example*** ```none # TYPE am_authentication_unique_uuid gauge am_authentication_unique_uuid{outcome="success"} 3.0 ``` ## Authentication metrics AM exposes the following authentication-related monitoring metrics: * Authentication metrics * Prometheus authentication metrics | Name | Type | Description | | ------------------------------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `authentication.outcome` | Summary | Rate of successful/unsuccessful/timed-out authentication flows.The count of successful authentications is incremented when an authentication journey completes successfully. Likewise, the authentication count for failure outcomes is incremented for failed authentication journeys.For example, the authorization code flow requires a user session to exist and could redirect the user to a journey for authentication. The completion of this authentication step would then update the count.The client credentials grant, however, doesn't use a journey for authentication and, therefore, doesn't increment the count. | | `authentication.module.outcome` | Summary | This metric was used only for authentication with modules and chains and is no longer documented. | | `authentication.unique-uuid.success` | DistinctCounter | Count of unique identities that have successfully logged in. | | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | The deprecated `/metrics/prometheus` endpoint uses `_total` in metric names. The `/metrics/prometheus/0.0.4` endpoint uses `_sum` in metric names, which conforms with the latest Prometheus version. This table shows only the `/metrics/prometheus/0.0.4` endpoint metrics. | | Name | Type | Description | | ---------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `am_authentication_count{outcome=outcome,}` | Summary | Rate of successful/unsuccessful/timed-out authentication flows (count).The count of successful authentications is incremented when an authentication journey completes successfully. Likewise, the authentication count for failure outcomes is incremented for failed authentication journeys.For example, the authorization code flow requires a user session to exist and could redirect the user to a journey for authentication. The completion of this authentication step would then update the count.The client credentials grant, however, doesn't use a journey for authentication and, therefore, doesn't increment the count. | | `am_authentication_module_count{module=module,outcome=outcome,}` | Summary | This metric was used only for authentication with modules and chains and is no longer documented. | | `am_authentication_module_sum{module=module,outcome=outcome,}` | Summary | This metric was used only for authentication with modules and chains and is no longer documented. | | `am_authentication_sum{outcome=outcome,}` | Summary | Rate of successful/unsuccessful/timed-out authentication flows (total). | | `am_authentication_unique_uuid{outcome=outcome,}` | Gauge | Count of unique identities which have successfully logged in. | **Authentication metrics labels** | Label | Values | | --------- | ------------------------------------- | | `outcome` | * `success` * `failure` * `timeout` | ## Authorization metrics AM exposes the following authorization-related monitoring metrics after a policy evaluation takes place: * Authorization metrics * Prometheus authorization metrics | Name | Type | Description | | -------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | | `authorization.policy-set.policy-set.evaluate.action.action.outcome` | Summary | Rate of policy evaluation allowed/denied actions returned under a given policy set | | `authorization.policy-set.policy-set.evaluate.advice.advice-type` | Summary | Rate of policy evaluation advice types returned under a given policy set. | | `authorization.policy-set.evaluate.subject-cache.size` | Gauge | Number of cached subject membership relationships. | | `authorization.policy-set.policy-set.evaluate.outcome` | Timer | Rate of successful/unsuccessful policy evaluation calls under a given policy set and time taken to perform this operation. | | `authorization.policy-set.policy-set.policy.policy-operation` | Gauge | Number of policies created/updated/deleted under a given policy set since this AM instance started. | | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | The deprecated `/metrics/prometheus` endpoint uses `_total` in metric names. The `/metrics/prometheus/0.0.4` endpoint uses `_sum` in metric names, which conforms with the latest Prometheus version. This table shows only the `/metrics/prometheus/0.0.4` endpoint metrics. | | Name | Type | Description | | -------------------------------------------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `am_authorization_policy_set_policy_count{operation=policy-operation,policy_set=policy-set,}` | Summary | Number of policies created/updated/deleted under a given policy set since this AM instance was started. (Summary) | | `am_authorization_policy_set_policy_sum{operation=policy-operation,policy_set=policy-set,}` | Summary | Number of policies created/updated/deleted under a given policy set since this AM instance was started. (Summary) | | `am_authorization_policy_set_evaluate_subject_cache_size` | Summary | Number of cached subject membership relationships. | | `am_authorization_policy_set_evaluate_seconds{outcome=outcome,policy_set=policy-set,quantile=quantile,}` | Summary | Rate of successful/unsuccessful policy evaluation calls under a given policy set and time taken to perform this operation. (Timer) | | `am_authorization_policy_set_evaluate_count{outcome=outcome,policy_set=policy-set,}` | Summary | Rate of successful/unsuccessful policy evaluation calls under a given policy set and time taken to perform this operation. (Timer) | | `am_authorization_policy_set_evaluate_seconds_sum{outcome=outcome,policy_set=policy-set,}` | Summary | Rate of successful/unsuccessful policy evaluation calls under a given policy set and time taken to perform this operation. (Timer) | | `am_authorization_policy_set_evaluate_action_sum{action_type=action,outcome="allow",policy_set=policy-set,}` | Summary | Rate of policy evaluation allowed/denied actions being returned under a given policy set (total). | | `am_authorization_policy_set_evaluate_action_count{action_type=action,outcome="allow",policy_set=policy-set,}` | Summary | Rate of policy evaluation allowed/denied actions being returned under a given policy set (count). | | `am_authorization_policy_set_evaluate_advice{policy_set=policy-set,advice-type=advice-type,}` | Summary | Rate of policy evaluation advice types being returned under a given policy set. | | `am_authorization_policy_set_evaluate_advice_count{policy_set=policy-set,advice-type,}` | Summary | Rate of policy evaluation advice types being returned under a given policy set (count). | | `am_authorization_policy_set_evaluate_advice_sum{policy_set=policy-set,advice-type=advice-type}` | Summary | Rate of policy evaluation advice types being returned under a given policy set (total). | **Authorization metrics labels** | Label | Values | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `action` | Name of the action as specified in the policy, for example:- `GET` - `GRANT` - `MODIFY` - `DELEGATE` - `READ` | | `advice-type` | Name of the policy condition advice, for example:- `AuthSchemeConditionAdvice` - `AuthenticateToServiceConditionAdvice` - `AuthLevelConditionAdvice` | | `outcome` | * `success` * `allow` | | `policy-operation` | Type of operation performed on the policy, for example:* `create` * `delete` * `update` | | `policy-set` | Name of the policy set, for example:* `iPlanetAMWebAgentService` * `oauth2Scopes` | | `quantile` | Refer to [Timer](#Timer) for `quantile` values. | ## Denylisting metrics AM exposes the following denylisting monitoring metrics: * Denylisting metrics * Prometheus denylisting metrics | Name | Type | Description | | --------------------------------------------------- | ------- | ------------------------------------------------------ | | `denylist type.blacklist.bloomfilter.check.outcome` | Summary | Rate of bloom filter denylist checks. | | `denylist type.blacklist.cts.search.outcome` | Timer | Tracks time to search CTS for denylist entries | | `denylist type.blacklist.cts.search.result` | Summary | Rate of denylist entries returned by searches. | | `denylist type.blacklist.cache.check.cache outcome` | Summary | Rate of cache hits/misses of the denylist cache layer. | | `denylist type.blacklist.check.check outcome` | Summary | Rate of denylist checks. | | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | The deprecated `/metrics/prometheus` endpoint uses `_total` in metric names. The `/metrics/prometheus/0.0.4` endpoint uses `_sum` in metric names, which conforms with the latest Prometheus version. This table shows only the `/metrics/prometheus/0.0.4` endpoint metrics. | | Name | Type | Description | | -------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------- | | `am_blacklist_cts_search_count{blacklist_type=denylist type,outcome=outcome,}` | Summary | Tracks time to search CTS for denylist entries (count). | | `am_blacklist_cts_search_result_count{blacklist_type=denylist type,}` | Summary | Rate of denylist entries returned by searches (count). | | `am_blacklist_cts_search_result_sum{blacklist_type=denylist type,}` | Summary | Rate of denylist entries returned by searches (total). | | `am_blacklist_cts_search_seconds_sum{blacklist_type=denylist type,outcome=outcome,}` | Summary | Tracks time to search CTS for denylist entries (count). | | `am_blacklist_cts_search_seconds{blacklist_type=denylist type,outcome=outcome,quantile=quantile,}` | Summary | Tracks time to search CTS for denylist entries. | | am\_blacklist\_bloomfilter\_check{blacklist\_type=denylist type,outcome=outcome} | Summary | Rate of bloom filter denylist checks. | | am\_blacklist\_cache{blacklist\_type=denylist type,outcome=cache outcome} | Summary | Rate of cache hits/misses of the denylist cache layer. | | am\_blacklist\_check{blacklist\_type=denylist type,outcome=check outcome} | Summary | Rate of denylist checks. | **Denylisting metrics labels** | Label | Values | | --------------- | ----------------------------------------------------------------------- | | `denylist type` | * `session_client_based` * `oauth2` | | `outcome` | - `success` - `failure` | | `cache outcome` | * `hit` * `miss` | | `check outcome` | - `true` The token is denylisted - `false` The token is not denylisted | | `quantile` | Refer to [Timer](#Timer) for `quantile` values. | ## CTS metrics AM exposes the following CTS-related monitoring metrics: * CTS metrics * Prometheus CTS metrics | Name | Type | Description | | ---------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------- | | `cts.connection.outcome` | Timer | Rate of successful/unsuccessful CTS connections to DS and time taken to obtain the connection. | | `cts.connection.state.status` | Counter | The number of connections in each state. | | `cts.reaper.cache.size` | Gauge | Number of entries in the token reaper cache. | | `cts.reaper.cache.cts reaper token type.deletion.outcome` | Summary | Rate of successful/unsuccessful token deletions from cache by token type. | | `cts.reaper.search.cts reaper token type.deletion.outcome` | Summary | Rate of successful/unsuccessful token deletions from search by token type. | | `cts.reaper.search.outcome` | Timer | Rate of successful/unsuccessful searches and time taken to perform this operation. | | `cts.task.cts reaper token type.operation.outcome` | Summary | Rate of successful/unsuccessful CTS operation types, by token type and time taken to perform them. | | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | The deprecated `/metrics/prometheus` endpoint uses `_total` in metric names. The `/metrics/prometheus/0.0.4` endpoint uses `_sum` in metric names, which conforms with the latest Prometheus version. This table shows only the `/metrics/prometheus/0.0.4` endpoint metrics. | | Name | Type | Description | | ----------------------------------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------- | | `am_cts_connection_count{outcome=outcome,}` | Summary | Rate of successful/unsuccessful CTS connections to DS and time taken to obtain the connection. | | `am_cts_connection_seconds_sum{outcome=outcome,}` | Summary | Rate of successful/unsuccessful CTS connections to DS and time taken to obtain the connection (total). | | `am_cts_connection_seconds{outcome=outcome,quantile=quantile,}` | Summary | Rate of successful/unsuccessful CTS connections to DS and time taken to obtain the connection. | | `am_cts_connection_state{status=status,}` | Counter | The number of connections in each state. | | `am_cts_reaper_cache_size` | Gauge | Number of entries in the token reaper cache. | | `am_cts_reaper_deletion_sum{outcome=outcome,reaper_type="cache",token_type=cts reaper token type,}` | Summary | Number of token deletions from cache by token type (total). | | `am_cts_reaper_deletion_count{outcome=outcome,reaper_type="cache",token_type=cts reaper token type,}` | Summary | Number of token deletions from cache by token type (count). | | `am_cts_reaper_search_count{outcome=outcome,}` | Summary | Time taken to perform searches by CTS reaper (count). | | `am_cts_reaper_search_seconds_sum{outcome=outcome,}` | Summary | Time taken to perform searches by CTS reaper (total). | | `am_cts_reaper_search_seconds{outcome=outcome,quantile=quantile,}` | Summary | Time taken to perform searches by CTS reaper. | | `am_cts_task_count{operation=operation,outcome=outcome,token_type=token-type,}` | Summary | Rate of successful/unsuccessful CTS operation types, by token type and time taken to perform them. | | `am_cts_task_pending{operation=operation,}` | Counter | Tracks number of active create operations. | | `am_cts_task_seconds_sum{operation=operation,outcome=outcome,token_type=token-type,}` | Summary | Rate of successful/unsuccessful CTS operation types, by token type and time taken to perform them (total). | | `am_cts_task_seconds{operation=operation,outcome=outcome,token_type=token-type,quantile=quantile,}` | Summary | Rate of successful/unsuccessful CTS operation types, by token type and time taken to perform them. | **CTS metrics labels** | Label | Values | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cts reaper token type` | * `cluster-notification` * `session` | | `operation` | - `create` - `delete` - `partial-query` - `patch` - `query` - `read` - `update` - `upsert` | | `outcome` | * `success` * `failure` | | `quantile` | Refer to [Timer](#Timer) for `quantile` values. | | `status` | - `out` - `pending` | | `token_type` | * `authentication-whitelist` * `back-channel-authentication-state` * `cluster-notification` * `logout-user` * `oauth2-blacklist` * `oauth2-csrf-protection` * `oauth2-grant-set` * `oauth2-stateless-grant` * `oauth2-stateless` * `oauth2` * `push-notification` * `request-uri-object` * `resource-set` * `rest` * `saml2` * `session-blacklist` * `session` * `sts` * `suspended-auth-session` * `transaction` * `uma-audit-entry` * `uma-pending-request` * `uma-permission-ticket` * `uma-requesting-party` * `unknown` | ## JVM metrics AM exposes the JVM-related monitoring metrics covered in this section. | | | | - | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | These metrics may depend on the JVM version and configuration. In particular, garbage-collector-related metrics depend on the garbage collector that the server uses. The garbage-collector metric names are *unstable*, and can change even in a minor JVM release. | The following JVM metrics are all [Gauge](#Gauge) metrics. * JVM metrics * Prometheus JVM metrics | Name | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `jvm.available-cpus` | Number of processors available to the Java virtual machine. | | `jvm.class-loading.loaded` | Number of classes loaded since the Java virtual machine started. | | `jvm.class-loading.unloaded` | Number of classes unloaded since the Java virtual machine started. | | `jvm.free-used-memory` | Amount of free memory. | | `jvm.used-memory` | Amount of used memory. | | `jvm.max-memory` | Maximum amount of memory. | | `jvm.garbage-collector.Copy.count` | Number of collections performed by the "copy" garbage collection algorithm. | | `jvm.garbage-collector.Copy.time` | Approximate accumulated time taken by the "copy" garbage collection algorithm. | | `jvm.garbage-collector.MarkSweepCompact.count` | Number of collections performed by the "mark sweep" garbage collection algorithm. | | `jvm.garbage-collector.MarkSweepCompact.time` | Approximate accumulated time taken by the "mark sweep" garbage collection algorithm. | | `jvm.memory-usage.heap.init` | Amount of heap memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.heap.max` | Maximum amount of heap memory the Java virtual machine attempts to use. | | `jvm.memory-usage.heap.committed` | Amount of heap memory committed for the Java virtual machine to use. | | `jvm.memory-usage.heap.used` | Amount of heap memory used by the Java virtual machine. | | `jvm.memory-usage.heap.usage` | Percentage of heap memory used out of the maximum available. | | `jvm.memory-usage.non-heap.init` | Amount of non-heap memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.non-heap.max` | Maximum amount of non-heap memory the Java virtual machine attempts to use. | | `jvm.memory-usage.non-heap.committed` | Amount of non-heap memory that is committed for the Java virtual machine to use. | | `jvm.memory-usage.non-heap.used` | Amount of non-heap memory used by the Java virtual machine. | | `jvm.memory-usage.non-heap.usage` | Percentage of non-heap memory used out of the maximum available. | | `jvm.memory-usage.pools.Compressed-Class-Space.init` | Amount of "compressed class space" memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.pools.Compressed-Class-Space.max` | Maximum amount of "compressed class space" memory the Java virtual machine attempts to use. | | `jvm.memory-usage.pools.Compressed-Class-Space.committed` | Amount of "compressed class space" memory committed for the Java virtual machine to use. | | `jvm.memory-usage.pools.Compressed-Class-Space.used` | Amount of "compressed class space" memory used by the Java virtual machine. | | `jvm.memory-usage.pools.Compressed-Class-Space.usage` | Percentage of "compressed class space" memory used out of the maximum available. | | `jvm.memory-usage.pools.CodeHeap-'non-nmethods'.init` | Amount of CodeHeap "non-nmethods" memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.pools.CodeHeap-'non-nmethods'.max` | Maximum amount of CodeHeap "non-nmethods" memory the Java virtual machine attempts to use. | | `jvm.memory-usage.pools.CodeHeap-'non-nmethods'.committed` | Amount of CodeHeap "non-nmethods" memory committed for the Java virtual machine to use. | | `jvm.memory-usage.pools.CodeHeap-'non-nmethods'.used` | Amount of CodeHeap "non-nmethods" memory used by the Java virtual machine. | | `jvm.memory-usage.pools.CodeHeap-'non-nmethods'.usage` | Percentage of CodeHeap "non-nmethods" memory used out of the maximum available. | | `jvm.memory-usage.pools.CodeHeap-'non-profiled-nmethods'.init` | Amount of CodeHeap "non-profiled-nmethods" memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.pools.CodeHeap-'non-profiled-nmethods'.max` | Maximum amount of CodeHeap "non-profiled-nmethods" memory the Java virtual machine attempts to use. | | `jvm.memory-usage.pools.CodeHeap-'non-profiled-nmethods'.committed` | Amount of CodeHeap "non-profiled-nmethods" memory committed for the Java virtual machine to use. | | `jvm.memory-usage.pools.CodeHeap-'non-profiled-nmethods'.used` | Amount of CodeHeap "non-profiled-nmethods" memory used by the Java virtual machine. | | `jvm.memory-usage.pools.CodeHeap-'non-profiled-nmethods'.usage` | Percentage of CodeHeap "non-profiled-nmethods" memory used out of the maximum available. | | `jvm.memory-usage.pools.CodeHeap-'profiled-nmethods'.init` | Amount of CodeHeap "profiled-nmethods" memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.pools.CodeHeap-'profiled-nmethods'.max` | Maximum amount of CodeHeap "profiled-nmethods" memory the Java virtual machine attempts to use. | | `jvm.memory-usage.pools.CodeHeap-'profiled-nmethods'.committed` | Amount of CodeHeap "profiled-nmethods" memory committed for the Java virtual machine to use. | | `jvm.memory-usage.pools.CodeHeap-'profiled-nmethods'.used` | Amount of CodeHeap "profiled-nmethods" memory used by the Java virtual machine. | | `jvm.memory-usage.pools.CodeHeap-'profiled-nmethods'.usage` | Percentage of CodeHeap "profiled-nmethods" memory used out of the maximum available. | | `jvm.memory-usage.pools.Metaspace.init` | Amount of "metaspace" memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.pools.Metaspace.max` | Maximum amount of "metaspace" memory the Java virtual machine attempts to use. | | `jvm.memory-usage.pools.Metaspace.committed` | Amount of "metaspace" memory committed for the Java virtual machine to use. | | `jvm.memory-usage.pools.Metaspace.used` | Amount of "metaspace" memory used by the Java virtual machine. | | `jvm.memory-usage.pools.Metaspace.usage` | Percentage of "metaspace" memory used out of the maximum available. | | `jvm.memory-usage.pools.Eden-Space.init` | Amount of "eden space" memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.pools.Eden-Space.max` | Maximum amount of "eden space" memory (young generation) the Java virtual machine attempts to use. | | `jvm.memory-usage.pools.Eden-Space.committed` | Amount of "eden space" memory (young generation) committed for the Java virtual machine to use. | | `jvm.memory-usage.pools.Eden-Space.used-after-gc` | Amount of "eden space" memory (young generation) after the last time garbage collection recycled unused objects in this memory pool. | | `jvm.memory-usage.pools.Eden-Space.used` | Amount of "eden space" memory (young generation) used by the Java virtual machine. | | `jvm.memory-usage.pools.Eden-Space.usage` | Percentage of "eden space" memory (young generation) used out of the maximum available. | | `jvm.memory-usage.pools.Tenured-Gen.init` | Amount of "tenured generation" (old generation) memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.pools.Tenured-Gen.max` | Maximum amount of "tenured generation" (old generation) memory the Java virtual machine attempts to use. | | `jvm.memory-usage.pools.Tenured-Gen.committed` | Amount of "tenured generation" memory (old generation) committed for the Java virtual machine to use. | | `jvm.memory-usage.pools.Tenured-Gen.used-after-gc` | Amount of "tenured generation" memory (old generation) after the last time garbage collection recycled unused objects in this memory pool. | | `jvm.memory-usage.pools.Tenured-Gen.used` | Amount of "tenured generation" memory (old generation) used by the Java virtual machine. | | `jvm.memory-usage.pools.Tenured-Gen.usage` | Percentage of "tenured generation" memory (old generation) used out of the maximum available. | | `jvm.memory-usage.pools.Survivor-Space.init` | Amount of "survivor space" memory (young generation) the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.pools.Survivor-Space.max` | Maximum amount of "survivor space" memory (young generation) the Java virtual machine attempts to use. | | `jvm.memory-usage.pools.Survivor-Space.committed` | Amount of "survivor space" memory (young generation) committed for the Java virtual machine to use. | | `jvm.memory-usage.pools.Survivor-Space.used-after-gc` | Amount of "survivor space" memory (young generation) after the last time garbage collection recycled unused objects in this memory pool. | | `jvm.memory-usage.pools.Survivor-Space.used` | Amount of "survivor space" memory (young generation) used by the Java virtual machine. | | `jvm.memory-usage.pools.Survivor-Space.usage` | Percentage of "survivor space" memory (young generation) used out of the maximum available. | | `jvm.memory-usage.total.committed` | Amount of memory committed for the Java virtual machine to use. | | `jvm.memory-usage.total.init` | Amount of memory the Java virtual machine initially requested from the operating system. | | `jvm.memory-usage.total.max` | Maximum amount of memory the Java virtual machine attempts to use. | | `jvm.memory-usage.total.used` | Amount of memory used by the Java virtual machine. | | `jvm.thread-state.blocked.count` | Number of threads in the BLOCKED state. | | `jvm.thread-state.count` | Number of live threads including both daemon and non-daemon threads. | | `jvm.thread-state.daemon.count` | Number of live daemon threads. | | `jvm.thread-state.new.count` | Number of threads in the NEW state. | | `jvm.thread-state.runnable.count` | Number of threads in the RUNNABLE state. | | `jvm.thread-state.terminated.count` | Number of threads in the TERMINATED state. | | `jvm.thread-state.timed_waiting.count` | Number of threads in the TIMED\_WAITING state. | | `jvm.thread-state.waiting.count` | Number of threads in the WAITING state. | | Name | Description | | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `am_jvm_available_cpus` | Number of processors available to the Java virtual machine. | | `am_jvm_class_loading_loaded` | Number of classes loaded since the Java virtual machine started. | | `am_jvm_class_loading_unloaded` | Number of classes unloaded since the Java virtual machine started. | | `am_jvm_free_used_memory_bytes` | Amount of free memory. | | `am_jvm_used_memory_bytes` | Amount of used memory. | | `am_jvm_max_memory_bytes` | Maximum amount of memory. | | `am_jvm_garbage_collector_copy_count` | Number of collections performed by the "copy" garbage collection algorithm. | | `am_jvm_garbage_collector_copy_time` | Approximate accumulated time taken by the "copy" garbage collection algorithm. | | `am_jvm_garbage_collector_markSweepCompact_count` | Number of collections performed by the "mark sweep" garbage collection algorithm. | | `am_jvm_garbage_collector_markSweepCompact_time` | Approximate accumulated time taken by the "mark sweep" garbage collection algorithm. | | `am_jvm_memory_usage_heap_init` | Amount of heap memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_heap_max` | Maximum amount of heap memory the Java virtual machine attempts to use. | | `am_jvm_memory_usage_heap_committed` | Amount of heap memory committed for the Java virtual machine to use. | | `am_jvm_memory_usage_heap_used` | Amount of heap memory used by the Java virtual machine. | | `am_jvm_memory_usage_heap_usage` | Percentage of heap memory used out of the maximum available. | | `am_jvm_memory_usage_non_heap_init` | Amount of non\_heap memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_non_heap_max` | Maximum amount of non\_heap memory the Java virtual machine attempts to use. | | `am_jvm_memory_usage_non_heap_committed` | Amount of non\_heap memory that is committed for the Java virtual machine to use. | | `am_jvm_memory_usage_non_heap_used` | Amount of non\_heap memory used by the Java virtual machine. | | `am_jvm_memory_usage_non_heap_usage` | Percentage of non\_heap memory used out of the maximum available. | | `am_jvm_memory_usage_pools_compressed_Class_Space_init` | Amount of "compressed class space" memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_pools_compressed_Class_Space_max` | Maximum amount of "compressed class space" memory the Java virtual machine attempts to use. | | `am_jvm_memory_usage_pools_compressed_Class_Space_committed` | Amount of "compressed class space" memory committed for the Java virtual machine to use. | | `am_jvm_memory_usage_pools_compressed_Class_Space_used` | Amount of "compressed class space" memory used by the Java virtual machine. | | `am_jvm_memory_usage_pools_compressed_Class_Space_usage` | Percentage of "compressed class space" memory used out of the maximum available. | | `am_jvm_memory_usage_pools_codeheapnon_nmethodsinit` | Amount of CodeHeap "non\_nmethods" memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_pools_codeheap__non_nmethods\__max` | Maximum amount of CodeHeap "non\_nmethods" memory the Java virtual machine attempts to use. | | `am_jvm_memory_usage_pools_codeheap__non_nmethods__committed` | Amount of CodeHeap "non\_nmethods" memory committed for the Java virtual machine to use. | | `am_jvm_memory_usage_pools_codeheap__non_nmethods\__used` | Amount of CodeHeap "non\_nmethods" memory used by the Java virtual machine. | | `am_jvm_memory_usage_pools_codeheap__non_nmethods\__usage` | Percentage of CodeHeap "non\_nmethods" memory used out of the maximum available. | | `am_jvm_memory_usage_pools_codeheap__non_profiled_nmethods\__init` | Amount of CodeHeap "non\_profiled\_nmethods" memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_pools_codeheap__non_profiled_nmethods\__max` | Maximum amount of CodeHeap "non\_profiled\_nmethods" memory the Java virtual machine attempts to use. | | `am_jvm_memory_usage_pools_codeheap__non_profiled_nmethods\__committed` | Amount of CodeHeap "non\_profiled\_nmethods" memory committed for the Java virtual machine to use. | | `am_jvm_memory_usage_pools_codeheap__non_profiled_nmethods\__used` | Amount of CodeHeap "non\_profiled\_nmethods" memory used by the Java virtual machine. | | `am_jvm_memory_usage_pools_codeheap__non_profiled_nmethods\__usage` | Percentage of CodeHeap "non\_profiled\_nmethods" memory used out of the maximum available. | | `am_jvm_memory_usage_pools_codeheap__profiled_nmethods\__init` | Amount of CodeHeap "profiled\_nmethods" memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_pools_codeheap__profiled_nmethods\__max` | Maximum amount of CodeHeap "profiled\_nmethods" memory the Java virtual machine attempts to use. | | `am_jvm_memory_usage_pools_codeheap__profiled_nmethods\__committed` | Amount of CodeHeap "profiled\_nmethods" memory committed for the Java virtual machine to use. | | `am_jvm_memory_usage_pools_codeheap__profiled_nmethods\__used` | Amount of CodeHeap "profiled\_nmethods" memory used by the Java virtual machine. | | `am_jvm_memory_usage_pools_codeheap__profiled_nmethods\__usage` | Percentage of CodeHeap "profiled\_nmethods" memory used out of the maximum available. | | `am_jvm_memory_usage_pools_metaspace_init` | Amount of "metaspace" memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_pools_metaspace_max` | Maximum amount of "metaspace" memory the Java virtual machine attempts to use. | | `am_jvm_memory_usage_pools_metaspace_committed` | Amount of "metaspace" memory committed for the Java virtual machine to use. | | `am_jvm_memory_usage_pools_metaspace_used` | Amount of "metaspace" memory used by the Java virtual machine. | | `am_jvm_memory_usage_pools_metaspace_usage` | Percentage of "metaspace" memory used out of the maximum available. | | `am_jvm_memory_usage_pools.Eden_Space_init` | Amount of "eden space" memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_pools.Eden_Space_max` | Maximum amount of "eden space" memory (young generation) the Java virtual machine attempts to use. | | `am_jvm_memory_usage_pools.Eden_Space_committed` | Amount of "eden space" memory (young generation) committed for the Java virtual machine to use. | | `am_jvm_memory_usage_pools.Eden_Space_used_after_gc` | Amount of "eden space" memory (young generation) after the last time garbage collection recycled unused objects in this memory pool. | | `am_jvm_memory_usage_pools.Eden_Space_used` | Amount of "eden space" memory (young generation) used by the Java virtual machine. | | `am_jvm_memory_usage_pools.Eden_Space_usage` | Percentage of "eden space" memory (young generation) used out of the maximum available. | | `am_jvm_memory_usage_pools_tenured_Gen_init` | Amount of "tenured generation" (old generation) memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_pools_tenured_Gen_max` | Maximum amount of "tenured generation" (old generation) memory the Java virtual machine attempts to use. | | `am_jvm_memory_usage_pools_tenured_Gen_committed` | Amount of "tenured generation" memory (old generation) committed for the Java virtual machine to use. | | `am_jvm_memory_usage_pools_tenured_Gen_used_after_gc` | Amount of "tenured generation" memory (old generation) after the last time garbage collection recycled unused objects in this memory pool. | | `am_jvm_memory_usage_pools_tenured_Gen_used` | Amount of "tenured generation" memory (old generation) used by the Java virtual machine. | | `am_jvm_memory_usage_pools_tenured_Gen_usage` | Percentage of "tenured generation" memory (old generation) used out of the maximum available. | | `am_jvm_memory_usage_pools.Survivor_Space_init` | Amount of "survivor space" memory (young generation) the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_pools.Survivor_Space_max` | Maximum amount of "survivor space" memory (young generation) the Java virtual machine attempts to use. | | `am_jvm_memory_usage_pools.Survivor_Space_committed` | Amount of "survivor space" memory (young generation) committed for the Java virtual machine to use. | | `am_jvm_memory_usage_pools.Survivor_Space_used_after_gc` | Amount of "survivor space" memory (young generation) after the last time garbage collection recycled unused objects in this memory pool. | | `am_jvm_memory_usage_pools.Survivor_Space_used` | Amount of "survivor space" memory (young generation) used by the Java virtual machine. | | `am_jvm_memory_usage_pools.Survivor_Space_usage` | Percentage of "survivor space" memory (young generation) used out of the maximum available. | | `am_jvm_memory_usage_total_committed` | Amount of memory committed for the Java virtual machine to use. | | `am_jvm_memory_usage_total_init` | Amount of memory the Java virtual machine initially requested from the operating system. | | `am_jvm_memory_usage_total_max` | Maximum amount of memory the Java virtual machine attempts to use. | | `am_jvm_memory_usage_total_used` | Amount of memory used by the Java virtual machine. | | `am_jvm_thread_state_blocked_count` | Number of threads in the BLOCKED state. | | `am_jvm_thread_state_count` | Number of live threads including both daemon and non\_daemon threads. | | `am_jvm_thread_state_daemon_count` | Number of live daemon threads. | | `am_jvm_thread_state_new_count` | Number of threads in the NEW state. | | `am_jvm_thread_state_runnable_count` | Number of threads in the RUNNABLE state. | | `am_jvm_thread_state_terminated_count` | Number of threads in the TERMINATED state. | | `am_jvm_thread_state_timed_waiting_count` | Number of threads in the TIMED\_WAITING state. | | `am_jvm_thread_state_waiting_count` | Number of threads in the WAITING state. | ## OAuth 2.0 metrics AM exposes the following OAuth 2.0 monitoring metrics: * OAuth 2.0 metrics * Prometheus OAuth 2.0 metrics | Name | Type | Description | | ---------------------------------- | ------- | ---------------------------------------------------------------------------- | | `oauth2.grant.grant-type` | Summary | Rate of OAuth 2.0 grant completion by grant type. | | `oauth2.grant.revoke` | Summary | Rate of OAuth 2.0 grant revocation | | `oauth2.token.token-type.issue` | Summary | Rate of OAuth 2.0 token issuance by token type. | | `oauth2.token.access-token.revoke` | Summary | Rate of OAuth 2.0 access token revocation. | | `oauth2.token.read-as-jwt.outcome` | Timer | Rate of successfully/unsuccessfully reading OAuth 2.0 JSON Web Tokens (JWT). | | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | The deprecated `/metrics/prometheus` endpoint uses `_total` in metric names. The `/metrics/prometheus/0.0.4` endpoint uses `_sum` in metric names, which conforms with the latest Prometheus version. This table shows only the `/metrics/prometheus/0.0.4` endpoint metrics. | | Name | Type | Description | | ------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | | `am_oauth2_grant_count{grant_type=grant-type,}` | Summary | Rate of OAuth 2.0 grant completion by grant type (count). | | `am_oauth2_grant_revoke_count{grant_type="unknown",}` | Summary | Rate of OAuth 2.0 grant revocation for unknown grant types (count). | | `am_oauth2_grant_revoke_sum{grant_type="unknown",}` | Summary | Rate of OAuth 2.0 grant revocation for unknown grant types (total). | | `am_oauth2_grant_sum{grant_type=grant-type,}` | Summary | Rate of OAuth 2.0 grant completion by grant type (total). | | `am_oauth2_token_issue_count{token_type=token-type,}` | Summary | Rate of OAuth 2.0 token issuance by token type (count). | | `am_oauth2_token_issue_sum{token_type=token-type,}` | Summary | Rate of OAuth 2.0 token issuance by token type (total). | | `am_oauth2_token_read_as_jwt_count{outcome=outcome,}` | Summary | Rate of successfully/unsuccessfully reading OAuth 2.0 JSON Web Tokens (JWT) (count). | | `am_oauth2_token_read_as_jwt_seconds_sum{outcome=outcome,}` | Summary | Rate of successfully/unsuccessfully reading OAuth 2.0 JSON Web Tokens (JWT) (total). | | `am_oauth2_token_read_as_jwt_seconds{outcome=outcome,quantile=quantile,}` | Summary | Rate of successfully/unsuccessfully reading OAuth 2.0 JSON Web Tokens (JWT). | | `am_oauth2_token_revoke_count{token_type="access-token",}` | Summary | Rate of OAuth 2.0 access token revocation (count) | | `am_oauth2_token_revoke_sum{token_type="access-token",}` | Summary | Rate of OAuth 2.0 access token revocation (total) | **OAuth 2.0 metrics labels** | Label | Values | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `grant-type` | * `authorization-code` * `back-channel` * `client-credentials` * `device-code` * `implicit` * `jwt-bearer` * `refresh` * `resource-owner-password` * `saml2` * `token-exchange` * `uma2` | | `outcome` | - `success` - `failure` | | `token-type` | * `access-token` * `authorization-code` * `device-code` * `id-token` * `ops` * `permission-ticket` * `refresh-token` | ## Scripting metrics AM exposes the following metrics for monitoring the scripting threadpool: * Scripting metrics * Prometheus scripting metrics | Name | Type | Description | | --------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `scripting.threadpool.max.threads.count.script-context` | Gauge | The maximum number of threads in the pool. | | `scripting.threadpool.min.threads.count.script-context` | Gauge | The minimum number of threads in the pool. | | `scripting.threadpool.max.queue.size.script-context` | Gauge | The maximum number of script executions that can be queued before the pool starts rejecting them. | | `scripting.threadpool.rejected.count.script-context` | Counter | The number of script executions that have been rejected by the pool. | | `scripting.threadpool.threads.count.state.script-context` | Gauge | The number of threads for each of the following [`states`](#state):* `active` Threads that are actively executing scripts in the thread pool. This count indicates the current usage of the thread pool. * `blocked` Threads that are blocked from the thread pool and are currently waiting to execute. This count indicates the scripting engine queue size. | | Name | Type | Description | | ---------------------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `am_scripting_threadpool_max_threads_count{context=script-context,}` | Gauge | The maximum number of threads in the pool. | | `am_scripting_threadpool_min_threads_count{context=script-context,}` | Gauge | The minimum number of threads in the pool. | | `am_scripting_threadpool_max_queue_size{context=script-context,}` | Gauge | The maximum number of script executions that can be queued before the pool starts rejecting them. | | `am_scripting_threadpool_rejected_count{context=script-context,}` | Counter | The number of script executions that have been rejected by the pool. | | `am_scripting_threadpool_threads_count{context=script-context,state=state,}` | Gauge | The number of threads for each of the following [`states`](#state):- `active` Threads that are actively executing scripts in the thread pool. This count indicates the current usage of the thread pool. - `blocked` Threads that are blocked from the thread pool and are currently waiting to execute. This count indicates the scripting engine queue size. | **Scripting 2.0 metrics labels** | Label | Values | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `script-context` | A [supported script context](../am-scripting/manage-scripts-rest.html) value; for example, `AUTHENTICATION_TREE_DECISION_NODE` or `OAUTH2_MAY_ACT`. | | []()`state` | * `active` * `blocked` | ## Session metrics AM exposes the following session-related monitoring metrics: * Session metrics * Prometheus session metrics | Name | Type | Description | | ------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `session.session-type.session-operation.outcome` | Timer | Rate of successful/unsuccessful outcomes for this particular operation type and the time taken to perform this operation. | | `session.session-type.lifetime` | Timer | Rate of session lifetimes. | | `session.authentication-in-memory.store.size` | Gauge | Number of journey sessions stored in the in-memory authentication session store. | | `session.cts-based.cache.eviction` | Summary | Rate of evictions from the session cache. (Summary) | | `session.cts-based.cache.session-outcome` | Summary | Rate of cache hits/misses for the session cache. | | `session.cts-based.cache.size` | Gauge | Number of sessions in the session cache. | | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | The deprecated `/metrics/prometheus` endpoint uses `_total` in metric names. The `/metrics/prometheus/0.0.4` endpoint uses `_sum` in metric names, which conforms with the latest Prometheus version. This table shows only the `/metrics/prometheus/0.0.4` endpoint metrics. | | Name | Type | Description | | -------------------------------------------------------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------- | | `am_session_count{operation=session-operation,outcome=session-outcome,session_type=session-type,}` | Summary | Rate of successful/unsuccessful sessions for idle/max timeout and time taken to perform this operation (count). | | `am_session_cts_based_cache_count{outcome=session-outcome,}` | Summary | Number of cache hits/misses in the session cache (count). | | `am_session_cts_based_cache_eviction_count` | Summary | Rate of evictions from the session cache. | | `am_session_cts_based_cache_eviction_sum` | Summary | Rate of evictions from the session cache (total). | | `am_session_cts_based_cache_size` | Gauge | Number of sessions in the session cache. | | `am_session_cts_based_cache_sum{outcome=session-outcome,}` | Summary | Number of cache hits/misses in the session cache (total). | | `am_session_lifetime_count{session_type=session-type,}` | Summary | Rate of session lifetimes (count). | | `am_session_lifetime_seconds_sum{session_type=session-type,}` | Summary | Lifetime of session, by session type (total). | | `am_session_lifetime_seconds{session_type=session-type,quantile=quantile,}` | Summary | Lifetime of session, by session type. | | `am_session_seconds_sum{operation=session-operation,outcome=outcome,session_type=session-type,}` | Summary | Rate of OAuth 2.0 grant completion by grant type (count). | | `am_session_seconds{operation=session-operation,outcome=outcome,session_type=session-type,quantile=quantile,}` | Summary | Tracks service time for successful/unsuccessful sessions by operation and session type. | | `am_session_store_size{session_type="authentication-in-memory",}` | Gauge | Number of journey sessions stored in the in-memory authentication session store. | | `am_session_sum{operation=session-operation,session_type=session-type,}` | Summary | Rate of successful/unsuccessful sessions for idle/max timeout and time taken to perform this operation (total). | **Session 2.0 metrics labels** | Label | Values | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `operation` | * `check-exists` * `create` * `dereference-restricted-token-id` * `destroy` * `get-matching-sessions` * `get-restricted-token-id` * `get-valid-sessions` * `is-applicable` * `logout` * `refresh` * `register-listener` * `register-pll-listener` * `resolve` * `set-external-property` * `set-property` * `validate` | | `outcome` | - `success` - `failure` | | `` `session-operation `` | * `idle-timeout` * `max-timeout` | | `session-outcome` | - `hit` - `miss` | | `session-type` | * `authentication-client-based` * `authentication-cts-based` * `authentication-in-memory` * `client-based` * `cts-based` |