- 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
- append
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_duration
- 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
- move_fields
- rate_limit
- registered_domain
- rename
- replace
- script
- syslog
- translate_ldap_attribute
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- Feature flags
- metricbeat.reference.yml
- How to guides
- Modules
- ActiveMQ module
- Aerospike module
- Airflow module
- Apache module
- AWS module
- AWS awshealth metricset
- 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
- Containerd 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 ingest_pipeline metricset
- Elasticsearch ml_job metricset
- Elasticsearch node metricset
- Elasticsearch node_stats metricset
- Elasticsearch pending_tasks metricset
- Elasticsearch shard metricset
- Enterprise Search module
- Envoyproxy module
- Etcd module
- Google Cloud Platform module
- Google Cloud Platform billing metricset
- Google Cloud Platform carbon metricset
- Google Cloud Platform compute metricset
- Google Cloud Platform dataproc metricset
- Google Cloud Platform firestore metricset
- Google Cloud Platform gke metricset
- Google Cloud Platform loadbalancing metricset
- Google Cloud Platform metrics metricset
- Google Cloud Platform pubsub metricset
- Google Cloud Platform storage metricset
- 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_job 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
- Cisco Meraki module
- MongoDB module
- MSSQL module
- Munin module
- MySQL module
- NATS module
- Nginx module
- Openmetrics module
- Oracle module
- Panw module
- PHP_FPM module
- PostgreSQL module
- Prometheus module
- RabbitMQ module
- Redis module
- Redis Enterprise module
- SQL module
- Stan module
- Statsd module
- SyncGateway 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
- Airflow fields
- Apache 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
- Containerd fields
- Coredns fields
- Couchbase fields
- CouchDB fields
- Docker fields
- Docker fields
- Dropwizard fields
- ECS fields
- Elasticsearch fields
- Enterprise Search 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
- Panw 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
- SyncGateway fields
- System fields
- Tomcat fields
- Traefik fields
- uWSGI fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- Understand logged metrics
- 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
- High RSS memory usage due to MADV settings
- Contribute to Beats
Docker stats collected from Docker.
Information and statistics about docker’s running containers.
Docker container metrics.
-
docker.container.command
-
Command that was executed in the Docker container.
type: keyword
-
docker.container.created
-
Date when the container was created.
type: date
-
docker.container.status
-
Container status.
type: keyword
-
docker.container.ip_addresses
-
Container IP addresses.
type: ip
Container size metrics.
-
docker.container.size.root_fs
-
Total size of all the files in the container.
type: long
-
docker.container.size.rw
-
Size of the files that have been created or changed since creation.
type: long
-
docker.container.tags
-
Image tags.
type: keyword
Runtime CPU metrics.
-
docker.cpu.kernel.pct
-
Percentage of time in kernel space, expressed as a value between 0 and 1.
type: scaled_float
format: percent
-
docker.cpu.kernel.norm.pct
-
Percentage of time in kernel space normalized by the number of CPU cores, expressed as a value between 0 and 1.
type: scaled_float
format: percent
-
docker.cpu.kernel.ticks
-
CPU ticks in kernel space.
type: long
-
docker.cpu.system.pct
-
Percentage of total CPU time in the system, expressed as a value between 0 and 1.
type: scaled_float
format: percent
-
docker.cpu.system.norm.pct
-
Percentage of total CPU time in the system normalized by the number of CPU cores, expressed as a value between 0 and 1.
type: scaled_float
format: percent
-
docker.cpu.system.ticks
-
CPU system ticks.
type: long
-
docker.cpu.user.pct
-
Percentage of time in user space, expressed as a value between 0 and 1.
type: scaled_float
format: percent
-
docker.cpu.user.norm.pct
-
Percentage of time in user space normalized by the number of CPU cores, expressed as a value between 0 and 1.
type: scaled_float
format: percent
-
docker.cpu.user.ticks
-
CPU ticks in user space.
type: long
-
docker.cpu.total.pct
-
Total CPU usage.
type: scaled_float
format: percent
-
docker.cpu.total.norm.pct
-
Total CPU usage normalized by the number of CPU cores.
type: scaled_float
format: percent
-
docker.cpu.core.*.pct
-
Percentage of CPU time in this core, expressed as a value between 0 and 1.
type: object
format: percent
-
docker.cpu.core.*.norm.pct
-
Percentage of CPU time in this core normalized by the number of CPU cores, expressed as a value between 0 and 1.
type: object
format: percent
-
docker.cpu.core.*.ticks
-
Number of CPU ticks in this core.
type: object
Disk I/O metrics.
Accumulated reads during the life of the container
-
docker.diskio.read.ops
-
Number of reads during the life of the container
type: long
-
docker.diskio.read.bytes
-
Bytes read during the life of the container
type: long
format: bytes
-
docker.diskio.read.rate
-
Number of current reads per second
type: long
-
docker.diskio.read.service_time
-
Total time to service IO requests, in nanoseconds
type: long
-
docker.diskio.read.wait_time
-
Total time requests spent waiting in queues for service, in nanoseconds
type: long
-
docker.diskio.read.queued
-
Total number of queued requests
type: long
Accumulated writes during the life of the container
-
docker.diskio.write.ops
-
Number of writes during the life of the container
type: long
-
docker.diskio.write.bytes
-
Bytes written during the life of the container
type: long
format: bytes
-
docker.diskio.write.rate
-
Number of current writes per second
type: long
-
docker.diskio.write.service_time
-
Total time to service IO requests, in nanoseconds
type: long
-
docker.diskio.write.wait_time
-
Total time requests spent waiting in queues for service, in nanoseconds
type: long
-
docker.diskio.write.queued
-
Total number of queued requests
type: long
Accumulated reads and writes during the life of the container
-
docker.diskio.summary.ops
-
Number of I/O operations during the life of the container
type: long
-
docker.diskio.summary.bytes
-
Bytes read and written during the life of the container
type: long
format: bytes
-
docker.diskio.summary.rate
-
Number of current operations per second
type: long
-
docker.diskio.summary.service_time
-
Total time to service IO requests, in nanoseconds
type: long
-
docker.diskio.summary.wait_time
-
Total time requests spent waiting in queues for service, in nanoseconds
type: long
-
docker.diskio.summary.queued
-
Total number of queued requests
type: long
Docker event
-
docker.event.status
-
Event status
type: keyword
-
docker.event.id
-
Event id when available
type: keyword
-
docker.event.from
-
Event source
type: keyword
-
docker.event.type
-
The type of object emitting the event
type: keyword
-
docker.event.action
-
The type of event
type: keyword
Actor
-
docker.event.actor.id
-
The ID of the object emitting the event
type: keyword
-
docker.event.actor.attributes
-
Various key/value attributes of the object, depending on its type
type: object
Docker healthcheck metrics.
Healthcheck data will only be available from docker containers where the docker HEALTHCHECK
instruction has been used to build the docker image.
-
docker.healthcheck.failingstreak
-
concurent failed check
type: integer
-
docker.healthcheck.status
-
Healthcheck status code
type: keyword
event fields.
-
docker.healthcheck.event.end_date
-
Healthcheck end date
type: date
-
docker.healthcheck.event.start_date
-
Healthcheck start date
type: date
-
docker.healthcheck.event.output
-
Healthcheck output
type: keyword
-
docker.healthcheck.event.exit_code
-
Healthcheck status code
type: integer
Docker image metrics.
The image layers identifier.
-
docker.image.id.current
-
Unique image identifier given upon its creation.
type: keyword
-
docker.image.id.parent
-
Identifier of the image, if it exists, from which the current image directly descends.
type: keyword
-
docker.image.created
-
Date and time when the image was created.
type: date
Image size layers.
-
docker.image.size.virtual
-
Size of the image.
type: long
-
docker.image.size.regular
-
Total size of the all cached images associated to the current image.
type: long
-
docker.image.labels
-
Image labels.
type: object
-
docker.image.tags
-
Image tags.
type: keyword
Info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information.
Overall container stats.
-
docker.info.containers.paused
-
Total number of paused containers.
type: long
-
docker.info.containers.running
-
Total number of running containers.
type: long
-
docker.info.containers.stopped
-
Total number of stopped containers.
type: long
-
docker.info.containers.total
-
Total number of existing containers.
type: long
-
docker.info.id
-
Unique Docker host identifier.
type: keyword
-
docker.info.images
-
Total number of existing images.
type: long
Memory metrics.
-
docker.memory.stats.*
-
Raw memory stats from the cgroups memory.stat interface
type: object
Committed bytes on Windows
-
docker.memory.commit.total
-
Total bytes
type: long
format: bytes
-
docker.memory.commit.peak
-
Peak committed bytes on Windows
type: long
format: bytes
-
docker.memory.private_working_set.total
-
private working sets on Windows
type: long
format: bytes
-
docker.memory.fail.count
-
Fail counter.
type: scaled_float
-
docker.memory.limit
-
Memory limit.
type: long
format: bytes
RSS memory stats.
-
docker.memory.rss.total
-
Total memory resident set size.
type: long
format: bytes
-
docker.memory.rss.pct
-
Memory resident set size percentage, expressed as a value between 0 and 1.
type: scaled_float
format: percent
Usage memory stats.
-
docker.memory.usage.max
-
Max memory usage.
type: long
format: bytes
-
docker.memory.usage.pct
-
Memory usage percentage, expressed as a value between 0 and 1.
type: scaled_float
format: percent
-
docker.memory.usage.total
-
Total memory usage.
type: long
format: bytes
Network metrics.
-
docker.network.interface
-
Network interface name.
type: keyword
Incoming network stats per second.
-
docker.network.in.bytes
-
Incoming bytes per seconds.
type: long
format: bytes
-
docker.network.in.dropped
-
Dropped incoming packets per second.
type: scaled_float
-
docker.network.in.errors
-
Errors on incoming packets per second.
type: long
-
docker.network.in.packets
-
Incoming packets per second.
type: long
Outgoing network stats per second.
-
docker.network.out.bytes
-
Outgoing bytes per second.
type: long
format: bytes
-
docker.network.out.dropped
-
Dropped outgoing packets per second.
type: scaled_float
-
docker.network.out.errors
-
Errors on outgoing packets per second.
type: long
-
docker.network.out.packets
-
Outgoing packets per second.
type: long
Incoming network stats since the container started.
-
docker.network.inbound.bytes
-
Total number of incoming bytes.
type: long
format: bytes
-
docker.network.inbound.dropped
-
Total number of dropped incoming packets.
type: long
-
docker.network.inbound.errors
-
Total errors on incoming packets.
type: long
-
docker.network.inbound.packets
-
Total number of incoming packets.
type: long
Outgoing network stats since the container started.
-
docker.network.outbound.bytes
-
Total number of outgoing bytes.
type: long
format: bytes
-
docker.network.outbound.dropped
-
Total number of dropped outgoing packets.
type: long
-
docker.network.outbound.errors
-
Total errors on outgoing packets.
type: long
-
docker.network.outbound.packets
-
Total number of outgoing packets.
type: long
network_summary
-
docker.network_summary.ip.*
-
IP counters
type: object
-
docker.network_summary.tcp.*
-
TCP counters
type: object
-
docker.network_summary.udp.*
-
UDP counters
type: object
-
docker.network_summary.udp_lite.*
-
UDP Lite counters
type: object
-
docker.network_summary.icmp.*
-
ICMP counters
type: object
-
docker.network_summary.namespace.pid
-
The root PID of the container, corresponding to /proc/[pid]/net
type: long
-
docker.network_summary.namespace.id
-
The ID of the network namespace used by the container, corresponding to /proc/[pid]/ns/net
type: long
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now