• Metricbeat Reference: other versions:
  • Metricbeat overview
  • Quick start: installation and configuration
  • Set up and run
    • Directory layout
    • Secrets keystore
    • Command reference
    • Repositories for APT and YUM
    • Run Metricbeat on Docker
    • Run Metricbeat on Kubernetes
    • Run Metricbeat on Cloud Foundry
    • Metricbeat and systemd
    • Start Metricbeat
    • Stop Metricbeat
  • Upgrade Metricbeat
  • How Metricbeat works
    • Event structure
    • Error event structure
    • Key metricbeat features
  • Configure
    • Modules
    • General settings
    • Project paths
    • Config file loading
      • Live reloading
    • Output
      • Elasticsearch Service
      • Elasticsearch
      • Logstash
      • Kafka
      • Redis
      • File
      • Console
      • Change the output codec
    • 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
      • Hints based autodiscover
      • Advanced usage
    • Internal queue
    • Logging
    • HTTP endpoint
    • Regular expression support
    • Instrumentation
    • metricbeat.reference.yml
  • How to guides
    • Load the Elasticsearch index template
    • Change the index name
    • Load Kibana dashboards
    • Enrich events with geoIP information
    • Use environment variables in the configuration
    • Parse data by using ingest node
    • Avoid YAML formatting problems
  • Modules
    • ActiveMQ module
      • ActiveMQ broker metricset
      • ActiveMQ queue metricset
      • ActiveMQ topic metricset
    • Aerospike module
      • Aerospike namespace metricset
    • Apache module
      • Apache status metricset
    • App Search module
      • App Search stats metricset
    • 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
      • AWS Fargate task_stats metricset
    • 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
      • Beat state metricset
      • Beat stats metricset
    • 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
      • Cloudfoundry container metricset
      • Cloudfoundry counter metricset
      • Cloudfoundry value metricset
    • CockroachDB module
      • CockroachDB status metricset
    • Consul module
      • Consul agent metricset
    • Coredns module
      • Coredns stats metricset
    • Couchbase module
      • Couchbase bucket metricset
      • Couchbase cluster metricset
      • Couchbase node metricset
    • CouchDB module
      • CouchDB server metricset
    • Docker module
      • Docker container metricset
      • Docker cpu metricset
      • Docker diskio metricset
      • Docker event metricset
      • Docker healthcheck metricset
      • Docker image metricset
      • Docker info metricset
      • Docker memory metricset
      • Docker network metricset
      • Docker network_summary metricset
    • Dropwizard module
      • Dropwizard collector metricset
    • 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
      • Envoyproxy server metricset
    • Etcd module
      • Etcd leader metricset
      • Etcd metrics metricset
      • Etcd self metricset
      • Etcd store metricset
    • Google Cloud Platform module
      • Google Cloud Platform billing metricset
      • Google Cloud Platform compute metricset
      • Google Cloud Platform loadbalancing metricset
      • Google Cloud Platform metrics metricset
      • Google Cloud Platform pubsub metricset
      • Google Cloud Platform storage metricset
    • Golang module
      • Golang expvar metricset
      • Golang heap metricset
    • Graphite module
      • Graphite server metricset
    • HAProxy module
      • HAProxy info metricset
      • HAProxy stat metricset
    • HTTP module
      • HTTP json metricset
      • HTTP server metricset
    • IBM MQ module
      • IBM MQ qmgr metricset
    • IIS module
      • IIS application_pool metricset
      • IIS webserver metricset
      • IIS website metricset
    • Istio module
      • Istio citadel metricset
      • Istio galley metricset
      • Istio istiod metricset
      • Istio mesh metricset
      • Istio mixer metricset
      • Istio pilot metricset
      • Istio proxy metricset
    • Jolokia module
      • Jolokia jmx metricset
    • Kafka module
      • Kafka broker metricset
      • Kafka consumer metricset
      • Kafka consumergroup metricset
      • Kafka partition metricset
      • Kafka producer metricset
    • Kibana module
      • Kibana stats metricset
      • Module-specific configuration notes
      • Kibana status metricset
    • 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
      • KVM dommemstat metricset
      • KVM status metricset
    • linux module
      • linux conntrack metricset
      • linux iostat metricset
      • linux ksm metricset
      • linux memory metricset
      • linux pageinfo metricset
    • Logstash module
      • Logstash node metricset
      • Logstash node_stats metricset
    • Memcached module
      • Memcached stats metricset
    • MongoDB module
      • MongoDB collstats metricset
      • MongoDB dbstats metricset
      • MongoDB metrics metricset
      • MongoDB replstatus metricset
      • MongoDB status metricset
    • MSSQL module
      • MSSQL performance metricset
      • MSSQL transaction_log metricset
    • Munin module
      • Munin node metricset
    • MySQL module
      • MySQL galera_status metricset
      • galera status MetricSet
      • MySQL performance metricset
      • MySQL query metricset
      • MySQL status metricset
    • NATS module
      • NATS connection metricset
      • NATS connections metricset
      • NATS route metricset
      • NATS routes metricset
      • NATS stats metricset
      • NATS subscriptions metricset
    • Nginx module
      • Nginx stubstatus metricset
    • Openmetrics module
      • Openmetrics collector metricset
    • Oracle module
      • Oracle performance metricset
      • Oracle tablespace metricset
    • PHP_FPM module
      • PHP_FPM pool metricset
      • PHP_FPM process metricset
    • PostgreSQL module
      • PostgreSQL activity metricset
      • PostgreSQL bgwriter metricset
      • PostgreSQL database metricset
      • PostgreSQL statement metricset
    • Prometheus module
      • Prometheus collector metricset
      • Prometheus query metricset
      • Prometheus remote_write metricset
    • RabbitMQ module
      • RabbitMQ connection metricset
      • RabbitMQ exchange metricset
      • RabbitMQ node metricset
      • RabbitMQ queue metricset
    • Redis module
      • Redis info metricset
      • Redis key metricset
      • Redis keyspace metricset
    • Redis Enterprise module
      • Redis Enterprise node metricset
      • Redis Enterprise proxy metricset
    • SQL module
      • SQL query metricset
    • Stan module
      • Stan channels metricset
      • Stan stats metricset
      • Stan subscriptions metricset
    • Statsd module
      • Statsd server metricset
    • 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
      • Tomcat cache metricset
      • Tomcat memory metricset
      • Tomcat requests metricset
      • Tomcat threading metricset
    • Traefik module
      • Traefik health metricset
    • uWSGI module
      • uWSGI status metricset
    • vSphere module
      • vSphere datastore metricset
      • vSphere host metricset
      • vSphere virtualmachine metricset
    • Windows module
      • Windows perfmon metricset
      • Windows service metricset
    • ZooKeeper module
      • ZooKeeper connection metricset
      • ZooKeeper mntr metricset
      • ZooKeeper server metricset
  • 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
    • Use internal collection
      • Settings for internal collection
    • Use Metricbeat collection
    • Use legacy collection (deprecated)
      • Settings for legacy collection
  • Secure
    • Grant users access to secured resources
      • Create a setup user
      • Create a monitoring user
      • Create a publishing user
      • Create a reader user
      • Learn more about privileges, roles, and users
    • Grant access using API keys
    • Secure communication with Elasticsearch
    • Secure communication with Logstash
    • Use Linux Secure Computing Mode (seccomp)
  • 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