OpenSearch Discovery
This document describes the OpenSearch functionality of PandoraFMS discovery.
- Introduction
- Prerrequisites
- Parameters
- Manual execution
- Discovery
- Agent and modules generated by the plugin
Introduction
This OpenSearch discovery plugin for Pandora FMS is designed to automate the monitoring of an OpenSearch environment. Instead of creating a single monolithic agent, it segments monitoring based on the functional role of each component (Cluster, Node, Shard).
Prerrequisites
- The plugin is a compilation containing all the dependencies necessary for its use and requires an access token, username, and password with read permissions on the OpenSearch cluster API.
Parameters
--as_server_plugin default false, if enabled, it will print 1 on the console if the creation of agents and modules was successful and 0 if there was an error.
Configuration file (--conf)
open_search_ip = opensearch server IP. (required)
open_search_port = specific port. (required)
user = username. (required)
password = server password. (required)
verify_ssl = to verify if the URL has an https certificate. (required)
verify_certs = used to authenticate and encrypt communication between your client and the OpenSearch cluster. (required)
transfer_mode= transfer mode name. (required)
tentacle_ip= tentacle IP. (required)
tentacle_port= tentacle port. (required)
agent_prefix = prefix name for agents. (optional)
agents_group = group name for agents. (optional)
module_prefix = prefix name for modules. (optional)
module_group = group name for modules. (optional)
token_primary_metrics = enables obtaining primary shard metrics (required)
exclude_primary_metrics = Excludes metrics from modules separated by commas or line by line, as many targets as you need. (optional)
token_nodes_metrics = Enables obtaining node metrics (required)
exclude_nodes_metrics = Excludes module metrics separated by commas or line by line, as many targets as you need. (optional)
token_cluster_metrics = Enable to obtain cluster metrics (required)
exclude_cluster_metrics = Exclude module metrics separated by commas or line by line, as many targets as you need. (optional)
interval = inteval in second (optional)Example
open_search_ip = 192.168.0.1
open_search_port = 9200
user = user
password = examplepass
verify_ssl = true
verify_certs = false
transfer_mode=tentacle
tentacle_ip=127.0.0.1
tentacle_port=41121
agent_prefix = allnodes
module_prefix = modules
module_group = server
token_primary_metrics = 0
exclude_primary_metrics =
token_nodes_metrics = 0
exclude_nodes_metrics =
token_cluster_metrics = 1
exclude_cluster_metrics = unassigned, active
interval = 300Manual execution
The plugin execution format is as follows:
./pandora_opensearch --as_server_plugin <1 if you want to use it> --conf <path to configuration file>Examples:
To run server mode:
./pandora_opensearch --as_server_plugin 1 --conf /etc/file.conf
To run advanced mode
./pandora_opensearch --conf /etc/file.conf
The execution will return output in JSON format with information about the execution, including the total number of agents and modules created. It will also generate an XML file for each monitored agent, which will be sent to the Pandora FMS server via tentacle.
Discovery
This plugin can be integrated with Pandora FMS Discovery.
To do so, you must load the “.disco” package that you can download from the Pandora FMS library:
https://marketplace.pandorafms.com/entries/pandorafms.opensearch
Once loaded, opensearch environments can be monitored by creating Discovery tasks from the Management > Discovery > Applications > Opensearch
The following minimum information will be requested for each task:
OpenSearch IP = opensearch server IP. (required)
OpenSearch Port = specific port. (required)
User = username. (required)
Password = server password. (required)
Verify SSL = to verify if the URL has an https certificate. Active by default
Verify Certs = used to authenticate and encrypt communication between your client and the OpenSearch cluster. Inactive by default.
transfer_mode = name of the transfer mode. (required)
tentacle_ip = IP address of the tentacle. (required)
tentacle_port = port of the tentacle. (required)
On the next page, we will be asked for the following:
agent prefix = prefix name for agents. (optional)
agents group = group name for agents. (optional)
custom module prefix = prefix name for modules. (optional)
module group = group name for modules. (optional)
Primary metrics = Enables obtaining primary shard metrics (required), active by default.
Exclude primary metrics = Excludes module metrics separated by commas or line by line, as many targets as you need. (optional)
Nodes metrics = Enables obtaining node metrics (required), active by default
Exclude node metrics = Excludes module metrics separated by commas or line by line, as many targets as you need. (optional)
Cluster metrics = Enables obtaining cluster metrics (required), active by default.
Exclude cluster metrics = Excludes module metrics separated by commas or line by line, as many targets as you need. (optional)
Successfully completed tasks will have an execution summary with the following information:
- Total agents: Total number of agents generated by the task.
- Total modules: Total number of modules generated by the task.
Agent and modules generated by the plugin
The plugin will create an agent for each target database. That agent will contain the following modules:
If enabled Primary metrics:
primaries_completion_size_in_bytes Statistics about completions for all shards in The node.
primaries_docs_count = The number of documents reported by Lucene. Excludes deleted.
primaries_docs_deleted = The number of deleted documents reported by Lucene. Excludes.
primaries_fielddata_evictions = The number of evictions in The field data cache.
primaries_fielddata_memory_size_in_bytes = The total amount of memory used for The field data cache for.
primaries_flush_periodic = The total number of periodic flush operations.
primaries_flush_total = The total number of flush operations.
primaries_flush_total_time = The total time for all flush operations, in milliseconds.
primaries_get_current = The number of get operations that are currently running.
primaries_get_exists_time = The total time for all successful get operations, in millise.
primaries_get_exists_total = The total number of successful get operations.
primaries_get_missing_time = The total time for all failed get operations, in millisecond.
primaries_get_missing_total = The number of failed get operations.
primaries_get_time = The total time for all get operations, in milliseconds.
primaries_get_total = The total number of get operations.
primaries_indexing_current = The number of indexing operations that are currently running.
primaries_indexing_delete_current = The number of deletion operations that are currently running.
primaries_indexing_delete_time = The total time for all deletion operations, in milliseconds.
primaries_indexing_delete_total = The total number of deletions.
primaries_indexing_failed = The number of indexing operations that have failed.
primaries_indexing_index_total = The total number of indexing operations on The node.
primaries_indexing_noop_update_total = The total number of noop operations.
primaries_indexing_throttle_time = The total time for throttling operations, in milliseconds.
primaries_indexing_time = The total time for all indexing operations, in milliseconds.
primaries_merges_current = The number of merge operations that are currently running.
primaries_merges_current_docs = The number of document merges that are currently running.
primaries_merges_current_size_in_bytes = The memory size, in bytes, that is used to perform current m.
primaries_merges_total = The total number of merge operations.
primaries_merges_total_auto_throttle_in_bytes = The total size of automatically throttled merge operations, .
primaries_merges_total_docs = The total number of documents that have been merged.
primaries_merges_total_size_in_bytes = The total size of all merged documents, in bytes.
primaries_merges_total_stopped_time = The total time spent on stopping merge operations, in millis.
primaries_merges_total_throttled_time = The total time spent on throttling merge operations, in mill.
primaries_merges_total_time = The total time for merges, in milliseconds.
primaries_query_cache_cache_count = The total number of queries that have been added to The quer.
primaries_query_cache_cache_size = The number of queries currently in The query cache.
primaries_query_cache_evictions = The number of evictions from The query cache.
primaries_query_cache_hit_count = The total number of hits in The query cache.
primaries_query_cache_memory_size_in_bytes = The amount of memory used for The query cache for all shards.
primaries_query_cache_miss_count = The total number of misses in The query cache.
primaries_query_cache_total_count = The total number of hits and misses in the query cache.
primaries_recovery_current_as_source = The number of recovery operations that have used an index sh.
primaries_recovery_current_as_target = The number of recovery operations that have used an index sh.
primaries_recovery_throttle_time = The delay of recovery operations due to throttling, in milli.
primaries_refresh_external_total = The total number of external refresh operations.
primaries_refresh_external_total_time = The total time for all external refresh operations, in milli.
primaries_refresh_listeners = The number of refresh listeners.
primaries_refresh_total = The total number of refresh operations.
primaries_refresh_total_time = The total time for all refresh operations, in milliseconds.
primaries_request_cache_evictions = The number of request cache evictions.
primaries_request_cache_hit_count = The number of request cache hits.
primaries_request_cache_memory_size_in_bytes = The memory size used by The request cache, in bytes.
primaries_request_cache_miss_count = The number of request cache misses.
primaries_search_concurrent_avg_slice_count = The average slice count of all search requests. This is comp.
primaries_search_concurrent_query_current = The number of currently running query operations that use co.
primaries_search_concurrent_query_time = The total amount of time taken by all query operations that .
primaries_search_concurrent_query_total = The total number of query operations that use concurrent seg.
primaries_search_fetch_current = The number of shard fetch operations that are currently runn.
primaries_search_fetch_time = The total amount of time for all shard fetch operations, in .
primaries_search_fetch_total = The total number of shard fetch operations.
primaries_search_open_contexts = The number of open search contexts.
primaries_search_point_time_current = The number of shard PIT contexts currently open.
primaries_search_point_time_time = The amount of time that shard PIT contexts have been held op.
primaries_search_point_time_total = The total number of shard Point in Time (PIT) contexts that .
primaries_search_query_current = The number of shard query operations that are currently runn.
primaries_search_query_time = The total amount of time for all shard query operations, in .
primaries_search_query_total = The total number of shard query operations.
primaries_search_scroll_current = The number of shard scroll operations that are currently run.
primaries_search_scroll_total = The total number of shard scroll operations.
primaries_search_scroll.time = The total amount of time for all shard scroll operations, in.
primaries_search_search_idl…_reactivate_count_total The total number of times that all shards have been activate.
primaries_search_suggest_current = The number of shard suggest operations that are currently ru.
primaries_search_suggest_time = The total amount of time for all shard suggest operations, i.
primaries_search_suggest_total = The total number of shard suggest operations.
primaries_segments_count = The total number of segments.
primaries_segments_doc_values_memory_in_bytes = The total amount of memory used for doc values, in bytes.
primaries_segments_fixed_bit_set_memory_in_bytes = The total amount of memory used by fixed bit sets, in bytes
primaries_segments_index_writer_memory_in_bytes = The total amount of memory used by all index writers, in byt.
primaries_segments_max_unsafe_auto_id_timestamp = The timestamp for The most recently retired indexing request.
primaries_segments_memory_in_bytes = The total amount of memory, in bytes.
primaries_segments_norms_memory_in_bytes = The total amount of memory used for term vectors, in bytes.
primaries_segments_points_memory_in_bytes = The total amount of memory used for normalization factors, i.
primaries_segments_stored_fields_memory_in_bytes = The total amount of memory used for stored fields, in bytes.
primaries_segments_term_vectors_memory_in_bytes = The memory used by term vectors, in bytes.
primaries_segments_terms_memory_in_bytes = The total amount of memory used for terms, in bytes.
primaries_segments_version_map_memory_in_bytes = The total amount of memory used by all version maps, in byte.
primaries_store_reserved_in_bytes = The predicted number of bytes The shard store will grow to b.
primaries_store_size_in_bytes Total size of all shards on The node.
primaries_translog_earliest_last_modified_age The earliest last modified age for The translog.
primaries_translog_operations = The number of translog operations.
primaries_translog_size_in_bytes = The size of The translog, in bytes.
primaries_translog_uncommitted_operations = The number of uncommitted translog operations.
primaries_translog_uncommitted_size_in_bytes = The size of uncommitted translog operations, in bytes.
primaries_warmer_current = The number of current index warming operations.
primaries_warmer_total = The total number of index warming operations.
primaries_warmer_total_time = The total time for all index warming operations, in millisec.
total_completion_size_in_bytes Statistics about completions for all shards in The node.
total_docs_count = The number of documents reported by Lucene. Excludes deleted.
total_docs_deleted = The number of deleted documents reported by Lucene. Excludes.
total_fielddata_evictions = The number of evictions in The field data cache.
total_fielddata_memory_size_in_bytes = The total amount of memory used for The field data cache for.
total_flush_periodic = The total number of periodic flush operations.
total_flush_total = The total number of flush operations.
total_flush_total_time = The total time for all flush operations, in milliseconds.
total_get_current = The number of get operations that are currently running.
total_get_exists_time = The total time for all successful get operations, in millise.
total_get_exists_total = The total number of successful get operations.
total_get_missing_time = The total time for all failed get operations, in millisecond.
total_get_missing_total = The number of failed get operations.
total_get_time = The total time for all get operations, in milliseconds.
total_get_total = The total number of get operations.
total_indexing_current = The number of indexing operations that are currently running.
total_indexing_delete_current = The number of deletion operations that are currently running.
total_indexing_delete_time = The total time for all deletion operations, in milliseconds.
total_indexing_delete_total = The total number of deletions.
total_indexing_failed = The number of indexing operations that have failed.
total_indexing_index_total = The total number of indexing operations on The node.
total_indexing_noop_update_total = The total number of noop operations.
total_indexing_throttle_time = The total time for throttling operations, in milliseconds.
total_indexing_time = The total time for all indexing operations, in milliseconds.
total_merges_current = The number of merge operations that are currently running.
total_merges_current_docs = The number of document merges that are currently running.
total_merges_current_size_in_bytes = The memory size, in bytes, that is used to perform current m.
total_merges_total = The total number of merge operations.
total_merges_total_auto_throttle_in_bytes = The total size of automatically throttled merge operations, .
total_merges_total_docs = The total number of documents that have been merged.
total_merges_total_size_in_bytes = The total size of all merged documents, in bytes.
total_merges_total_stopped_time = The total time spent on stopping merge operations, in millis.
total_merges_total_throttled_time = The total time spent on throttling merge operations, in mill.
total_merges_total_time = The total time for merges, in milliseconds.
total_query_cache_cache_count = The total number of queries that have been added to The quer.
total_query_cache_cache_size = The number of queries currently in The query cache.
total_query_cache_evictions = The number of evictions from The query cache.
total_query_cache_hit_count = The total number of hits in The query cache.
total_query_cache_memory_size_in_bytes = The amount of memory used for The query cache for all shards.
total_query_cache_miss_count = The total number of misses in The query cache.
total_query_cache_total_count = The total number of hits and misses in the query cache.
total_recovery_current_as_source = The number of recovery operations that have used an index sh.
total_recovery_current_as_target = The number of recovery operations that have used an index sh.
total_recovery_throttle_time = The delay of recovery operations due to throttling, in milli.
total_refresh_external_total = The total number of external refresh operations.
total_refresh_external_total_time = The total time for all external refresh operations, in milli.
total_refresh_listeners = The number of refresh listeners.
total_refresh_total = The total number of refresh operations.
total_refresh_total_time = The total time for all refresh operations, in milliseconds.
total_request_cache_evictions = The number of request cache evictions.
total_request_cache_hit_count = The number of request cache hits.
total_request_cache_memory_size_in_bytes = The memory size used by The request cache, in bytes.
total_request_cache_miss_count = The number of request cache misses.
total_search_concurrent_avg_slice_count = The average slice count of all search requests. This is comp.
total_search_concurrent_query_current = The number of currently running query operations that use co.
total_search_concurrent_query_time = The total amount of time taken by all query operations that .
total_search_concurrent_query_total = The total number of query operations that use concurrent seg.
total_search_fetch_current = The number of shard fetch operations that are currently runn.
total_search_fetch_time = The total amount of time for all shard fetch operations, in .
total_search_fetch_total = The total number of shard fetch operations.
total_search_open_contexts = The number of open search contexts.
total_search_point_time_current = The number of shard PIT contexts currently open.
total_search_point_time_time = The amount of time that shard PIT contexts have been held op.
total_search_point_time_total = The total number of shard Point in Time (PIT) contexts that .
total_search_query_current = The number of shard query operations that are currently runn.
total_search_query_time = The total amount of time for all shard query operations, in .
total_search_query_total = The total number of shard query operations.
total_search_scroll_current = The number of shard scroll operations that are currently run.
total_search_scroll_total = The total number of shard scroll operations.
total_search_scroll.time = The total amount of time for all shard scroll operations, in.
total_search_search_idl…_reactivate_count_total The total number of times that all shards have been activate.
total_search_suggest_current = The number of shard suggest operations that are currently ru.
total_search_suggest_time = The total amount of time for all shard suggest operations, i.
total_search_suggest_total = The total number of shard suggest operations.
total_segments_count = The total number of segments.
total_segments_doc_values_memory_in_bytes = The total amount of memory used for doc values, in bytes.
total_segments_fixed_bit_set_memory_in_bytes = The total amount of memory used by fixed bit sets, in bytes
total_segments_index_writer_memory_in_bytes = The total amount of memory used by all index writers, in byt.
total_segments_max_unsafe_auto_id_timestamp = The timestamp for The most recently retired indexing request.
total_segments_memory_in_bytes = The total amount of memory, in bytes.
total_segments_norms_memory_in_bytes = The total amount of memory used for term vectors, in bytes.
total_segments_points_memory_in_bytes = The total amount of memory used for normalization factors, i.
total_segments_stored_fields_memory_in_bytes = The total amount of memory used for stored fields, in bytes.
total_segments_term_vectors_memory_in_bytes = The memory used by term vectors, in bytes.
total_segments_terms_memory_in_bytes = The total amount of memory used for terms, in bytes.
total_segments_version_map_memory_in_bytes = The total amount of memory used by all version maps, in byte.
total_store_reserved_in_bytes = The predicted number of bytes The shard store will grow to b.
total_store_size_in_bytes Total size of all shards on The node.
total_translog_earliest_last_modified_age The earliest last modified age for The translog.
total_translog_operations = The number of translog operations.
total_translog_size_in_bytes = The size of The translog, in bytes.
total_translog_uncommitted_operations = The number of uncommitted translog operations.
total_translog_uncommitted_size_in_bytes = The size of uncommitted translog operations, in bytes.
total_warmer_current = The number of current index warming operations.
total_warmer_total = The total number of index warming operations.
total_warmer_total_time = The total time for all index warming operations, in millisec.
If enabled Nodes metrics:
_completion_size_in_bytes | Statistics about completions for all shards in the node.
_docs_count | The number of documents reported by Lucene. Excludes deleted...
_docs_deleted | The number of deleted documents reported by Lucene. Excludes...
_fielddata_evictions | The number of evictions in the field data cache.
_fielddata_memory_size_in_bytes | The total amount of memory used for the field data cache for...
_flush_periodic | The total number of periodic flush operations.
_flush_total | The total number of flush operations.
_flush_total_time | The total time for all flush operations, in milliseconds.
_get_current | The number of get operations that are currently running.
_get_exists_time | The total time for all successful get operations, in millise...
_get_exists_total | The total number of successful get operations.
_get_missing_time | The total time for all failed get operations, in millisecond...
_get_missing_total | The number of failed get operations.
_get_time | The total time for all get operations, in milliseconds.
_get_total | The total number of get operations.
_indexing_current | The number of indexing operations that are currently running...
_indexing_delete_current | The number of deletion operations that are currently running...
_indexing_delete_time | The total time for all deletion operations, in milliseconds.
_indexing_delete_total | The total number of deletions.
_indexing_failed | The number of indexing operations that have failed.
_indexing_index_total | The total number of indexing operations on the node.
_indexing_noop_update_total | The total number of noop operations.
_indexing_throttle_time | The total time for throttling operations, in milliseconds.
_indexing_time | The total time for all indexing operations, in milliseconds.
_merges_current | The number of merge operations that are currently running.
_merges_current_docs | The number of document merges that are currently running.
_merges_current_size_in_bytes | The memory size, in bytes, that is used to perform current m...
_merges_total | The total number of merge operations.
_merges_total_auto_throttle_in_bytes | The total size of automatically throttled merge operations, ...
_merges_total_docs | The total number of documents that have been merged.
_merges_total_size_in_bytes | The total size of all merged documents, in bytes.
_merges_total_stopped_time | The total time spent on stopping merge operations, in millis...
_merges_total_throttled_time | The total time spent on throttling merge operations, in mill...
_merges_total_time | The total time for merges, in milliseconds.
_query_cache_cache_count | The total number of queries that have been added to the quer...
_query_cache_cache_size | The number of queries currently in the query cache.
_query_cache_evictions | The number of evictions from the query cache.
_query_cache_hit_count | The total number of hits in the query cache.
_query_cache_memory_size_in_bytes | The amount of memory used for the query cache for all shards...
_query_cache_miss_count | The total number of misses in the query cache.
_query_cache_total_count | The total number of hits and misses in the query cache.
_recovery_current_as_source | The number of recovery operations that have used an index sh...
_recovery_current_as_target | The number of recovery operations that have used an index sh...
_recovery_throttle_time | The delay of recovery operations due to throttling, in milli...
_refresh_external_total | The total number of external refresh operations.
_refresh_external_total_time | The total time for all external refresh operations, in milli...
_refresh_listeners | The number of refresh listeners.
_refresh_total | The total number of refresh operations.
_refresh_total_time | The total time for all refresh operations, in milliseconds.
_request_cache_evictions | The number of request cache evictions.
_request_cache_hit_count | The number of request cache hits.
_request_cache_memory_size_in_bytes | The memory size used by the request cache, in bytes.
_request_cache_miss_count | The number of request cache misses.
_search_concurrent_avg_slice_count | The average slice count of all search requests. This is comp...
_search_concurrent_query_current | The number of currently running query operations that use co...
_search_concurrent_query_time | The total amount of time taken by all query operations that ...
_search_concurrent_query_total | The total number of query operations that use concurrent seg...
_search_fetch_current | The number of shard fetch operations that are currently runn...
_search_fetch_time | The total amount of time for all shard fetch operations, in ...
_search_fetch_total | The total number of shard fetch operations.
_search_open_contexts | The number of open search contexts.
_search_point_time_current | The number of shard PIT contexts currently open.
_search_point_time_time | The amount of time that shard PIT contexts have been held op...
_search_point_time_total | The total number of shard Point in Time (PIT) contexts that ...
_search_query_current | The number of shard query operations that are currently runn...
_search_query_time | The total amount of time for all shard query operations, in ...
_search_query_total | The total number of shard query operations.
_search_scroll_current | The number of shard scroll operations that are currently run...
_search_scroll_total | The total number of shard scroll operations.
_search_scroll.time | The total amount of time for all shard scroll operations, in...
_search_search_idle_reactivate_count_total | The total number of times that all shards have been activate...
_search_suggest_current | The number of shard suggest operations that are currently ru...
_search_suggest_time | The total amount of time for all shard suggest operations, i...
_search_suggest_total | The total number of shard suggest operations.
_segments_count | The total number of segments.
_segments_doc_values_memory_in_bytes | The total amount of memory used for doc values, in bytes.
_segments_fixed_bit_set_memory_in_bytes | The total amount of memory used by fixed bit sets, in bytes....
_segments_index_writer_memory_in_bytes | The total amount of memory used by all index writers, in byt...
_segments_max_unsafe_auto_id_timestamp | The timestamp for the most recently retired indexing request...
_segments_memory_in_bytes | The total amount of memory, in bytes.
_segments_norms_memory_in_bytes | The total amount of memory used for term vectors, in bytes.
_segments_points_memory_in_bytes | The total amount of memory used for normalization factors, i...
_segments_stored_fields_memory_in_bytes | The total amount of memory used for stored fields, in bytes.
_segments_term_vectors_memory_in_bytes | The memory used by term vectors, in bytes.
_segments_terms_memory_in_bytes | The total amount of memory used for terms, in bytes.
_segments_version_map_memory_in_bytes | The total amount of memory used by all version maps, in byte...
_store_reserved_in_bytes | The predicted number of bytes the shard store will grow to b...
_store_size_in_bytes | Total size of all shards on the node.
_translog_earliest_last_modified_age | The earliest last modified age for the translog.
_translog_operations | The number of translog operations.
_translog_size_in_bytes | The size of the translog, in bytes.
_translog_uncommitted_operations | The number of uncommitted translog operations.
_translog_uncommitted_size_in_bytes | The size of uncommitted translog operations, in bytes.
_warmer_current | The number of current index warming operations.
_warmer_total | The total number of index warming operations.
_warmer_total_time | The total time for all index warming operations, in millisec...
breakers_fielddata_estimated_size | The estimated memory used for the operation in human-readabl...
breakers_fielddata_estimated_size_in_bytes | The estimated memory used for the operation, in bytes to fie...
breakers_fielddata_limit_size | The memory limit for the circuit breaker in human-readable t...
breakers_fielddata_limit_size_in_bytes | The memory limit for the circuit breaker, in bytes to field ...
breakers_fielddata_overhead | A factor that all estimates are multiplied by to calculate t...
breakers_fielddata_tripped | The total number of times the circuit breaker has been activ...
breakers_in_flight_requests_estimated_size | The estimated memory used for the operation in human-readabl...
breakers_in_flight_requests_estimated_size_in_bytes | The estimated memory used for the operation, in bytes to fli...
breakers_in_flight_requests_limit_size | The memory limit for the circuit breaker in human-readable t...
breakers_in_flight_requests_limit_size_in_bytes | The memory limit for the circuit breaker, in bytes to flight...
breakers_in_flight_requests_overhead | A factor that all estimates are multiplied by to calculate t...
breakers_in_flight_requests_tripped | The total number of times the circuit breaker has been activ...
breakers_parent_estimated_size | The estimated memory used for the operation in human-readabl...
breakers_parent_estimated_size_in_bytes | The estimated memory used for the operation, in bytes to par...
breakers_parent_limit_size | The memory limit for the circuit breaker in human-readable t...
breakers_parent_limit_size_in_bytes | The memory limit for the circuit breaker, in bytes to parent...
breakers_parent_overhead | A factor that all estimates are multiplied by to calculate t...
breakers_parent_tripped | The total number of times the circuit breaker has been activ...
breakers_request_estimated_size | The estimated memory used for the operation in human-readabl...
breakers_request_estimated_size_in_bytes | The estimated memory used for the operation, in bytes to req...
breakers_request_limit_size | The memory limit for the circuit breaker in human-readable t...
breakers_request_limit_size_in_bytes | The memory limit for the circuit breaker, in bytes to reques...
breakers_request_overhead | A factor that all estimates are multiplied by to calculate t...
breakers_request_tripped | The total number of times the circuit breaker has been activ...
caches_request_cache_evictions | The total number of evictions from the request cache.
caches_request_cache_hit_count | The total hit count for the request cache.
caches_request_cache_item_count | The total number of items in the request cache.
caches_request_cache_miss_count | The total miss count for the request cache.
caches_request_cache_size_in_bytes | The total size, in bytes, of the request cache.
caches_request_cache_store_name | The name of the store type used by the request cache. See ti...
fs_disk_avail | The free disk space available to Elasticsearch.
fs_disk_percent | The total percentage of disk space in use. Calculated as dis...
fs_disk_total | The total disk space for the node including in-use and avail...
fs_disk_used | The total disk space in use.
http_current_open | The number of currently open HTTP connections.
http_total_opened | The total number of HTTP connections has opened since it sta...
indexing_pressure_memory_current_all_in_bytes | The total memory consumed by indexing requests in the coordi...
indexing_pressure_memory_current_coordinating_and_primary_in_bytes | The total memory used by indexing requests in the coordinati...
indexing_pressure_memory_current_coordinating_in_bytes | The total memory consumed by indexing requests in the coordi...
indexing_pressure_memory_current_primary_in_bytes | The total memory consumed by indexing requests in the primar...
indexing_pressure_memory_current_replica_in_bytes | The total memory consumed by indexing requests in the replic...
indexing_pressure_memory_limit_in_bytes | Configured memory limit, in bytes, for the indexing requests...
indexing_pressure_memory_total_all_in_bytes | Memory consumed, in bytes, by indexing requests in the coord...
indexing_pressure_memory_total_coordinating_and_primary_in_bytes | Memory consumed, in bytes, by indexing requests in the coord...
indexing_pressure_memory_total_coordinating_in_bytes | Memory consumed by indexing requests in the coordinating sta...
indexing_pressure_memory_total_coordinating_rejections | Number of indexing requests rejected in the coordinating sta...
indexing_pressure_memory_total_primary_in_bytes | Memory consumed by indexing requests in the primary stage
indexing_pressure_memory_total_primary_rejections | Number of indexing requests rejected in the primary stage
indexing_pressure_memory_total_replica_in_bytes | Memory consumed by indexing requests in the replica stage
indexing_pressure_memory_total_replica_rejections | Number of indexing requests rejected in the replica stage
jvm_gc_collectors_G_Concurrent_GC_collection_count | The total number of garbage collections run by the JVM
jvm_gc_collectors_G_Concurrent_GC_collection_time | The total time spent on garbage collection in the JVM
jvm_gc_collectors_old_collection_count | The number of garbage collectors that collect old generation...
jvm_gc_collectors_old_collection_time | The total time spent on garbage collection of old generation...
jvm_gc_collectors_young_collection_count | The number of garbage collectors that collect young generati...
jvm_gc_collectors_young_collection_time | The total time spent on garbage collection of young generati...
jvm_mem_heap_committed_in_bytes | The amount of memory available for use by the heap, in bytes...
jvm_mem_heap_max_in_bytes | The maximum amount of memory available for use by the heap, ...
jvm_mem_heap_used_in_bytes | The amount of memory that is currently being used, in bytes.
jvm_mem_heap_used_percent | The percentage of memory that is currently used by the heap.
jvm_mem_non_heap_committed_in_bytes | The maximum amount of non-heap memory available for use, in ...
jvm_mem_non_heap_used_in_bytes | The amount of non-heap memory that is currently used, in byt...
jvm_mem_pools_old_max_in_bytes | The maximum amount of memory that can be used by the Old Gen...
jvm_mem_pools_old_peak_max_in_bytes |
jvm_mem_pools_old_peak_used_in_bytes |
jvm_mem_pools_old_used_in_bytes | The amount of memory in bytes currently used by the Old Gene...
jvm_mem_pools_survivor_max_in_bytes | The maximum amount of memory that can be used by the Survivo...
jvm_mem_pools_survivor_peak_max_in_bytes |
jvm_mem_pools_survivor_peak_used_in_bytes |
jvm_mem_pools_survivor_used_in_bytes | The amount of memory in bytes currently used by the Survivor...
jvm_mem_pools_young_max_in_bytes | The maximum amount of memory that can be used by the Young G...
jvm_mem_pools_young_peak_max_in_bytes |
jvm_mem_pools_young_peak_used_in_bytes |
jvm_mem_pools_young_used_in_bytes | The amount of memory in bytes currently used by the Young Ge...
jvm_threads_count | The number of threads that are currently active in the JVM.
jvm_threads_peak_count | The maximum number of threads in the JVM.
jvm_timestamp | The last refresh time for the JVM statistics, in millisecond...
jvm_uptime_time | The JVM uptime, in milliseconds.
os_cpu_load_average_m | The load average for the system for the time period of fitte...
os_cpu_load_average_m | The load average for the system for the time period of one m...
os_cpu_load_average_m | The load average for the system for the time period of five ...
os_cpu_percent | Recent CPU usage for the system.
os_mem_free_in_bytes | The total amount of free physical memory, in bytes.
os_mem_free_percent | The percentage of memory that is free.
os_mem_total_in_bytes | The total amount of physical memory, in bytes.
os_mem_used_in_bytes | The total amount of used physical memory, in bytes.
os_mem_used_percent | The percentage of memory that is used.
os_swap_free_in_bytes | The total amount of free swap space, in bytes.
os_swap_total_in_bytes | The total amount of swap space, in bytes.
os_swap_used_in_bytes | The total amount of used swap space, in bytes.
os_timestamp | The last refresh time for the OS statistics, in milliseconds...
process_cpu_percent | The percentage of CPU usage for the process.
process_cpu_total_time | The total CPU time used by the process on which the JVM is r...
process_max_file_descriptors | The maximum number of file descriptors for the system.
process_mem_total_virtual_in_bytes | The total amount of virtual memory that is guaranteed to be ...
process_open_file_descriptors | The number of opened file descriptors associated with the cu...
process_timestamp | The last refresh time for the process statistics, in millise...
thread_pool_fetch_shard_started_active | The number of active threads in the fetch shard started pool
thread_pool_fetch_shard_started_completed | The number of tasks completed of shard started pool.
thread_pool_fetch_shard_started_largest | The peak number of threads in the shard started pool.
thread_pool_fetch_shard_started_queue | The number of queued threads in the fetch shard started poo
thread_pool_fetch_shard_started_rejected | The number of rejected threads in the fetch shard started po...
thread_pool_fetch_shard_started_threads | The total number of threads in the fetch shard started pool
thread_pool_fetch_shard_store_active | The number of active threads in the fetch shard store pool
thread_pool_fetch_shard_store_completed | he number of tasks completed of shard_store pool.
thread_pool_fetch_shard_store_largest | The peak number of threads in the shard_store pool.
thread_pool_fetch_shard_store_queue | The number of queued threads in the fetch shard store pool
thread_pool_fetch_shard_store_rejected | The number of rejected threads in the fetch shard store
thread_pool_fetch_shard_store_threads | The total number of threads in the fetch shard store pool
thread_pool_flush_active | The number of active threads in the flush queue.
thread_pool_flush_completed | The number of completed threads in the flush pool.
thread_pool_flush_largest | The peak number of threads in the flush pool.
thread_pool_flush_queue | The number of queued threads in the flush pool.
thread_pool_flush_rejected | The number of rejected threads in the flush pool.
thread_pool_flush_threads | The total number of threads in the flush pool.
thread_pool_force_merge_active | The number of active threads for force merge operations
thread_pool_force_merge_completed | The number of completed threads in the merge pool.
thread_pool_force_merge_largest | The peak number of threads in the merge pool.
thread_pool_force_merge_queue | The number of queued threads for force merge operations
thread_pool_force_merge_rejected | The number of rejected threads for force merge operations
thread_pool_force_merge_threads | The total number of threads for force merge operations
thread_pool_generic_active | The number of active threads in the generic pool.
thread_pool_generic_completed | The number of completed threads in the generic pool.
thread_pool_generic_largest | The peak number of threads in the generic pool.
thread_pool_generic_queue | The number of queued threads in the generic pool.
thread_pool_generic_rejected | The number of rejected threads in the generic pool.
thread_pool_generic_threads | The total number of threads in the generic pool.
thread_pool_get_active | The number of active threads in the get pool.
thread_pool_get_completed | The number of completed threads in the get pool.
thread_pool_get_largest | The peak number of threads in the get pool.
thread_pool_get_queue | The number of queued threads in the get pool.
thread_pool_get_rejected | The number of rejected threads in the get pool.
thread_pool_get_threads | The total number of threads in the get pool.
thread_pool_index_searcher_active | The number of active threads in the index pool
thread_pool_index_searcher_completed | The number of completed threads in the index pool
thread_pool_index_searcher_largest | The peak number of threads in the index searcher pool.
thread_pool_index_searcher_queue | The number of queued threads in the index pool
thread_pool_index_searcher_rejected | The number of rejected threads in the index pool
thread_pool_index_searcher_threads | The total number of threads in the index pool
thread_pool_index_searcher_total_wait_time_in_nanos | The total amount of time that tasks spend waiting in the thr...
thread_pool_listener_active | The number of active threads in the listener pool
thread_pool_listener_completed | The number of completed threads in the listener pool.
thread_pool_listener_largest | The peak number of threads in the listener pool.
thread_pool_listener_queue | The number of queued threads in the listener pool
thread_pool_listener_rejected | The number of rejected threads in the listener pool
thread_pool_listener_threads | The total number of threads in the listener pool
thread_pool_management_active | he number of active threads in the management pool.
thread_pool_management_completed | The number of completed threads in the management pool.
thread_pool_management_largest | The peak number of threads in the management pool.
thread_pool_management_queue | The number of queued threads in the management pool.
thread_pool_management_rejected | The number of rejected threads in the management pool.
thread_pool_management_threads | The total number of threads in the management pool.
thread_pool_refresh_active | The number of active threads in the refresh pool.
thread_pool_refresh_completed | The number of completed
If enabled Cluster metrics:
active_primary_shards = The number of active primary shards.
active_shards = The total number of active shards, including primary and rep...
active_shards_percent_as_number = The percentage of active shards in the cluster.
cluster_name = The name of the cluster
cluster_status = The cluster health status, which represents the state of sha...
delayed_unassigned_shards = The number of delayed unassigned shards.
initializing_shards = The number of initializing shards.
number_of_data_nodes = The number of data nodes in the cluster.
number_of_in_flight_fetch = The number of unfinished fetches.
number_of_nodes = The number of nodes in the cluster.
number_of_pending_tasks = The number of pending tasks in the cluster.
relocating_shards = The number of relocating shards.
unassigned_shards = The number of unassigned shards.