- Metricbeat Reference: other versions:
- Overview
- 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
- Configure index lifecycle management
- Specify SSL settings
- Filter and enhance the exported data
- Define processors
- Add cloud metadata
- Add fields
- Add labels
- Add the local time zone
- Add tags
- Decode JSON fields
- Community ID Network Flow Hash
- Convert
- Drop events
- Drop fields from events
- Keep fields from events
- Rename fields from events
- Add Kubernetes metadata
- Add Docker metadata
- Add Host metadata
- Add Observer metadata
- Dissect strings
- DNS Reverse Lookup
- Add process metadata
- Extract array
- Parse data by using ingest node
- Enrich events with geoIP information
- Configure project paths
- Configure the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- metricbeat.reference.yml
- Beats central management
- Modules
- Aerospike module
- Apache module
- aws module
- Ceph module
- consul module
- coredns module
- Couchbase module
- couchdb module
- Docker module
- Dropwizard module
- 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 node metricset
- Elasticsearch node_stats metricset
- Elasticsearch pending_tasks metricset
- Elasticsearch shard metricset
- envoyproxy module
- Etcd module
- Golang module
- Graphite module
- HAProxy module
- HTTP module
- Jolokia module
- Kafka module
- Kibana module
- 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
- Logstash module
- Memcached module
- MongoDB module
- mssql module
- Munin module
- MySQL module
- Nats module
- Nginx module
- PHP_FPM module
- PostgreSQL module
- Prometheus module
- RabbitMQ module
- Redis module
- 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
- uwsgi module
- vSphere module
- Windows module
- ZooKeeper module
- Exported fields
- Aerospike fields
- Apache fields
- aws fields
- Beat fields
- Ceph fields
- Cloud provider metadata 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
- Golang fields
- Graphite fields
- HAProxy fields
- Host fields
- HTTP fields
- Jolokia fields
- Jolokia Discovery autodiscover provider fields
- Kafka fields
- Kibana fields
- Kubernetes fields
- Kubernetes fields
- kvm fields
- Logstash fields
- Memcached fields
- MongoDB fields
- mssql fields
- Munin fields
- MySQL fields
- Nats fields
- Nginx fields
- PHP_FPM fields
- PostgreSQL fields
- Process fields
- Prometheus fields
- RabbitMQ fields
- Redis fields
- System fields
- traefik fields
- uwsgi fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Monitoring Metricbeat
- Securing Metricbeat
- Troubleshooting
- Get help
- Debug
- Common problems
- "open /compat/linux/proc: no such file or directory" error on FreeBSD
- Metricbeat uses too much bandwidth
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- @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
- Contributing to Beats
Docker fields
editDocker fields
editDocker stats collected from Docker.
docker
editInformation and statistics about docker’s running containers.
container
editDocker 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
size
editContainer 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
cpu
editRuntime CPU metrics.
-
docker.cpu.kernel.pct
-
Percentage of time in kernel space.
type: scaled_float
format: percentage
-
docker.cpu.kernel.ticks
-
CPU ticks in kernel space.
type: long
-
docker.cpu.system.pct
-
Percentage of total CPU time in the system.
type: scaled_float
format: percentage
-
docker.cpu.system.ticks
-
CPU system ticks.
type: long
-
docker.cpu.user.pct
-
Percentage of time in user space.
type: scaled_float
format: percentage
-
docker.cpu.user.ticks
-
CPU ticks in user space.
type: long
-
docker.cpu.total.pct
-
Total CPU usage.
type: scaled_float
format: percentage
-
docker.cpu.core.*.pct
-
Percentage of CPU time in this core.
type: object
format: percentage
-
docker.cpu.core.*.ticks
-
Number of CPU ticks in this core.
type: object
diskio
editDisk I/O metrics.
read
editAccumulated 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.reads
-
[6.4] Deprecated in 6.4.
Number of current reads per second
type: scaled_float
write
editAccumulated 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.writes
-
[6.4] Deprecated in 6.4.
Number of current writes per second
type: scaled_float
summary
editAccumulated 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.total
-
[6.4] Deprecated in 6.4.
Number of reads and writes per second
type: scaled_float
event
editDocker 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
editActor
-
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
healthcheck
editDocker 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
editevent 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
image
editDocker image metrics.
id
editThe 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
size
editImage 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
editInfo metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information.
containers
editOverall 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
editMemory metrics.
-
docker.memory.fail.count
-
Fail counter.
type: scaled_float
-
docker.memory.limit
-
Memory limit.
type: long
format: bytes
rss
editRSS memory stats.
-
docker.memory.rss.total
-
Total memory resident set size.
type: long
format: bytes
-
docker.memory.rss.pct
-
Memory resident set size percentage.
type: scaled_float
format: percentage
usage
editUsage memory stats.
-
docker.memory.usage.max
-
Max memory usage.
type: long
format: bytes
-
docker.memory.usage.pct
-
Memory usage percentage.
type: scaled_float
format: percentage
-
docker.memory.usage.total
-
Total memory usage.
type: long
format: bytes
network
editNetwork metrics.
-
docker.network.interface
-
Network interface name.
type: keyword
in
editIncoming network stats per second.
-
docker.network.in.bytes
-
Total number of incoming bytes.
type: long
format: bytes
-
docker.network.in.dropped
-
Total number of dropped incoming packets.
type: scaled_float
-
docker.network.in.errors
-
Total errors on incoming packets.
type: long
-
docker.network.in.packets
-
Total number of incoming packets.
type: long
out
editOutgoing network stats per second.
-
docker.network.out.bytes
-
Total number of outgoing bytes.
type: long
format: bytes
-
docker.network.out.dropped
-
Total number of dropped outgoing packets.
type: scaled_float
-
docker.network.out.errors
-
Total errors on outgoing packets.
type: long
-
docker.network.out.packets
-
Total number of outgoing packets.
type: long
inbound
editIncoming 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
outbound
editOutgoing 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
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now