Information exposed by the metrics API
After you configure access to the metrics API, you can use Prometheus to retrieve metrics for ArcGIS Enterprise components and the machines where those components are running. The following tables summarize the available metrics and labels, which you can use in PromQL queries and result filters to access the information you need.
Metrics with the suffix of _created reflect the Unix time (seconds) of histograms and summaries from when the corresponding metric was first collected. This value provides insight into the life cycle of a metric. These metrics are not included in the tables below.
Static system metadata
System metadata is reported for Portal for ArcGIS, ArcGIS Server, and relational store.
| Name | Description | Type | Labels |
|---|---|---|---|
| about_information | OS, arcgis, and infrastructure information | Gauge | componentName, id, nodeName, osBuild, osVersion, cpuInfo, cpuLogicalProcessor, memoryPhysicalTotalGB, arcgisVersion, arcgisBuild |
Dynamic system metrics
System metrics are reported for Portal for ArcGIS, ArcGIS Server, and relational store.
| Name | Description | Type | Labels |
|---|---|---|---|
| cpu_percent | CPU percent | gauge | componentName, id, nodeName |
| disk_capacity_GB | Disk storage capacity in GB | gauge | componentName, id, nodeName, diskMount, diskModel, diskType |
| disk_free_GB | Disk free space in GB | gauge | componentName, id, nodeName, diskMount, diskModel, diskType |
| disk_queue_length | The current disk queue length | gauge | componentName, id, nodeName, diskName, diskModel |
| disk_read_bytes_total | The current number of bytes read from disk | counter | componentName, id, nodeName, diskName, diskModel |
| disk_reads_total | The current number of disk reads | counter | componentName, id, nodeName, diskName, diskModel |
| disk_write_bytes_total | The current number of bytes written to disk | counter | componentName, id, nodeName, diskName, diskModel |
| disk_writes_total | The current number of disk writes | counter | componentName, id, nodeName, diskName, diskModel |
| memory_available_GB | The amount of physical memory currently available, in GB | gauge | componentName, id, nodeName |
| memory_committed_GB | The memory currently committed, in GB. This is generally equal to the sum of the bytes used of physical memory and paging/swap files | gauge | componentName, id, nodeName |
| memory_committed_limit_GB | The maximum memory that can be committed by the system without extending the paging files, in GB. This is generally equal to the sum of the sizes of physical memory and paging/swap files | gauge | componentName, id, nodeName |
| processes_cpu_percent | Process cpu percent | gauge | componentName, id, nodeName, processId, processName |
| processes_memory_MB | Process resident memory in MB | gauge | componentName, id, nodeName, processId, processName |
| processes_running | Current total number of processes running | gauge | componentName, id, nodeName |
| system_boot_time_seconds | Number of seconds since boot | gauge | componentName, id, nodeName |
| system_threads | Current number of system threads | gauge | componentName, id, nodeName |
Service metrics
Service metrics are reported for each service published to an ArcGIS Server site.
| Name | Description | Type | Labels |
|---|---|---|---|
| requests_failed_total | Number of failed requests | counter | componentName, id, nodeName, appType, folderName, serviceName, serviceType, operation, responseCached, username, instancePool |
| requests_response_time_seconds_bucket | Cumulative number of observed requests completed in less than or equal to the bucket's upper bound, in seconds | histogram | componentName, id, nodeName, appType, folderName, serviceName, serviceType, operation, responseCached, le, instancePool |
| requests_response_time_seconds_count | Total number of observed requests across all buckets | histogram | componentName, id, nodeName, appType, folderName, serviceName, serviceType, operation, responseCached, instancePool |
| requests_response_time_seconds_sum | Cumulative response time of all observed requests, in seconds | histogram | componentName, id, nodeName, appType, folderName, serviceName, serviceType, operation, responseCached, instancePool |
| requests_response_time_seconds_counter_total | Sum of response time of requests in seconds | counter | componentName, id, nodeName, appType, folderName, serviceName, serviceType, operation, responseCached, username, instancePool |
| requests_succeeded_total | Number of succeeded requests | counter | componentName, id, nodeName, appType, folderName, serviceName, serviceType, operation, responseCached, instancePool |
| requests_total | Number of requests | counter | componentName, id, nodeName, appType, folderName, serviceName, serviceType, operation, responseCached, username, instancePool |
Organization metrics
| Name | Description | Type | Labels |
|---|---|---|---|
| items_added_total | Total number of items added | counter | componentName, id, nodeName |
| items_count | Total number of items | gauge | componentName, id, nodeName |
| items_deleted_total | Total number of items deleted | counter | componentName, id, nodeName |
| items_updated_total | Total number of items updated | counter | componentName, id, nodeName |
| items_viewed_total | Total number of all viewed items | counter | componentName, id, nodeName |
| users_added_total | Total number of users added | counter | componentName, id, nodeName |
| users_count | Total number of users | gauge | componentName, id, nodeName |
| users_login_total | Total number of user logins | counter | componentName, id, nodeName |
| users_logout_total | Total number of user logouts | counter | componentName, id, nodeName |
Note:
The items_count metric does not include Esri content items, such as Living Atlas content.
Relational store metrics
| Name | Description | Type | Labels |
|---|---|---|---|
| active_connections | Number of active connections to relational store | gauge | db_name, max_connections |
| relational_store_is_healthy | Relational store health | gauge | db_name, overallhealth |
| relational_store_read_only_mode | Relational store is in read only mode | gauge | db_name, read_only_mode |
| relational_store_replication_lag_time | Replication lag time of secondary machine from primary in minutes | gauge | db_name |
| relational_store_role | Relational store role | gauge | db_name, role |
| relational_store_row_count | Number of rows in a table | gauge | db_name, table |
| relational_store_status | Relational store status | gauge | db_name, status |
| relational_table_size | Size of relational table in MB | gauge | db_name, table |
Note:
System tables are excluded when reporting the size and row count of the largest tables.
Label descriptions
| Label name | Description |
|---|---|
| appType | The type of application making the request. |
| arcgisBuild | The build number of the ArcGIS component. |
| arcgisVersion | The version of the ArcGIS component. |
| componentName | The name of the component, such as ArcGIS Portal, ArcGIS Server, ArcGIS Data Store. |
| cpuInfo | The description of the processors for the machine where the ArcGIS component is running. |
| cpuLogicalProcessor | The number of logical processors for the machine where the ArcGIS component is running. |
| db_name | The database name for metrics related to ArcGIS Data Store. |
| diskModel | The model name for the disk. |
| diskMount | The name assigned to the disk mount, such as C:\ or /opt. |
| diskName | The OS name assigned to the disk. |
| diskType | The file system type. |
| folderName | The name of the folder where the service is created. |
| id | Unique identifier for the ArcGIS component. |
| le | The upper bound of a bucket in a histogram metric |
| max_connections | The maximum number of connections permitted to the data store |
| memoryPhysicalTotalGB | The total amount of RAM for the machine where the ArcGIS component is running. |
| nodeName | The name of the machine with the service handling the request. |
| operation | The requested operation, for example, a query or export. Operation information is only available for REST requests. SOAP requests only return a value of soap. |
| osBuild | The build number of the OS (operating system). |
| osVersion | The version of the OS (operating system). |
| overallhealth | Indicator if the relational store is healthy. |
| processId | The OS assigned process ID. |
| processName | The name of the running process. |
| read_only_mode | Boolean indicator if the relational store is in read only mode. |
| responseCached | Boolean indicator if the response was served from the cache. |
| role | The role for the ArcGIS Data Store relational database, either Primary or Standby. |
| serviceName | The name of the service, including the folder name in which the service resides. |
| serviceType | The type of service, for example, a MapService or FeatureService. |
| status | The status for the relational store, either started or stopped. |
| table | The name of the table for the relational store row count. |
| username | The username of the user making the request. |