- Metricbeat Reference: other versions:
- Overview
- Contributing to Beats
- Getting started with Metricbeat
- Setting up and running Metricbeat
- Upgrading Metricbeat
- How Metricbeat works
- Configuring Metricbeat
- Specify which modules to run
- Specify general settings
- Load external configuration files
- Configure the internal queue
- Configure the output
- Specify SSL settings
- Filter and enhance the exported data
- Parse logs by using ingest node
- Set up project paths
- Set up the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Set up logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- metricbeat.reference.yml
- Modules
- Aerospike module
- Apache module
- Ceph module
- Couchbase module
- Docker module
- Dropwizard module
- Elasticsearch module
- Etcd module
- Golang module
- Graphite module
- HAProxy module
- HTTP module
- Jolokia module
- Kafka module
- Kibana module
- Kubernetes module
- 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 system metricset
- Kubernetes volume metricset
- Logstash module
- Memcached module
- MongoDB module
- MySQL module
- Nginx module
- PHP_FPM module
- PostgreSQL module
- Prometheus module
- RabbitMQ module
- Redis module
- System module
- vSphere module
- Windows module
- ZooKeeper module
- Exported fields
- Aerospike fields
- Apache fields
- Beat fields
- Ceph fields
- Cloud provider metadata fields
- Common fields
- Couchbase fields
- Docker fields
- Docker fields
- Dropwizard fields
- Elasticsearch fields
- Etcd fields
- Golang fields
- Graphite fields
- HAProxy fields
- HTTP fields
- Jolokia fields
- Kafka fields
- Kibana fields
- Kubernetes fields
- Kubernetes fields
- Logstash fields
- Memcached fields
- MongoDB fields
- MySQL fields
- Nginx fields
- PHP_FPM fields
- PostgreSQL fields
- Prometheus fields
- RabbitMQ fields
- Redis fields
- System fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Securing Metricbeat
- Troubleshooting
WARNING: Version 6.1 of Metricbeat has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Docker fields
editDocker fields
editDocker stats collected from Docker.
docker fields
editInformation and statistics about docker’s running containers.
container fields
editDocker container metrics.
docker.container.command
edittype: keyword
Command that was executed in the Docker container.
docker.container.created
edittype: date
Date when the container was created.
docker.container.status
edittype: keyword
Container status.
docker.container.ip_addresses
edittype: keyword
Container IP addresses.
size fields
editContainer size metrics.
docker.container.size.root_fs
edittype: long
Total size of all the files in the container.
docker.container.size.rw
edittype: long
Size of the files that have been created or changed since creation.
docker.container.tags
edittype: array
Image tags.
cpu fields
editRuntime CPU metrics.
docker.cpu.kernel.pct
edittype: scaled_float
format: percentage
The system kernel consumed by the Docker server.
docker.cpu.kernel.ticks
edittype: long
CPU kernel ticks.
docker.cpu.system.pct
edittype: scaled_float
format: percentage
docker.cpu.system.ticks
edittype: long
CPU system ticks.
docker.cpu.user.pct
edittype: scaled_float
format: percentage
docker.cpu.user.ticks
edittype: long
CPU user ticks
docker.cpu.total.pct
edittype: scaled_float
format: percentage
Total CPU usage.
diskio fields
editDisk I/O metrics.
docker.diskio.reads
edittype: scaled_float
Number of reads.
docker.diskio.writes
edittype: scaled_float
Number of writes.
docker.diskio.total
edittype: scaled_float
Number of reads and writes combined.
healthcheck fields
editDocker container metrics.
docker.healthcheck.failingstreak
edittype: integer
concurent failed check
docker.healthcheck.status
edittype: keyword
Healthcheck status code
event fields
editevent fields.
docker.healthcheck.event.end_date
edittype: date
Healthcheck end date
docker.healthcheck.event.start_date
edittype: date
Healthcheck start date
docker.healthcheck.event.output
edittype: keyword
Healthcheck output
docker.healthcheck.event.exit_code
edittype: integer
Healthcheck status code
image fields
editDocker image metrics.
id fields
editThe image layers identifier.
docker.image.id.current
edittype: keyword
Unique image identifier given upon its creation.
docker.image.id.parent
edittype: keyword
Identifier of the image, if it exists, from which the current image directly descends.
docker.image.created
edittype: date
Date and time when the image was created.
size fields
editImage size layers.
docker.image.size.virtual
edittype: long
Size of the image.
docker.image.size.regular
edittype: long
Total size of the all cached images associated to the current image.
docker.image.labels
edittype: object
Image labels.
docker.image.tags
edittype: array
Image tags.
info fields
editInfo metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information.
containers fields
editOverall container stats.
docker.info.containers.paused
edittype: long
Total number of paused containers.
docker.info.containers.running
edittype: long
Total number of running containers.
docker.info.containers.stopped
edittype: long
Total number of stopped containers.
docker.info.containers.total
edittype: long
Total number of existing containers.
docker.info.id
edittype: keyword
Unique Docker host identifier.
docker.info.images
edittype: long
Total number of existing images.
memory fields
editMemory metrics.
docker.memory.fail.count
edittype: scaled_float
Fail counter.
docker.memory.limit
edittype: long
format: bytes
Memory limit.
rss fields
editRSS memory stats.
docker.memory.rss.total
edittype: long
format: bytes
Total memory resident set size.
docker.memory.rss.pct
edittype: scaled_float
format: percentage
Memory resident set size percentage.
usage fields
editUsage memory stats.
docker.memory.usage.max
edittype: long
format: bytes
Max memory usage.
docker.memory.usage.pct
edittype: scaled_float
format: percentage
Memory usage percentage.
docker.memory.usage.total
edittype: long
format: bytes
Total memory usage.
network fields
editNetwork metrics.
docker.network.interface
edittype: keyword
Network interface name.
in fields
editIncoming network stats.
docker.network.in.bytes
edittype: long
format: bytes
Total number of incoming bytes.
docker.network.in.dropped
edittype: scaled_float
Total number of dropped incoming packets.
docker.network.in.errors
edittype: long
Total errors on incoming packets.
docker.network.in.packets
edittype: long
Total number of incoming packets.
out fields
editOutgoing network stats.
docker.network.out.bytes
edittype: long
format: bytes
Total number of outgoing bytes.
docker.network.out.dropped
edittype: scaled_float
Total number of dropped outgoing packets.
docker.network.out.errors
edittype: long
Total errors on outgoing packets.
docker.network.out.packets
edittype: long
Total number of outgoing packets.
On this page
- docker fields
- container fields
docker.container.command
docker.container.created
docker.container.status
docker.container.ip_addresses
- size fields
docker.container.size.root_fs
docker.container.size.rw
docker.container.tags
- cpu fields
docker.cpu.kernel.pct
docker.cpu.kernel.ticks
docker.cpu.system.pct
docker.cpu.system.ticks
docker.cpu.user.pct
docker.cpu.user.ticks
docker.cpu.total.pct
- diskio fields
docker.diskio.reads
docker.diskio.writes
docker.diskio.total
- healthcheck fields
docker.healthcheck.failingstreak
docker.healthcheck.status
- event fields
docker.healthcheck.event.end_date
docker.healthcheck.event.start_date
docker.healthcheck.event.output
docker.healthcheck.event.exit_code
- image fields
- id fields
docker.image.id.current
docker.image.id.parent
docker.image.created
- size fields
docker.image.size.virtual
docker.image.size.regular
docker.image.labels
docker.image.tags
- info fields
- containers fields
docker.info.containers.paused
docker.info.containers.running
docker.info.containers.stopped
docker.info.containers.total
docker.info.id
docker.info.images
- memory fields
docker.memory.fail.count
docker.memory.limit
- rss fields
docker.memory.rss.total
docker.memory.rss.pct
- usage fields
docker.memory.usage.max
docker.memory.usage.pct
docker.memory.usage.total
- network fields
docker.network.interface
- in fields
docker.network.in.bytes
docker.network.in.dropped
docker.network.in.errors
docker.network.in.packets
- out fields
docker.network.out.bytes
docker.network.out.dropped
docker.network.out.errors
docker.network.out.packets