- 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
Kafka fields
editKafka fields
editKafka module
kafka
editbroker
editBroker Consumer Group Information have been read from (Broker handling the consumer group).
-
kafka.broker.id
-
Broker id
type: long
-
kafka.broker.address
-
Broker advertised address
type: keyword
-
kafka.topic.name
-
Topic name
type: keyword
-
kafka.topic.error.code
-
Topic error code.
type: long
-
kafka.partition.id
-
Partition id.
type: long
-
kafka.partition.topic_id
-
Unique id of the partition in the topic.
type: keyword
-
kafka.partition.topic_broker_id
-
Unique id of the partition in the topic and the broker.
type: keyword
broker
editBroker metrics from Kafka Broker JMX
-
kafka.broker.mbean
-
Mbean that this event is related to
type: keyword
-
kafka.broker.request.channel.queue.size
-
The size of the request queue
type: long
-
kafka.broker.request.produce.failed_per_second
-
The rate of failed produce requests per second
type: float
-
kafka.broker.request.fetch.failed_per_second
-
The rate of client fetch request failures per second
type: float
-
kafka.broker.request.produce.failed
-
The number of failed produce requests
type: float
-
kafka.broker.request.fetch.failed
-
The number of client fetch request failures
type: float
-
kafka.broker.replication.leader_elections
-
The leader election rate
type: float
-
kafka.broker.replication.unclean_leader_elections
-
The unclean leader election rate
type: float
-
kafka.broker.session.zookeeper.disconnect
-
The ZooKeeper closed sessions per second
type: float
-
kafka.broker.session.zookeeper.expire
-
The ZooKeeper expired sessions per second
type: float
-
kafka.broker.session.zookeeper.readonly
-
The ZooKeeper readonly sessions per second
type: float
-
kafka.broker.session.zookeeper.sync
-
The ZooKeeper client connections per second
type: float
-
kafka.broker.log.flush_rate
-
The log flush rate
type: float
-
kafka.broker.topic.net.in.bytes_per_sec
-
The incoming byte rate per topic
type: float
-
kafka.broker.topic.net.out.bytes_per_sec
-
The outgoing byte rate per topic
type: float
-
kafka.broker.topic.net.rejected.bytes_per_sec
-
The rejected byte rate per topic
type: float
-
kafka.broker.topic.messages_in
-
The incoming message rate per topic
type: float
-
kafka.broker.net.in.bytes_per_sec
-
The incoming byte rate
type: float
-
kafka.broker.net.out.bytes_per_sec
-
The outgoing byte rate
type: float
-
kafka.broker.net.rejected.bytes_per_sec
-
The rejected byte rate
type: float
-
kafka.broker.messages_in
-
The incoming message rate
type: float
consumer
editConsumer metrics from Kafka Consumer JMX
-
kafka.consumer.mbean
-
Mbean that this event is related to
type: keyword
-
kafka.consumer.fetch_rate
-
The minimum rate at which the consumer sends fetch requests to a broker
type: float
-
kafka.consumer.bytes_consumed
-
The average number of bytes consumed for a specific topic per second
type: float
-
kafka.consumer.records_consumed
-
The average number of records consumed per second for a specific topic
type: float
-
kafka.consumer.in.bytes_per_sec
-
The rate of bytes coming in to the consumer
type: float
-
kafka.consumer.max_lag
-
The maximum consumer lag
type: float
-
kafka.consumer.zookeeper_commits
-
The rate of offset commits to ZooKeeper
type: float
-
kafka.consumer.kafka_commits
-
The rate of offset commits to Kafka
type: float
-
kafka.consumer.messages_in
-
The rate of consumer message consumption
type: float
consumergroup
editconsumergroup
broker
editBroker Consumer Group Information have been read from (Broker handling the consumer group).
-
kafka.consumergroup.broker.id
-
Broker id
type: long
-
kafka.consumergroup.broker.address
-
Broker address
type: keyword
-
kafka.consumergroup.id
-
Consumer Group ID
type: keyword
-
kafka.consumergroup.topic
-
[6.5] Deprecated in 6.5.
Topic name
type: keyword
-
kafka.consumergroup.partition
-
[6.5] Deprecated in 6.5.
Partition ID
type: long
-
kafka.consumergroup.offset
-
consumer offset into partition being read
type: long
-
kafka.consumergroup.meta
-
custom consumer meta data string
type: keyword
-
kafka.consumergroup.consumer_lag
-
consumer lag for partition/topic calculated as the difference between the partition offset and consumer offset
type: long
-
kafka.consumergroup.error.code
-
kafka consumer/partition error code.
type: long
client
editAssigned client reading events from partition
-
kafka.consumergroup.client.id
-
Client ID (kafka setting client.id)
type: keyword
-
kafka.consumergroup.client.host
-
Client host
type: keyword
-
kafka.consumergroup.client.member_id
-
internal consumer group member ID
type: keyword
partition
editpartition
offset
editAvailable offsets of the given partition.
-
kafka.partition.offset.newest
-
Newest offset of the partition.
type: long
-
kafka.partition.offset.oldest
-
Oldest offset of the partition.
type: long
partition
editPartition data.
-
kafka.partition.partition.id
-
[6.5] Deprecated in 6.5.
Partition id.
type: long
-
kafka.partition.partition.leader
-
Leader id (broker).
type: long
-
kafka.partition.partition.replica
-
Replica id (broker).
type: long
-
kafka.partition.partition.insync_replica
-
Indicates if replica is included in the in-sync replicate set (ISR).
type: boolean
-
kafka.partition.partition.is_leader
-
Indicates if replica is the leader
type: boolean
-
kafka.partition.partition.error.code
-
Error code from fetching partition.
type: long
-
kafka.partition.topic.error.code
-
[6.5] Deprecated in 6.5.
topic error code.
type: long
-
kafka.partition.topic.name
-
[6.5] Deprecated in 6.5.
Topic name
type: keyword
-
kafka.partition.broker.id
-
[6.5] Deprecated in 6.5.
Broker id
type: long
-
kafka.partition.broker.address
-
[6.5] Deprecated in 6.5.
Broker address
type: keyword
producer
editProducer metrics from Kafka Producer JMX
-
kafka.producer.mbean
-
Mbean that this event is related to
type: keyword
-
kafka.producer.available_buffer_bytes
-
The total amount of buffer memory
type: float
-
kafka.producer.batch_size_avg
-
The average number of bytes sent
type: float
-
kafka.producer.batch_size_max
-
The maximum number of bytes sent
type: long
-
kafka.producer.record_send_rate
-
The average number of records sent per second
type: float
-
kafka.producer.record_retry_rate
-
The average number of retried record sends per second
type: float
-
kafka.producer.record_error_rate
-
The average number of retried record sends per second
type: float
-
kafka.producer.records_per_request
-
The average number of records sent per second
type: float
-
kafka.producer.record_size_avg
-
The average record size
type: float
-
kafka.producer.record_size_max
-
The maximum record size
type: long
-
kafka.producer.request_rate
-
The number of producer requests per second
type: float
-
kafka.producer.response_rate
-
The number of producer responses per second
type: float
-
kafka.producer.io_wait
-
The producer I/O wait time
type: float
-
kafka.producer.out.bytes_per_sec
-
The rate of bytes going out for the producer
type: float
-
kafka.producer.message_rate
-
The producer message rate
type: float