This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Metrics reference

This page contains all Performance Analyzer metrics. All metrics support the avg, sum, min, and max aggregations, although certain metrics measure only one thing, making the choice of aggregation irrelevant.

For information on dimensions, see the dimensions reference.

This list is extensive. We recommend using Ctrl/Cmd + F to find what you’re looking for.

MetricDimensionsDescription
CPU_UtilizationShardID, IndexName, Operation, ShardRoleCPU usage ratio. CPU time (in milliseconds) used by the associated thread(s) in the past five seconds, divided by 5000 milliseconds.
Paging_MajfltRateThe number of major faults per second in the past five seconds. A major fault requires the process to load a memory page from disk.
Paging_MinfltRateThe number of minor faults per second in the past five seconds. A minor fault does not requires the process to load a memory page from disk.
Paging_RSSThe number of pages the process has in real memory—-the pages that count towards text, data, or stack space. This number does not include pages that have not been demand-loaded in or swapped out.
Sched_RuntimeTime (seconds) spent executing on the CPU per context switch.
Sched_WaittimeTime (seconds) spent waiting on a run queue per context switch.
Sched_CtxRateNumber of times run on the CPU per second in the past five seconds.
Heap_AllocRateAn approximation of the heap memory allocated, in bytes, per second in the past five seconds
IO_ReadThroughputNumber of bytes read per second in the last five seconds.
IO_WriteThroughputNumber of bytes written per second in the last five seconds.
IO_TotThroughputNumber of bytes read or written per second in the last five seconds.
IO_ReadSyscallRateRead system calls per second in the last five seconds.
IO_WriteSyscallRateWrite system calls per second in the last five seconds.
IO_TotalSyscallRateRead and write system calls per second in the last five seconds.
Thread_Blocked_TimeAverage time (seconds) that the associated thread(s) blocked to enter or reenter a monitor.
Thread_Blocked_EventThe total number of times that the associated thread(s) blocked to enter or reenter a monitor (i.e. the number of times a thread has been in the blocked state).
Thread_Waited_TimeAverage time (seconds) that the associated thread(s) waited to enter or reenter a monitor in WAITING or TIMED_WAITING state.
Thread_Waited_EventThe total number of times that the associated thread(s) waited to enter or reenter a monitor (i.e. the number of times a thread has been in the WAITING or TIMED_WAITING state).
ShardEventsThe total number of events executed on a shard in the past five seconds.
ShardBulkDocsThe total number of documents indexed in the past five seconds.
Indexing_ThrottleTimeShardID, IndexNameTime (milliseconds) that the index has been under merge throttling control in the past five seconds.
Cache_Query_HitThe number of successful lookups in the query cache in the past five seconds.
Cache_Query_MissThe number of lookups in the query cache that failed to retrieve a DocIdSet in the past five seconds. DocIdSet is a set of document IDs in Lucene.
Cache_Query_SizeQuery cache memory size in bytes.
Cache_FieldData_EvictionThe number of times OpenSearch has evicted data from the fielddata heap space (occurs when the heap space is full) in the past five seconds.
Cache_FieldData_SizeFielddata memory size in bytes.
Cache_Request_HitThe number of successful lookups in the shard request cache in the past five seconds.
Cache_Request_MissThe number of lookups in the request cache that failed to retrieve the results of search requests in the past five seconds.
Cache_Request_EvictionThe number of times OpenSearch evicts data from shard request cache (occurs when the request cache is full) in the past five seconds.
Cache_Request_SizeShard request cache memory size in bytes.
Refresh_EventThe total number of refreshes executed in the past five seconds.
Refresh_TimeThe total time (milliseconds) spent executing refreshes in the past five seconds
Flush_EventThe total number of flushes executed in the past five seconds.
Flush_TimeThe total time (milliseconds) spent executing flushes in the past five seconds.
Merge_EventThe total number of merges executed in the past five seconds.
Merge_TimeThe total time (milliseconds) spent executing merges in the past five seconds.
Merge_CurrentEventThe current number of merges executing.
Indexing_BufferIndex buffer memory size in bytes.
Segments_TotalThe number of segments.
IndexWriter_MemoryEstimated memory usage by the index writer in bytes.
Bitset_MemoryEstimated memory usage for the cached bit sets in bytes.
VersionMap_MemoryEstimated memory usage of the version map in bytes.
Shard_Size_In_BytesEstimated disk usage of the shard in bytes.
Indexing_Pressure_Current_LimitsShardID, IndexName, IndexingStageTotal heap size (in bytes) that is available for utilization by a shard of an index in a particular indexing stage (Coordinating, Primary or Replica).
Indexing_Pressure_Current_BytesTotal heap size (in bytes) occupied by a shard of an index in a particular indexing stage (Coordinating, Primary or Replica).
Indexing_Pressure_Last_Successful_TimestampTimestamp of a request that was successful for a shard of an index in a particular indexing stage (Coordinating, Primary or Replica).
Indexing_Pressure_Rejection_CountTotal rejections performed by OpenSearch for a shard of an index in a particular indexing stage (Coordinating, Primary or Replica).
Indexing_Pressure_Average_Window_ThroughputAverage throughput of the last n requests (The value of n is determined by shard_indexing_pressure.secondary_parameter.throughput.request_size_window setting) for a shard of an index in a particular indexing stage (Coordinating, Primary or Replica).
LatencyOperation, Exception, Indices, HTTPRespCode, ShardID, IndexName, ShardRoleLatency (milliseconds) of a request.
GC_Collection_EventMemTypeThe number of garbage collections that have occurred in the past five seconds.
GC_Collection_TimeThe approximate accumulated time (milliseconds) of all garbage collections that have occurred in the past five seconds.
Heap_CommittedThe amount of memory (bytes) that is committed for the JVM to use.
Heap_InitThe amount of memory (bytes) that the JVM initially requests from the operating system for memory management.
Heap_MaxThe maximum amount of memory (bytes) that can be used for memory management.
Heap_UsedThe amount of used memory in bytes.
Disk_UtilizationDiskNameDisk utilization rate: percentage of disk time spent reading and writing by the OpenSearch process in the past five seconds.
Disk_WaitTimeAverage duration (milliseconds) of read and write operations in the past five seconds.
Disk_ServiceRateService rate: MB read or written per second in the past five seconds. This metric assumes that each disk sector stores 512 bytes.
Net_TCP_NumFlowsDestAddrNumber of samples collected. Performance Analyzer collects one sample every five seconds.
Net_TCP_TxQAverage number of TCP packets in the send buffer.
Net_TCP_RxQAverage number of TCP packets in the receive buffer.
Net_TCP_LostAverage number of unrecovered recurring timeouts. This number is reset when the recovery finishes or SND.UNA is advanced. SND.UNA is the sequence number of the first byte of data that has been sent, but not yet acknowledged.
Net_TCP_SendCWNDAverage size (bytes) of the sending congestion window.
Net_TCP_SSThreshAverage size (bytes) of the slow start size threshold.
Net_PacketRate4DirectionThe total number of IPv4 datagrams transmitted/received from/by interfaces per second, including those transmitted or received in error.
Net_PacketDropRate4The total number of IPv4 datagrams transmitted or received in error per second.
Net_PacketRate6The total number of IPv6 datagrams transmitted or received from or by interfaces per second, including those transmitted or received in error.
Net_PacketDropRate6The total number of IPv6 datagrams transmitted or received in error per second.
Net_ThroughputThe number of bits transmitted or received per second by all network interfaces.
ThreadPool_QueueSizeThreadPoolTypeThe size of the task queue.
ThreadPool_RejectedReqsThe number of rejected executions.
ThreadPool_TotalThreadsThe current number of threads in the pool.
ThreadPool_ActiveThreadsThe approximate number of threads that are actively executing tasks.
ThreadPool_QueueLatencyThe latency of the task queue.
ThreadPool_QueueCapacityThe current capacity of the task queue.
Master_PendingQueueSizeMaster_PendingTaskTypeThe current number of pending tasks in the cluster state update thread. Each node has a cluster state update thread that submits cluster state update tasks (create index, update mapping, allocate shard, fail shard, etc.).
HTTP_RequestDocsOperation, Exception, Indices, HTTPRespCodeThe number of items in the request (only for _bulk request type).
HTTP_TotalRequestsThe number of finished requests in the past five seconds.
CB_EstimatedSizeCBTypeThe current number of estimated bytes.
CB_TrippedEventsThe number of times the circuit breaker has tripped.
CB_ConfiguredSizeThe limit (bytes) for how much memory operations can use.
Master_Task_Queue_TimeMasterTaskInsertOrder, MasterTaskPriority, MasterTaskType, MasterTaskMetadataThe time (milliseconds) that a master task spent in the queue.
Master_Task_Run_TimeThe time (milliseconds) that a master task has been executed.
Cache_MaxSizeCacheTypeThe max size of the cache in bytes.
AdmissionControl_RejectionCount (WIP)ControllerNameTotal rejections performed by a Controller of Admission Control.
AdmissionControl_CurrentValue (WIP)Current value for Controller of Admission Control.
AdmissionControl_ThresholdValue (WIP)Threshold value for Controller of Admission Control.
Data_RetryingPendingTasksCount (WIP)NodeIDNumber of throttled pending tasks on which data node is actively performing retries. It will be an absolute metric at that point of time.
Master_ThrottledPendingTasksCount (WIP)Sum of total pending tasks which got throttled by node (master node). It is a cumulative metric so look at the max aggregation.
Election_Term (WIP)N/AMonotonically increasing number with every master election.
PublishClusterState_Latency (WIP)The time taken by quorum of nodes to publish new cluster state. This metric is available for current master.
PublishClusterState_Failure (WIP)The number of times publish new cluster state action failed on master node.
ClusterApplierService_Latency (WIP)The time taken by each node to apply cluster state sent by master.
ClusterApplierService_Failure (WIP)The number of times apply cluster state action failed on each node.
Shard_State (WIP)IndexName, NodeName, ShardType, ShardIDThe state of each shard - whether it is STARTED, UNASSIGNED, RELOCATING etc.
LeaderCheck_Latency (WIP)WIPWIP
FollowerCheck_Failure (WIP)
LeaderCheck_Failure (WIP)
FollowerCheck_Latency (WIP)

Dimensions reference

DimensionReturn values
ShardIDID for the shard (e.g. 1).
IndexNameName of the index (e.g. my-index).
OperationType of operation (e.g. shardbulk).
ShardRoleprimary, replica
ExceptionOpenSearch exceptions (e.g. org.opensearch.index_not_found_exception).
IndicesThe list of indices in the request URI.
HTTPRespCodeResponse code from OpenSearch (e.g. 200).
MemTypetotYoungGC, totFullGC, Survivor, PermGen, OldGen, Eden, NonHeap, Heap
DiskNameName of the disk (e.g. sda1).
DestAddrDestination address (e.g. 010015AC).
Directionin, out
ThreadPoolTypeThe OpenSearch thread pools (e.g. index, search,snapshot).
CBTypeaccounting, fielddata, in_flight_requests, parent, request
MasterTaskInsertOrderThe order in which the task was inserted (e.g. 3691).
MasterTaskPriorityPriority of the task (e.g. URGENT). OpenSearch executes higher priority tasks before lower priority ones, regardless of insert_order.
MasterTaskTypeshard-started, create-index, delete-index, refresh-mapping, put-mapping, CleanupSnapshotRestoreState, Update snapshot state
MasterTaskMetadataMetadata for the task (if any).
CacheTypeField_Data_Cache, Shard_Request_Cache, Node_Query_Cache