• Metricbeat Reference: other versions:
  • Overview
  • Getting started with Metricbeat
    • Step 1: Install Metricbeat
    • Step 2: Configure Metricbeat
    • Step 3: Load the index template in Elasticsearch
    • Step 4: Set up the Kibana dashboards
    • Step 5: Start Metricbeat
    • Step 6: View the sample Kibana dashboards
    • Repositories for APT and YUM
  • Setting up and running Metricbeat
    • Directory layout
    • Secrets keystore
    • Command reference
    • Running Metricbeat on Docker
    • Running Metricbeat on Kubernetes
    • Stopping Metricbeat
  • Upgrading Metricbeat
  • How Metricbeat works
    • Event structure
    • Error event structure
    • Key metricbeat features
  • Configuring Metricbeat
    • Specify which modules to run
    • Specify general settings
    • Load external configuration files
      • Live reloading
    • Configure the internal queue
    • Configure the output
      • Elasticsearch
      • Logstash
      • Kafka
      • Redis
      • File
      • Console
      • Cloud
      • Change the output codec
    • Set up index lifecycle management
    • Specify SSL settings
    • Filter and enhance the exported data
      • Define processors
      • Add cloud metadata
      • Add the local time zone
      • Decode JSON fields
      • Drop events
      • Drop fields from events
      • Keep fields from events
      • Rename fields from events
      • Add Kubernetes metadata
      • Add Docker metadata
      • Add Host metadata
      • Dissect strings
      • DNS Reverse Lookup
      • Add process metadata
    • Parse data by using ingest node
    • Set up project paths
    • Set up the Kibana endpoint
    • Load the Kibana dashboards
    • Load the Elasticsearch index template
    • Configure logging
    • Use environment variables in the configuration
    • Autodiscover
      • Hints based autodiscover
      • Advanced usage
    • YAML tips and gotchas
    • Regular expression support
    • HTTP Endpoint
    • metricbeat.reference.yml
  • Beats central management
    • How central management works
    • Enroll Beats in central management
  • Modules
    • Aerospike module
      • Aerospike namespace metricset
    • Apache module
      • Apache status metricset
    • Ceph module
      • Ceph cluster_disk metricset
      • Ceph cluster_health metricset
      • Ceph cluster_status metricset
      • Ceph monitor_health metricset
      • Ceph osd_df metricset
      • Ceph osd_tree metricset
      • Ceph pool_disk metricset
    • Couchbase module
      • Couchbase bucket metricset
      • Couchbase cluster metricset
      • Couchbase node metricset
    • Docker module
      • Docker container metricset
      • Docker cpu metricset
      • Docker diskio metricset
      • Docker healthcheck metricset
      • Docker image metricset
      • Docker info metricset
      • Docker memory metricset
      • Docker network metricset
    • Dropwizard module
      • Dropwizard collector metricset
    • Elasticsearch module
      • Elasticsearch ccr metricset
      • Elasticsearch cluster_stats metricset
      • Elasticsearch index metricset
      • Elasticsearch index_recovery metricset
      • Elasticsearch index_summary metricset
      • Elasticsearch ml_job metricset
      • elasticsearch ml_job MetricSet
      • Elasticsearch node metricset
      • Elasticsearch node_stats metricset
      • Elasticsearch pending_tasks metricset
      • elasticsearch pending_tasks MetricSet
      • Elasticsearch shard metricset
    • envoyproxy module
      • envoyproxy server metricset
      • envoyproxy server MetricSet
    • Etcd module
      • Etcd leader metricset
      • Etcd self metricset
      • Etcd store 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
    • Jolokia module
      • Jolokia jmx metricset
    • Kafka module
      • Kafka consumergroup metricset
      • Kafka partition metricset
    • Kibana module
      • Kibana stats metricset
      • Module-specific configuration notes
      • Kibana status metricset
    • Kubernetes module
      • Kubernetes apiserver metricset
      • Kubernetes container metricset
      • Kubernetes event metricset
      • Kubernetes node metricset
      • Kubernetes pod metricset
      • Kubernetes state_container metricset
      • Kubernetes state_deployment metricset
      • Kubernetes state_node metricset
      • Kubernetes state_pod metricset
      • Kubernetes state_replicaset metricset
      • Kubernetes state_statefulset metricset
      • Kubernetes system metricset
      • Kubernetes volume metricset
    • kvm module
      • kvm dommemstat 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
    • Munin module
      • Munin node metricset
    • MySQL module
      • MySQL galera_status metricset
      • galera status MetricSet
      • MySQL status metricset
    • Nginx module
      • Nginx stubstatus 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 stats metricset
    • RabbitMQ module
      • RabbitMQ connection metricset
      • RabbitMQ exchange metricset
      • rabbitmq exchange MetricSet
      • RabbitMQ node metricset
      • RabbitMQ queue metricset
    • Redis module
      • Redis info metricset
      • Redis keyspace metricset
    • System module
      • System core metricset
      • System cpu metricset
      • System diskio metricset
      • System filesystem metricset
      • System fsstat metricset
      • System load metricset
      • System memory metricset
      • System network metricset
      • System process metricset
      • System process_summary metricset
      • System raid metricset
      • System socket metricset
      • System socket_summary metricset
      • System uptime metricset
    • traefik module
      • Compatibility
      • 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 mntr metricset
  • Exported fields
    • Aerospike fields
    • Alias fields
    • Apache fields
    • Beat fields
    • Ceph fields
    • Cloud provider metadata fields
    • Common fields
    • Couchbase fields
    • Docker fields
    • Docker fields
    • Dropwizard fields
    • Elasticsearch fields
    • envoyproxy fields
    • Etcd fields
    • Golang fields
    • Graphite fields
    • HAProxy fields
    • Host fields
    • HTTP fields
    • Jolokia fields
    • Kafka fields
    • Kibana fields
    • Kubernetes fields
    • Kubernetes fields
    • kvm fields
    • Logstash fields
    • Memcached fields
    • MongoDB fields
    • Munin fields
    • MySQL fields
    • Nginx fields
    • PHP_FPM fields
    • PostgreSQL fields
    • Prometheus fields
    • RabbitMQ fields
    • Redis fields
    • System fields
    • traefik fields
    • uwsgi fields
    • vSphere fields
    • Windows fields
    • ZooKeeper fields
  • Monitoring Metricbeat
    • Configuration options
  • Securing Metricbeat
    • Secure communication with Elasticsearch
    • Secure communication with Logstash by using SSL
    • Use X-Pack security
      • Metricbeat features that require authorization
      • Configure authentication credentials
      • Grant users access to Metricbeat indices
      • Configure Metricbeat to use encrypted connections
      • Set the password for the built-in monitoring user
    • Use Linux Secure Computing Mode (seccomp)
  • Troubleshooting
    • Get help
    • Debug
    • Frequently asked questions
  • Contributing to Beats