- Metricbeat Reference: other versions:
- Metricbeat overview
- Quick start: installation and configuration
- Set up and run
- Upgrade Metricbeat
- How Metricbeat works
- Configure
- Modules
- General settings
- Project paths
- Config file loading
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- Kibana endpoint
- Kibana dashboards
- Processors
- Define processors
- add_cloud_metadata
- add_cloudfoundry_metadata
- add_docker_metadata
- add_fields
- add_host_metadata
- add_id
- add_kubernetes_metadata
- add_labels
- add_locale
- add_network_direction
- add_nomad_metadata
- add_observer_metadata
- add_process_metadata
- add_tags
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_json_fields
- decode_xml
- decode_xml_wineventlog
- decompress_gzip_field
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- rate_limit
- registered_domain
- rename
- script
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- metricbeat.reference.yml
- How to guides
- Modules
- ActiveMQ module
- Aerospike module
- Apache module
- App Search module
- AWS module
- AWS billing metricset
- AWS cloudwatch metricset
- AWS dynamodb metricset
- AWS ebs metricset
- AWS ec2 metricset
- AWS elb metricset
- AWS kinesis metricset
- AWS lambda metricset
- AWS natgateway metricset
- AWS rds metricset
- AWS s3_daily_storage metricset
- AWS s3_request metricset
- AWS sns metricset
- AWS sqs metricset
- AWS transitgateway metricset
- AWS usage metricset
- AWS vpn metricset
- AWS Fargate module
- Azure module
- Azure app_insights metricset
- Azure app_state metricset
- Azure billing metricset
- Azure compute_vm metricset
- Azure compute_vm_scaleset metricset
- Azure container_instance metricset
- Azure container_registry metricset
- Azure container_service metricset
- Azure database_account metricset
- Azure monitor metricset
- Azure storage metricset
- Beat module
- Ceph module
- Ceph cluster_disk metricset
- Ceph cluster_health metricset
- Ceph cluster_status metricset
- Ceph mgr_cluster_disk metricset
- Ceph mgr_cluster_health metricset
- Ceph mgr_osd_perf metricset
- Ceph mgr_osd_pool_stats metricset
- Ceph mgr_osd_tree metricset
- Ceph mgr_pool_disk metricset
- Ceph monitor_health metricset
- Ceph osd_df metricset
- Ceph osd_tree metricset
- Ceph pool_disk metricset
- Cloudfoundry module
- CockroachDB module
- Consul module
- Coredns module
- Couchbase module
- CouchDB module
- Docker module
- Dropwizard module
- Elasticsearch module
- Elasticsearch ccr metricset
- Elasticsearch cluster_stats metricset
- Elasticsearch enrich metricset
- Elasticsearch index metricset
- Elasticsearch index_recovery metricset
- Elasticsearch index_summary metricset
- Elasticsearch ml_job metricset
- Elasticsearch node metricset
- Elasticsearch node_stats metricset
- Elasticsearch pending_tasks metricset
- Elasticsearch shard metricset
- Envoyproxy module
- Etcd module
- Google Cloud Platform module
- Golang module
- Graphite module
- HAProxy module
- HTTP module
- IBM MQ module
- IIS module
- Istio module
- Jolokia module
- Kafka module
- Kibana module
- Kubernetes module
- Kubernetes apiserver metricset
- Kubernetes container metricset
- Kubernetes controllermanager metricset
- Kubernetes event metricset
- Kubernetes node metricset
- Kubernetes pod metricset
- Kubernetes proxy metricset
- Kubernetes scheduler metricset
- Kubernetes state_container metricset
- Kubernetes state_cronjob metricset
- Kubernetes state_daemonset metricset
- Kubernetes state_deployment metricset
- Kubernetes state_node metricset
- Kubernetes state_persistentvolumeclaim metricset
- Kubernetes state_pod metricset
- Kubernetes state_replicaset metricset
- Kubernetes state_resourcequota metricset
- Kubernetes state_service metricset
- Kubernetes state_statefulset metricset
- Kubernetes state_storageclass metricset
- Kubernetes system metricset
- Kubernetes volume metricset
- KVM module
- linux module
- Logstash module
- Memcached module
- MongoDB module
- MSSQL module
- Munin module
- MySQL module
- NATS module
- Nginx module
- Openmetrics module
- Oracle module
- PHP_FPM module
- PostgreSQL module
- Prometheus module
- RabbitMQ module
- Redis module
- Redis Enterprise module
- SQL module
- Stan module
- Statsd module
- System module
- System core metricset
- System cpu metricset
- System diskio metricset
- System entropy metricset
- System filesystem metricset
- System fsstat metricset
- System load metricset
- System memory metricset
- System network metricset
- System network_summary metricset
- System process metricset
- System process_summary metricset
- System raid metricset
- System service metricset
- System socket metricset
- System socket_summary metricset
- System uptime metricset
- System users metricset
- Tomcat module
- Traefik module
- uWSGI module
- vSphere module
- Windows module
- ZooKeeper module
- Exported fields
- ActiveMQ fields
- Aerospike fields
- Apache fields
- App Search fields
- AWS fields
- AWS Fargate fields
- Azure fields
- Beat fields
- Beat fields
- Ceph fields
- Cloud provider metadata fields
- Cloudfoundry fields
- CockroachDB fields
- Common fields
- Consul fields
- Coredns fields
- Couchbase fields
- CouchDB fields
- Docker fields
- Docker fields
- Dropwizard fields
- ECS fields
- Elasticsearch fields
- Envoyproxy fields
- Etcd fields
- Google Cloud Platform fields
- Golang fields
- Graphite fields
- HAProxy fields
- Host fields
- HTTP fields
- IBM MQ fields
- IIS fields
- Istio fields
- Jolokia fields
- Jolokia Discovery autodiscover provider fields
- Kafka fields
- Kibana fields
- Kubernetes fields
- Kubernetes fields
- KVM fields
- linux fields
- Logstash fields
- Memcached fields
- MongoDB fields
- MSSQL fields
- Munin fields
- MySQL fields
- NATS fields
- Nginx fields
- Openmetrics fields
- Oracle fields
- PHP_FPM fields
- PostgreSQL fields
- Process fields
- Prometheus fields
- Prometheus typed metrics fields
- RabbitMQ fields
- Redis fields
- Redis Enterprise fields
- SQL fields
- Stan fields
- Statsd fields
- System fields
- Tomcat fields
- Traefik fields
- uWSGI fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- Common problems
- "open /compat/linux/proc: no such file or directory" error on FreeBSD
- Metricbeat collects system metrics for interfaces you didn’t configure
- Metricbeat uses too much bandwidth
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- Publishing to Logstash fails with "connection reset by peer" message
- @metadata is missing in Logstash
- Not sure whether to use Logstash or Beats
- SSL client fails to connect to Logstash
- Monitoring UI shows fewer Beats than expected
- Dashboard could not locate the index-pattern
- Contribute to Beats
Elasticsearch fields
editElasticsearch fields
editElasticsearch module
elasticsearch
edit-
elasticsearch.cluster.name
-
Elasticsearch cluster name.
type: keyword
-
elasticsearch.cluster.id
-
Elasticsearch cluster id.
type: keyword
-
elasticsearch.cluster.state.id
-
Elasticsearch state id.
type: keyword
-
elasticsearch.node.id
-
Node ID
type: keyword
-
elasticsearch.node.name
-
Node name.
type: keyword
ccr
editCross-cluster replication stats
-
elasticsearch.ccr.leader.index
-
Name of leader index
type: keyword
-
elasticsearch.ccr.leader.max_seq_no
-
Maximum sequence number of operation on the leader shard
type: long
-
elasticsearch.ccr.follower.index
-
Name of follower index
type: keyword
-
elasticsearch.ccr.follower.shard.number
-
Number of the shard within the index
type: long
-
elasticsearch.ccr.follower.operations_written
-
Number of operations indexed (replicated) into the follower shard from the leader shard
type: long
-
elasticsearch.ccr.follower.time_since_last_read.ms
-
Time, in ms, since the follower last fetched from the leader
type: long
-
elasticsearch.ccr.follower.global_checkpoint
-
Global checkpoint value on follower shard
type: long
cluster.stats
editCluster stats
-
elasticsearch.cluster.stats.status
-
Cluster status (green, yellow, red).
type: keyword
nodes
editNodes statistics.
-
elasticsearch.cluster.stats.nodes.count
-
Total number of nodes in cluster.
type: long
-
elasticsearch.cluster.stats.nodes.master
-
Number of master-eligible nodes in cluster.
type: long
-
elasticsearch.cluster.stats.nodes.data
-
Number of data nodes in cluster.
type: long
indices
editIndices statistics.
-
elasticsearch.cluster.stats.indices.count
-
Total number of indices in cluster.
type: long
shards
editShard statistics.
-
elasticsearch.cluster.stats.indices.shards.count
-
Total number of shards in cluster.
type: long
-
elasticsearch.cluster.stats.indices.shards.primaries
-
Total number of primary shards in cluster.
type: long
-
elasticsearch.cluster.stats.indices.fielddata.memory.bytes
-
Memory used for fielddata.
type: long
enrich
editEnrich stats
-
elasticsearch.enrich.queue.size
-
Number of search requests in the queue.
type: long
-
elasticsearch.enrich.remote_requests.current
-
Current number of outstanding remote requests.
type: long
-
elasticsearch.enrich.remote_requests.total
-
Number of outstanding remote requests executed since node startup.
type: long
-
elasticsearch.enrich.executed_searches.total
-
Number of search requests that enrich processors have executed since node startup.
type: long
index
editindex
-
elasticsearch.index.name
-
Index name.
type: keyword
-
elasticsearch.index.total.docs.count
-
Total number of documents in the index.
type: long
-
elasticsearch.index.total.docs.deleted
-
Total number of deleted documents in the index.
type: long
-
elasticsearch.index.total.store.size.bytes
-
Total size of the index in bytes.
type: long
format: bytes
-
elasticsearch.index.total.segments.count
-
Total number of index segments.
type: long
-
elasticsearch.index.total.segments.memory.bytes
-
Total number of memory used by the segments in bytes.
type: long
format: bytes
index.recovery
editindex
-
elasticsearch.index.recovery.id
-
Shard recovery id.
type: long
-
elasticsearch.index.recovery.type
-
Shard recovery type.
type: keyword
-
elasticsearch.index.recovery.primary
-
True if primary shard.
type: boolean
-
elasticsearch.index.recovery.stage
-
Recovery stage.
type: keyword
-
elasticsearch.index.recovery.target.id
-
Target node id.
type: keyword
-
elasticsearch.index.recovery.target.host
-
Target node host address (could be IP address or hostname).
type: keyword
-
elasticsearch.index.recovery.target.name
-
Target node name.
type: keyword
-
elasticsearch.index.recovery.source.id
-
Source node id.
type: keyword
-
elasticsearch.index.recovery.source.host
-
Source node host address (could be IP address or hostname).
type: keyword
-
elasticsearch.index.recovery.source.name
-
Source node name.
type: keyword
index.summary
editindex
-
elasticsearch.index.summary.primaries.docs.count
-
Total number of documents in the index.
type: long
-
elasticsearch.index.summary.primaries.docs.deleted
-
Total number of deleted documents in the index.
type: long
-
elasticsearch.index.summary.primaries.store.size.bytes
-
Total size of the index in bytes.
type: long
format: bytes
-
elasticsearch.index.summary.primaries.segments.count
-
Total number of index segments.
type: long
-
elasticsearch.index.summary.primaries.segments.memory.bytes
-
Total number of memory used by the segments in bytes.
type: long
format: bytes
-
elasticsearch.index.summary.total.docs.count
-
Total number of documents in the index.
type: long
-
elasticsearch.index.summary.total.docs.deleted
-
Total number of deleted documents in the index.
type: long
-
elasticsearch.index.summary.total.store.size.bytes
-
Total size of the index in bytes.
type: long
format: bytes
-
elasticsearch.index.summary.total.segments.count
-
Total number of index segments.
type: long
-
elasticsearch.index.summary.total.segments.memory.bytes
-
Total number of memory used by the segments in bytes.
type: long
format: bytes
ml.job
editml
-
elasticsearch.ml.job.id
-
Unique ml job id.
type: keyword
-
elasticsearch.ml.job.state
-
Job state.
type: keyword
-
elasticsearch.ml.job.data_counts.processed_record_count
-
Processed data events.
type: long
-
elasticsearch.ml.job.data_counts.invalid_date_count
-
The number of records with either a missing date field or a date that could not be parsed.
type: long
node
editnode
-
elasticsearch.node.version
-
Node version.
type: keyword
jvm
editJVM Info.
-
elasticsearch.node.jvm.version
-
JVM version.
type: keyword
-
elasticsearch.node.jvm.memory.heap.init.bytes
-
Heap init used by the JVM in bytes.
type: long
format: bytes
-
elasticsearch.node.jvm.memory.heap.max.bytes
-
Heap max used by the JVM in bytes.
type: long
format: bytes
-
elasticsearch.node.jvm.memory.nonheap.init.bytes
-
Non-Heap init used by the JVM in bytes.
type: long
format: bytes
-
elasticsearch.node.jvm.memory.nonheap.max.bytes
-
Non-Heap max used by the JVM in bytes.
type: long
format: bytes
-
elasticsearch.node.process.mlockall
-
If process locked in memory.
type: boolean
node.stats
editnode_stats
indices
editNode indices stats
-
elasticsearch.node.stats.indices.docs.count
-
Total number of existing documents.
type: long
-
elasticsearch.node.stats.indices.docs.deleted
-
Total number of deleted documents.
type: long
-
elasticsearch.node.stats.indices.segments.count
-
Total number of segments.
type: long
-
elasticsearch.node.stats.indices.segments.memory.bytes
-
Total size of segments in bytes.
type: long
format: bytes
-
elasticsearch.node.stats.indices.store.size.bytes
-
Total size of the store in bytes.
type: long
jvm.mem.pools
editJVM memory pool stats
old
editOld memory pool stats.
-
elasticsearch.node.stats.jvm.mem.pools.old.max.bytes
-
Max bytes.
type: long
format: bytes
-
elasticsearch.node.stats.jvm.mem.pools.old.peak.bytes
-
Peak bytes.
type: long
format: bytes
-
elasticsearch.node.stats.jvm.mem.pools.old.peak_max.bytes
-
Peak max bytes.
type: long
format: bytes
-
elasticsearch.node.stats.jvm.mem.pools.old.used.bytes
-
Used bytes.
type: long
format: bytes
young
editYoung memory pool stats.
-
elasticsearch.node.stats.jvm.mem.pools.young.max.bytes
-
Max bytes.
type: long
format: bytes
-
elasticsearch.node.stats.jvm.mem.pools.young.peak.bytes
-
Peak bytes.
type: long
format: bytes
-
elasticsearch.node.stats.jvm.mem.pools.young.peak_max.bytes
-
Peak max bytes.
type: long
format: bytes
-
elasticsearch.node.stats.jvm.mem.pools.young.used.bytes
-
Used bytes.
type: long
format: bytes
survivor
editSurvivor memory pool stats.
-
elasticsearch.node.stats.jvm.mem.pools.survivor.max.bytes
-
Max bytes.
type: long
format: bytes
-
elasticsearch.node.stats.jvm.mem.pools.survivor.peak.bytes
-
Peak bytes.
type: long
format: bytes
-
elasticsearch.node.stats.jvm.mem.pools.survivor.peak_max.bytes
-
Peak max bytes.
type: long
format: bytes
-
elasticsearch.node.stats.jvm.mem.pools.survivor.used.bytes
-
Used bytes.
type: long
format: bytes
jvm.gc.collectors
editGC collector stats.
old.collection
editOld collection gc.
-
elasticsearch.node.stats.jvm.gc.collectors.old.collection.count
-
type: long
-
elasticsearch.node.stats.jvm.gc.collectors.old.collection.ms
-
type: long
young.collection
editYoung collection gc.
-
elasticsearch.node.stats.jvm.gc.collectors.young.collection.count
-
type: long
-
elasticsearch.node.stats.jvm.gc.collectors.young.collection.ms
-
type: long
fs.summary
editFile system summary
-
elasticsearch.node.stats.fs.summary.total.bytes
-
type: long
format: bytes
-
elasticsearch.node.stats.fs.summary.free.bytes
-
type: long
format: bytes
-
elasticsearch.node.stats.fs.summary.available.bytes
-
type: long
format: bytes
cluster.pending_task
editcluster.pending_task
contains a pending task description.
-
elasticsearch.cluster.pending_task.insert_order
-
Insert order
type: long
-
elasticsearch.cluster.pending_task.priority
-
Priority
type: long
-
elasticsearch.cluster.pending_task.source
-
Source. For example: put-mapping
type: keyword
-
elasticsearch.cluster.pending_task.time_in_queue.ms
-
Time in queue
type: long
shard
editshard fields
-
elasticsearch.shard.primary
-
True if this is the primary shard.
type: boolean
-
elasticsearch.shard.number
-
The number of this shard.
type: long
-
elasticsearch.shard.state
-
The state of this shard.
type: keyword
-
elasticsearch.shard.relocating_node.name
-
The node the shard was relocated from.
type: keyword
On this page