opensearch-docs-cn/_monitoring-your-cluster/pa/reference.md

layout	title	parent	nav_order	redirect_from
default	Metrics Reference	Performance Analyzer	3	/monitoring-plugins/pa/reference/

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. {: .tip }

Metric	Dimensions	Description
CPU_Utilization	ShardID, IndexName, Operation, ShardRole	CPU usage ratio. CPU time (in milliseconds) used by the associated thread(s) in the past five seconds, divided by 5000 milliseconds.
Paging_MajfltRate		The 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_MinfltRate		The 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_RSS		The 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_Runtime		Time (seconds) spent executing on the CPU per context switch.
Sched_Waittime		Time (seconds) spent waiting on a run queue per context switch.
Sched_CtxRate		Number of times run on the CPU per second in the past five seconds.
Heap_AllocRate		An approximation of the heap memory allocated, in bytes, per second in the past five seconds
IO_ReadThroughput		Number of bytes read per second in the last five seconds.
IO_WriteThroughput		Number of bytes written per second in the last five seconds.
IO_TotThroughput		Number of bytes read or written per second in the last five seconds.
IO_ReadSyscallRate		Read system calls per second in the last five seconds.
IO_WriteSyscallRate		Write system calls per second in the last five seconds.
IO_TotalSyscallRate		Read and write system calls per second in the last five seconds.
Thread_Blocked_Time		Average time (seconds) that the associated thread(s) blocked to enter or reenter a monitor.
Thread_Blocked_Event		The 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_Time		Average time (seconds) that the associated thread(s) waited to enter or reenter a monitor in WAITING or TIMED_WAITING state.
Thread_Waited_Event		The 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).
ShardEvents		The total number of events executed on a shard in the past five seconds.
ShardBulkDocs		The total number of documents indexed in the past five seconds.
Indexing_ThrottleTime	ShardID, IndexName	Time (milliseconds) that the index has been under merge throttling control in the past five seconds.
Cache_Query_Hit		The number of successful lookups in the query cache in the past five seconds.
Cache_Query_Miss		The 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_Size		Query cache memory size in bytes.
Cache_FieldData_Eviction		The 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_Size		Fielddata memory size in bytes.
Cache_Request_Hit		The number of successful lookups in the shard request cache in the past five seconds.
Cache_Request_Miss		The number of lookups in the request cache that failed to retrieve the results of search requests in the past five seconds.
Cache_Request_Eviction		The number of times OpenSearch evicts data from shard request cache (occurs when the request cache is full) in the past five seconds.
Cache_Request_Size		Shard request cache memory size in bytes.
Refresh_Event		The total number of refreshes executed in the past five seconds.
Refresh_Time		The total time (milliseconds) spent executing refreshes in the past five seconds
Flush_Event		The total number of flushes executed in the past five seconds.
Flush_Time		The total time (milliseconds) spent executing flushes in the past five seconds.
Merge_Event		The total number of merges executed in the past five seconds.
Merge_Time		The total time (milliseconds) spent executing merges in the past five seconds.
Merge_CurrentEvent		The current number of merges executing.
Indexing_Buffer		Index buffer memory size in bytes.
Segments_Total		The number of segments.
IndexWriter_Memory		Estimated memory usage by the index writer in bytes.
Bitset_Memory		Estimated memory usage for the cached bit sets in bytes.
VersionMap_Memory		Estimated memory usage of the version map in bytes.
Shard_Size_In_Bytes		Estimated disk usage of the shard in bytes.
Indexing_Pressure_Current_Limits		ShardID, IndexName, IndexingStage	Total 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_Bytes			Total heap size (in bytes) occupied by a shard of an index in a particular indexing stage (Coordinating, Primary or Replica).
Indexing_Pressure_Last_Successful_Timestamp			Timestamp of a request that was successful for a shard of an index in a particular indexing stage (Coordinating, Primary or Replica).
Indexing_Pressure_Rejection_Count			Total rejections performed by OpenSearch for a shard of an index in a particular indexing stage (Coordinating, Primary or Replica).
Indexing_Pressure_Average_Window_Throughput			Average 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).
Latency		Operation, Exception, Indices, HTTPRespCode, ShardID, IndexName, ShardRole	Latency (milliseconds) of a request.
GC_Collection_Event		MemType	The number of garbage collections that have occurred in the past five seconds.
GC_Collection_Time	The approximate accumulated time (milliseconds) of all garbage collections that have occurred in the past five seconds.
Heap_Committed	The amount of memory (bytes) that is committed for the JVM to use.
Heap_Init	The amount of memory (bytes) that the JVM initially requests from the operating system for memory management.
Heap_Max	The maximum amount of memory (bytes) that can be used for memory management.
Heap_Used	The amount of used memory in bytes.
Disk_Utilization	DiskName	Disk utilization rate: percentage of disk time spent reading and writing by the OpenSearch process in the past five seconds.
Disk_WaitTime		Average duration (milliseconds) of read and write operations in the past five seconds.
Disk_ServiceRate		Service rate: MB read or written per second in the past five seconds. This metric assumes that each disk sector stores 512 bytes.
Net_TCP_NumFlows	DestAddr	Number of samples collected. Performance Analyzer collects one sample every five seconds.
Net_TCP_TxQ		Average number of TCP packets in the send buffer.
Net_TCP_RxQ		Average number of TCP packets in the receive buffer.
Net_TCP_Lost		Average 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_SendCWND		Average size (bytes) of the sending congestion window.
Net_TCP_SSThresh		Average size (bytes) of the slow start size threshold.
Net_PacketRate4	Direction	The total number of IPv4 datagrams transmitted/received from/by interfaces per second, including those transmitted or received in error.
Net_PacketDropRate4		The total number of IPv4 datagrams transmitted or received in error per second.
Net_PacketRate6		The total number of IPv6 datagrams transmitted or received from or by interfaces per second, including those transmitted or received in error.
Net_PacketDropRate6		The total number of IPv6 datagrams transmitted or received in error per second.
Net_Throughput		The number of bits transmitted or received per second by all network interfaces.
ThreadPool_QueueSize	ThreadPoolType	The size of the task queue.
ThreadPool_RejectedReqs		The number of rejected executions.
ThreadPool_TotalThreads		The current number of threads in the pool.
ThreadPool_ActiveThreads		The approximate number of threads that are actively executing tasks.
ThreadPool_QueueLatency		The latency of the task queue.
ThreadPool_QueueCapacity		The current capacity of the task queue.
Master_PendingQueueSize	Master_PendingTaskType	The 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_RequestDocs	Operation, Exception, Indices, HTTPRespCode	The number of items in the request (only for `_bulk` request type).
HTTP_TotalRequests		The number of finished requests in the past five seconds.
CB_EstimatedSize	CBType	The current number of estimated bytes.
CB_TrippedEvents		The number of times the circuit breaker has tripped.
CB_ConfiguredSize		The limit (bytes) for how much memory operations can use.
Master_Task_Queue_Time	MasterTaskInsertOrder, MasterTaskPriority, MasterTaskType, MasterTaskMetadata	The time (milliseconds) that a master task spent in the queue.
Master_Task_Run_Time		The time (milliseconds) that a master task has been executed.
Cache_MaxSize	CacheType	The max size of the cache in bytes.
AdmissionControl_RejectionCount (WIP)	ControllerName	Total 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)	NodeID	Number 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/A	Monotonically 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, ShardID	The state of each shard - whether it is STARTED, UNASSIGNED, RELOCATING etc.
LeaderCheck_Latency (WIP)	WIP	WIP
FollowerCheck_Failure (WIP)
LeaderCheck_Failure (WIP)
FollowerCheck_Latency (WIP)

Dimensions reference

Dimension	Return values
ShardID	ID for the shard (e.g. 1).
IndexName	Name of the index (e.g. my-index).
Operation	Type of operation (e.g. shardbulk).
ShardRole	primary, replica
Exception	OpenSearch exceptions (e.g. org.opensearch.index_not_found_exception).
Indices	The list of indices in the request URI.
HTTPRespCode	Response code from OpenSearch (e.g. 200).
MemType	totYoungGC, totFullGC, Survivor, PermGen, OldGen, Eden, NonHeap, Heap
DiskName	Name of the disk (e.g. sda1).
DestAddr	Destination address (e.g. 010015AC).
Direction	in, out
ThreadPoolType	The OpenSearch thread pools (e.g. index, search,snapshot).
CBType	accounting, fielddata, in_flight_requests, parent, request
MasterTaskInsertOrder	The order in which the task was inserted (e.g. 3691).
MasterTaskPriority	Priority of the task (e.g. URGENT). OpenSearch executes higher priority tasks before lower priority ones, regardless of insert_order.
MasterTaskType	shard-started, create-index, delete-index, refresh-mapping, put-mapping, CleanupSnapshotRestoreState, Update snapshot state
MasterTaskMetadata	Metadata for the task (if any).
CacheType	Field_Data_Cache, Shard_Request_Cache, Node_Query_Cache