Prometheus Metrics
Metrics accessed through the Prometheus endpoint are prepended with idm_ and use underscores between words, for example idm_recon_target_phase_seconds. The following table lists the Prometheus metrics available in IDM:
Prometheus Metrics available in IDM
| Prometheus Metric Name | Type | Description |
|---|---|---|
idm_audit{audit_topic=audit-topic} | Summary | Count of all audit events generated of a given topic type. |
idm_field_augmentation{origin-type=edge} | Timer | Rate of reading response objects, to fulfill the _fields requested (when the fields were not populated by the initial repo query). |
idm_field_augmentation{origin-type=vertex} | Timer | Rate of reading response objects, to fulfill the _fields requested (when the fields were not populated by the initial repo query). |
| idm_filter_seconds{action=action,filter_type=filter-type,script_name=script-name} | Timer | Rate at which filter scripts are executed, per action. Monitors scripted filters and delegated admin. |
idm_icf_system-identifier_objectClass_query__queryExpression_seconds | Timer | Rate of ICF query executions with queryExpression, and time taken to perform this operation. |
idm_icf_system-identifier_objectClass_query__queryFilter_seconds | Timer | Rate of ICF query executions with queryFilter, and time taken to perform this operation. |
idm_icf_system-identifier_objectClass_query__queryId_queryId_seconds | Timer | Rate of ICF query executions with queryId, and time taken to perform this operation. |
idm_icf_system-identifier_objectClass_query__UNKNOWN_seconds | Timer | Rate of ICF query executions when the query type is UNKNOWN, and time taken to perform this operation. |
idm_internal_managed-object_relationship_fetch_relationship_fields_seconds | Timer | Rate of fetch operations of relationship fields for internal objects. |
idm_internal_managed-object_relationship_get_relationship_value_for_resource_seconds | Timer | Query rate on relationship values for internal objects. |
idm_internal_managed-object_relationship_validate_relationship_fields_seconds | Timer | Rate of validate operations of relationship fields for internal objects. |
idm_internal_managed-object_script_script-name_seconds | Timer | Rate of script executions on internal objects. |
idm_internal_seconds{managed_object=managed-object,operation=operation>} | Timer | Rate of operations on internal objects. |
idm_managed_field_augmentation_seconds | Timer | Rate of responses requiring field augmentation. When the repository is unable to retrieve all the data in a single call, IDM performs additional read operations to complete (augment) the missing data. |
idm_managed_managed-object_relationship_fetch_relationship_fields_seconds | Timer | Rate of fetches of relationship fields of a managed object. |
idm_managed_managed-object_relationship_get_relationship_value_for_resource_seconds | Timer | Rate of queries to get relationship values for a resource on a managed object. |
idm_managed_managed-object_relationship_validate_relationship_fields_seconds | Timer | Rate of validations of relationship fields of a managed object. |
idm_managed_managed-object_script_script-name_seconds | Timer | Rate of executions of a script on a managed object. |
idm_managed_object_handle_temporal_constraints_on_create | Timer | Latency of enforcing temporal constraints on role objects during object creation. |
idm_managed_object_handle_temporal_constraints_on_delete | Timer | Latency of enforcing temporal constraints on role objects during object deletion. |
idm_managed_object_handle_temporal_constraints_on_update | Timer | Latency of enforcing temporal constraints on role objects during object update. |
idm_managed_relationship_handle_temporal_constraints_on_create | Timer | Latency of enforcing temporal constraints on relationship grants during edge creation. |
idm_managed_relationship_handle_temporal_constraints_on_delete | Timer | Latency of enforcing temporal constraints on relationship grants during edge deletion. |
idm_managed_relationship_handle_temporal_constraints_on_update | Timer | Latency of enforcing temporal constraints on relationship grants during edge update. |
idm_managed_relationship_validate_read_relationship_endpoint_edges_seconds | Timer | Rate of reads on relationship endpoint edges for validation. |
idm_managed_seconds{managed_object=managed-object,operation=operation} | Timer | Rate of operations on a managed object. |
idm_null_array_filter.augmentationrequestType | Timer | Time spent in filter which maps non-nullable, null-valued array fields to an empty array. This filter is traversed for all repo access relating to internal and managed objects. |
idm_recon-assoc-entry_merged-query_merge-results | Timer | Rate of merge operations after source and/or target objects have been retrieved during a merged query of recon association entries. |
idm_recon-assoc-entry_merged-query_page-assoc-entries | Timer | Rate of individual paged recon association entry queries during a merged query. More than one page of entries might be requested to build a single page of merged results. |
idm_recon-assoc-entry_merged-query_query-source | Timer | Rate of source object retrieval via query when merging source objects to recon association entries. |
idm_recon-assoc-entry_merged-query_query-target | Timer | Rate of target object retrieval via query when merging target objects to recon association entries. |
idm_recon_association-persistence{recon-id=reconId,operation=operation} | Timer | The time taken to persist association data. The operation can be source, target, or amendsource, depending on whether data is being produced for a source-phase or target-phase recon association, or to amend the association for a specific source. |
idm_recon_id_queries_phase_seconds | Timer | Rate of executions of the id query phase of a reconciliation, and time taken to perform this operation. |
idm_recon_seconds | Timer | Rate of executions of a full reconciliation, and time taken to perform this operation. |
idm_recon_source_phase_page_seconds | Timer | Rate of pagination executions of the source phase of a reconciliation, and time taken to perform this operation. |
idm_recon_source_phase_seconds | Timer | Rate of executions of the source phase of a reconciliation, and time taken to perform this operation. |
idm_recon_target_phase_seconds | Timer | Rate of executions of the target phase of a reconciliation, and time taken to perform this operation. |
idm_repo_adhoc-expression_relationship_seconds{operation=operation,repo_type=repo-type} | Timer | Rate of filtered queries (using native query expressions) on the relationship table. This metric measures the time spent making the query (in ms), and the number of times the query is invoked. |
idm_repo_adhoc-filter_relationship_seconds{operation=operation,repo_type=repo-type} | Timer | Rate of filtered queries (using the _queryFilter parameter) on the relationship table. This metric measures the time spent making the query (in ms), and the number of times the query is invoked. |
idm_repo_execute_seconds{operation=create_properties,repo_type=repo-type,resource_mapping=resource-mapping} | Timer | Rate of execution time on the JDBC database for the create_properties operations. This operation is performed for every generic object create when it persists the searchable properties. The rate measured here does not include the time taken to obtain a connection to the database from the connection pool. The physical connections to the database have already been established inside the connection pool. |
idm_repo_execute_seconds{operation=operation,repo_type=repo-type,resource_mapping=resource-mapping} | Timer | Rate of execution time on the JDBC database for CRUD operations. This rate does not include the time taken to obtain a connection to the database from the connection pool. The physical connections to the database have already been established inside the connection pool. |
idm_repo_execute_seconds{operation="query",queryType=queryFilter|queryId,repo_type=repo-type,resource_mapping=resource-mapping} | Timer | Rate of execution time on the JDBC database for queries (either queryFilter or queryId). This rate does not include the time taken to obtain a connection to the database from the connection pool. The physical connections to the database have already been established inside the connection pool. |
idm_repo_get_connection_seconds{repo_type=repo-type} | Timer | Rate of retrievals of a repository connection. |
idm_repo_jdbc_cache_objecttypes_count{event="hit|miss",type=resource-mapping | Count | Counts the usage statistics of the objecttypeid cache, which maps an object type to its objecttypeid. The expected count is a small number of misses (sometimes, only one) and the remainder of hits. |
idm_repo_jdbc_relationship_edge_execute_seconds{joinedToVertex=joinedToVertex> | Timer | Time (ms) spent running the Edge->Vertex relationship join query on the database and collecting the result set. |
idm_repo_jdbc_relationship_execute_seconds | Timer | Rate of relationship graph query execution times. |
idm_repo_jdbc_relationship_process_seconds | Timer | Rate of relationship graph query result processing times. |
idm_repo_raw__queryid_credential_queryId_seconds | Timer | Rate of executions of a query with queryId at a repository level, and time taken to perform this operation. |
idm_repo_relationship_count{operation=operation,origin_type=origin_type,repo_type=repo_type,stage=stage} | Timer | Time (ms) spent in the various phases to retrieve relationship expanded data referenced by queried objects. |
idm_repo_relationship_seconds{operation=operation,repo_type=repo-type} | Timer | Rate of CRUDPAQ operations to a repository datasource for a generic/explicit/relationship mapped table. |
idm_repo_seconds{action_name=action-name,command=command,operation=operation,repo_type=repo-type,resource_mapping=resource-mapping} | Timer | Rate of actions to a repository datasource for a generic/explicit mapped table. |
idm_repo_seconds{operation=operation,repo_type=repo-type,resource_mapping=resource-mapping} | Timer | Rate of initiations of a CRUDPAQ operation to a repository datasource. |
idm_router_path-name_action_action-type_seconds | Timer | Rate of actions over the router, and time taken to perform this operation. |
idm_router_path-name_create_seconds | Timer | Rate of creates over the router, and time taken to perform this operation. |
idm_router_path-name_delete_seconds | Timer | Rate of deletes over the router, and time taken to perform this operation. |
idm_router_path-name_patch_seconds | Timer | Rate of patches over the router, and time taken to perform this operation. |
idm_router_path-name_query_queryExpression_seconds | Timer | Rate of queries with queryExpression completed over the router, and time taken to perform this operation. |
idm_router_path-name_query_queryFilter_seconds | Timer | Rate of queries with queryFilter completed over the router, and time taken to perform this operation. |
idm_router_path-name_read_seconds | Timer | Rate of reads over the router, and time taken to perform this operation. |
idm_router_path-name_update_seconds | Timer | Rate of updates over the router, and time taken to perform this operation. |
idm_scheduler_job_store_repo_seconds{operation=operation,scheduler_objectscheduler-object} | Timer | Time spent storing scheduled jobs in the repository. |
idm_scheduler_seconds{operation=operation,type=type} | Timer | Execution rate of scheduler requests. |
idm_script_script-name_request-type | Timer | Rate of calls to a script and time taken to complete. |
idm_selfservice_user_password_reset | Summary | Count of all successful user self-service password resets. |
idm_selfservice_user_registration{provider=provider,reg_type=registration-type} | Summary | Count of all successful user self-service registrations by registration type and provider. |
idm_selfservice_user_registration{reg_type=registration-type} | Summary | Count of all successful user self-service registrations by registration type. |
idm_sync_create_object_seconds | Timer | Rate of requests to create an object on the target, and the time taken to perform this operation. |
idm_sync_delete_target_seconds | Timer | Rate of requests to delete an object on the target, and the time taken to perform this operation. |
idm_sync_objectmapping_seconds{mapping_name=mapping-name} | Timer | Rate of configurations applied to a mapping. |
idm_sync_queue_acquire{mapping_name=mapping-name, action=action} | Timer | Rate of acquisition of queued synchronization events from the queue. |
idm_sync_queue_discard{mapping_name=mapping-name, action=action} | Timer | Rate of deletion of synchronization events from the queue. |
idm_sync_queue_execution{mapping_name=mapping-name, action=action} | Timer | Rate at which queued synchronization operations are executed. |
idm_sync_queue_failed{mapping_name=mapping-name, action=action} | Summary | Number of queued synchronization operations that failed. |
idm_sync_queue_poll_pending_events{mapping_name=mapping-name} | Timer | The latency involved in polling for synchronization events. |
idm_sync_queue_precondition_failed{mapping_name=mapping-name, action=action} | Summary | Number of queued synchronization events that were acquired by another node in the cluster. |
idm_sync_queue_rejected_executions{mapping_name=mapping-name, action=action} | Summary | Number of queued synchronization events that were rejected because the backing thread-pool queue was at full capacity and the thread-pool had already allocated its maximum configured number of threads. |
idm_sync_queue_release_for_retry{mapping_name=mapping-name, action=action} | Timer | Times the release of queued synchronization events after a failure and before exceeding the retry count. |
idm_sync_queue_release{mapping_name=mapping-name, action=action} | Timer | Rate at which queued synchronization events are released. |
idm_sync_queue_submit{mapping_name=mapping-name, action=action} | Timer | Rate of insertion of synchronization events into the queue. |
idm_sync_raw_read_object_seconds | Timer | Rate of reads of an object. |
idm_sync_source_assess_situation_seconds | Timer | Rate of assessments of a synchronization situation. |
idm_sync_source_correlate_target_seconds | Timer | Rate of correlations between a target and a given source, and time taken to perform this operation. |
idm_sync_source_determine_action_seconds | Timer | Rate of determinations done on a synchronization action based on its current situation. |
idm_sync_source_perform_action_seconds | Timer | Rate of completions of an action performed on a synchronization operation. |
idm_sync_target_assess_situation_seconds | Timer | Rate of assessments of a target situation. |
idm_sync_target_determine_action_seconds | Timer | Rate of determinations done on a target action based on its current situation. |
idm_sync_target_perform_action_seconds | Timer | Rate of completions of an action performed on a target sync operation. |
idm_sync_update_target_seconds | Timer | Rate of requests to update an object on the target, and the time taken to perform this operation. |
idm_user_login{user_type=user-type} | Summary | Count of all successful logins by user type. |
idm_user_login_total{provider=provider,user_type=user-type} | Summary | Count of all successful logins by user type and provider. |
idm_virtual_properties_from_relationships{virtual_properties=calculated-virtual-properties, traversal_depthX=traversal-origin-resource-collection and traversal relationship,not_found} | Summary | Number of 404 responses encountered when querying the resource_collection/relationship_field specified in the traversal_depthX tag for the most recent X. X corresponds to the relationship field sequence. |
idm_virtual_properties_from_relationships{virtual_properties=calculated-virtual-properties, traversal_depthX=traversal-origin-resource-collection and traversal relationship,unsatisfied_temp_constraint} | Summary | Number of edges skipped due to an unsatisfied temporal constraint on either the edge or the referred-to vertex. Encountered when querying the resource collection and relationship field at the traversal_depthX tag for the most recent X. X corresponds to the relationship field sequence. |
idm_virtual_properties_from_relationships{virtual_properties=calculated-virtual-properties, traversal_depthX=traversal-origin-resource-collection and traversal relationship} | Timer | Time spent traversing relationship fields to calculate the specified virtual properties. The managed objects linked to by the traversal relationship fields define a tree, whose root is the virtual property host. This object tree is traversed depth-first, with the traversal_depthX corresponding to the latency involved with each relationship traversal. Traversal_depth0 corresponds to the first relationship field traversed. Because the tree is traversed depth-first, traversal_depthX will subsume all of the traversal latencies for all traversal_depth Y, where Y>X. X corresponds to the relationship field sequence. |