- 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
vSphere module
Cluster information.
-
vsphere.cluster.datastore.names
-
List of all the datastore names associated with the cluster.
type: keyword
-
vsphere.cluster.datastore.count
-
Number of datastores associated with the cluster.
type: long
-
vsphere.cluster.das_config.admission.control.enabled
-
Indicates whether strict admission control is enabled.
type: boolean
-
vsphere.cluster.das_config.enabled
-
Indicates whether vSphere HA feature is enabled.
type: boolean
-
vsphere.cluster.host.count
-
Number of hosts associated with the cluster.
type: long
-
vsphere.cluster.host.names
-
List of all the host names associated with the cluster.
type: keyword
-
vsphere.cluster.id
-
Unique cluster ID.
type: keyword
-
vsphere.cluster.name
-
Cluster name.
type: keyword
-
vsphere.cluster.network.count
-
Number of networks associated with the cluster.
type: long
-
vsphere.cluster.network.names
-
List of all the network names associated with the cluster.
type: keyword
-
vsphere.cluster.triggered_alarms.*
-
List of all the triggered alarms.
type: object
datastore
-
vsphere.datastore.capacity.free.bytes
-
Free bytes of the datastore.
type: long
format: bytes
-
vsphere.datastore.capacity.total.bytes
-
Total bytes of the datastore.
type: long
format: bytes
-
vsphere.datastore.capacity.used.bytes
-
Used bytes of the datastore.
type: long
format: bytes
-
vsphere.datastore.capacity.used.pct
-
Percentage of datastore capacity used.
type: scaled_float
format: percent
-
vsphere.datastore.disk.capacity.bytes
-
Configured size of the datastore.
type: long
format: bytes
-
vsphere.datastore.disk.capacity.usage.bytes
-
The amount of storage capacity currently being consumed by datastore.
type: long
format: bytes
-
vsphere.datastore.disk.provisioned.bytes
-
Amount of storage set aside for use by a datastore.
type: long
format: bytes
-
vsphere.datastore.fstype
-
Filesystem type.
type: keyword
-
vsphere.datastore.host.count
-
Number of hosts.
type: long
-
vsphere.datastore.host.names
-
List of all the host names.
type: keyword
-
vsphere.datastore.id
-
Unique datastore ID.
type: keyword
-
vsphere.datastore.name
-
Datastore name.
type: keyword
-
vsphere.datastore.read.bytes
-
Rate of reading data from the datastore.
type: long
format: bytes
-
vsphere.datastore.status
-
Status of the datastore.
type: keyword
-
vsphere.datastore.triggered_alarms.*
-
List of all the triggered alarms.
type: object
-
vsphere.datastore.vm.count
-
Number of VMs.
type: long
-
vsphere.datastore.vm.names
-
List of all the VM names.
type: keyword
-
vsphere.datastore.write.bytes
-
Rate of writing data to the datastore.
type: long
format: bytes
Datastore Cluster
-
vsphere.datastorecluster.id
-
Unique datastore cluster ID.
type: keyword
-
vsphere.datastorecluster.name
-
The datastore cluster name.
type: keyword
-
vsphere.datastorecluster.capacity.bytes
-
Total capacity of this storage pod, in bytes.
type: long
format: bytes
-
vsphere.datastorecluster.free_space.bytes
-
Total free space on this storage pod, in bytes.
type: long
format: bytes
-
vsphere.datastorecluster.datastore.names
-
List of all the datastore names associated with the datastore cluster.
type: keyword
-
vsphere.datastorecluster.datastore.count
-
Number of datastores in the datastore cluster.
type: long
-
vsphere.datastorecluster.triggered_alarms.*
-
List of all the triggered alarms.
type: object
Host information from vSphere environment.
-
vsphere.host.cpu.used.mhz
-
Used CPU in MHz.
type: long
-
vsphere.host.cpu.total.mhz
-
Total CPU in MHz.
type: long
-
vsphere.host.cpu.free.mhz
-
Free CPU in MHz.
type: long
-
vsphere.host.datastore.names
-
List of all the datastore names.
type: keyword
-
vsphere.host.datastore.count
-
Number of datastores on the host.
type: long
-
vsphere.host.disk.capacity.usage.bytes
-
The amount of storage capacity currently being consumed by or on the entity.
type: long
format: bytes
-
vsphere.host.disk.devicelatency.average.ms
-
Average amount of time it takes to complete an SCSI command from physical device in milliseconds.
type: long
-
vsphere.host.disk.latency.total.ms
-
Highest latency value across all disks used by the host in milliseconds.
type: long
-
vsphere.host.disk.read.bytes
-
Average number of bytes read from the disk each second.
type: long
format: bytes
-
vsphere.host.disk.write.bytes
-
Average number of bytes written to the disk each second.
type: long
format: bytes
-
vsphere.host.disk.total.bytes
-
Sum of disk read and write rates each second in bytes.
type: long
format: bytes
-
vsphere.host.id
-
Unique host ID.
type: keyword
-
vsphere.host.memory.free.bytes
-
Free Memory in bytes.
type: long
format: bytes
-
vsphere.host.memory.total.bytes
-
Total Memory in bytes.
type: long
format: bytes
-
vsphere.host.memory.used.bytes
-
Used Memory in bytes.
type: long
format: bytes
-
vsphere.host.name
-
Host name.
type: keyword
-
vsphere.host.network_names
-
Network names.
type: keyword
-
vsphere.host.network.names
-
List of all the network names.
type: keyword
-
vsphere.host.network.count
-
Number of networks on the host.
type: long
-
vsphere.host.network.bandwidth.transmitted.bytes
-
Average rate at which data was transmitted during the interval. This represents the bandwidth of the network.
type: long
format: bytes
-
vsphere.host.network.bandwidth.received.bytes
-
Average rate at which data was received during the interval. This represents the bandwidth of the network.
type: long
format: bytes
-
vsphere.host.network.bandwidth.total.bytes
-
Sum of network transmitted and received rates in bytes during the interval.
type: long
format: bytes
-
vsphere.host.network.packets.transmitted.count
-
Number of packets transmitted.
type: long
-
vsphere.host.network.packets.received.count
-
Number of packets received.
type: long
-
vsphere.host.network.packets.errors.transmitted.count
-
Number of packets with errors transmitted.
type: long
-
vsphere.host.network.packets.errors.received.count
-
Number of packets with errors received.
type: long
-
vsphere.host.network.packets.errors.total.count
-
Total number of packets with errors.
type: long
-
vsphere.host.network.packets.multicast.transmitted.count
-
Number of multicast packets transmitted.
type: long
-
vsphere.host.network.packets.multicast.received.count
-
Number of multicast packets received.
type: long
-
vsphere.host.network.packets.multicast.total.count
-
Total number of multicast packets.
type: long
-
vsphere.host.network.packets.dropped.transmitted.count
-
Number of transmitted packets dropped.
type: long
-
vsphere.host.network.packets.dropped.received.count
-
Number of received packets dropped.
type: long
-
vsphere.host.network.packets.dropped.total.count
-
Total number of packets dropped.
type: long
-
vsphere.host.status
-
The overall health status of a host in the vSphere environment.
type: keyword
-
vsphere.host.triggered_alarms.*
-
List of all the triggered alarms.
type: object
-
vsphere.host.uptime
-
The total uptime of a host in seconds within the vSphere environment.
type: long
-
vsphere.host.vm.names
-
List of all the VM names.
type: keyword
-
vsphere.host.vm.count
-
Number of virtual machines on the host.
type: long
Network-related information.
-
vsphere.network.accessible
-
Indicates whether at least one host is configured to provide this network.
type: boolean
-
vsphere.network.config.status
-
Indicates whether the system has detected a configuration issue.
type: keyword
-
vsphere.network.host.names
-
Names of the hosts connected to this network.
type: keyword
-
vsphere.network.host.count
-
Number of hosts connected to this network.
type: long
-
vsphere.network.id
-
Unique network ID.
type: keyword
-
vsphere.network.name
-
Name of the network.
type: keyword
-
vsphere.network.status
-
General health of the network.
type: keyword
-
vsphere.network.type
-
Type of the network (e.g., Network(Standard), DistributedVirtualport).
type: keyword
-
vsphere.network.vm.names
-
Names of the virtual machines connected to this network.
type: keyword
-
vsphere.network.vm.count
-
Number of virtual machines connected to this network.
type: long
-
vsphere.network.triggered_alarms.*
-
List of all the triggered alarms.
type: object
Resource pool information from vSphere environment.
-
vsphere.resourcepool.cpu.usage.mhz
-
Basic CPU performance statistics, in MHz.
type: long
-
vsphere.resourcepool.cpu.demand.mhz
-
Basic CPU performance statistics, in MHz.
type: long
-
vsphere.resourcepool.cpu.entitlement.mhz
-
The amount of CPU resource, in MHz, that this VM is entitled to, as calculated by DRS.
type: long
-
vsphere.resourcepool.cpu.entitlement.static.mhz
-
The static CPU resource entitlement for a virtual machine.
type: long
-
vsphere.resourcepool.id
-
Unique resource pool ID.
type: keyword
-
vsphere.resourcepool.memory.usage.guest.bytes
-
Guest memory utilization statistics, in bytes.
type: long
format: bytes
-
vsphere.resourcepool.memory.usage.host.bytes
-
Host memory utilization statistics, in bytes.
type: long
format: bytes
-
vsphere.resourcepool.memory.entitlement.bytes
-
The amount of memory, in bytes, that this VM is entitled to, as calculated by DRS.
type: long
format: bytes
-
vsphere.resourcepool.memory.entitlement.static.bytes
-
The static memory resource entitlement for a virtual machine, in bytes.
type: long
format: bytes
-
vsphere.resourcepool.memory.private.bytes
-
The portion of memory, in bytes, that is granted to a virtual machine from non-shared host memory.
type: long
format: bytes
-
vsphere.resourcepool.memory.shared.bytes
-
The portion of memory, in bytes, that is granted to a virtual machine from host memory that is shared between VMs.
type: long
format: bytes
-
vsphere.resourcepool.memory.swapped.bytes
-
The portion of memory, in bytes, that is granted to a virtual machine from the host’s swap space.
type: long
format: bytes
-
vsphere.resourcepool.memory.ballooned.bytes
-
The size of the balloon driver in a virtual machine, in bytes.
type: long
format: bytes
-
vsphere.resourcepool.memory.overhead.bytes
-
The amount of memory resource (in bytes) that will be used by a virtual machine above its guest memory requirements.
type: long
format: bytes
-
vsphere.resourcepool.memory.overhead.consumed.bytes
-
The amount of overhead memory, in bytes, currently being consumed to run a VM.
type: long
format: bytes
-
vsphere.resourcepool.memory.compressed.bytes
-
The amount of compressed memory currently consumed by VM, in bytes.
type: long
format: bytes
-
vsphere.resourcepool.name
-
The name of the resource pool.
type: keyword
-
vsphere.resourcepool.status
-
The overall health status of a host in the vSphere environment.
type: keyword
-
vsphere.resourcepool.vm.count
-
Number of virtual machines on the resource pool.
type: long
-
vsphere.resourcepool.vm.names
-
Names of virtual machines on the resource pool.
type: keyword
-
vsphere.resourcepool.triggered_alarms.*
-
List of all the triggered alarms.
type: object
virtualmachine
-
vsphere.virtualmachine.host.id
-
Host id.
type: keyword
-
vsphere.virtualmachine.host.hostname
-
Hostname of the host.
type: keyword
-
vsphere.virtualmachine.id
-
Unique virtual machine ID.
type: keyword
-
vsphere.virtualmachine.name
-
Virtual machine name.
type: keyword
-
vsphere.virtualmachine.os
-
Virtual machine Operating System name.
type: keyword
-
vsphere.virtualmachine.cpu.used.mhz
-
Used CPU in Mhz.
type: long
-
vsphere.virtualmachine.cpu.total.mhz
-
Total Reserved CPU in Mhz.
type: long
-
vsphere.virtualmachine.cpu.free.mhz
-
Available CPU in Mhz.
type: long
-
vsphere.virtualmachine.memory.used.guest.bytes
-
Used memory of Guest in bytes.
type: long
format: bytes
-
vsphere.virtualmachine.memory.used.host.bytes
-
Used memory of Host in bytes.
type: long
format: bytes
-
vsphere.virtualmachine.memory.total.guest.bytes
-
Total memory of Guest in bytes.
type: long
format: bytes
-
vsphere.virtualmachine.memory.free.guest.bytes
-
Free memory of Guest in bytes.
type: long
format: bytes
-
vsphere.virtualmachine.custom_fields
-
Custom fields.
type: object
-
vsphere.virtualmachine.network_names
-
Network names.
type: keyword
-
vsphere.virtualmachine.datastore.names
-
Names of the datastore associated to this virtualmachine.
type: keyword
-
vsphere.virtualmachine.datastore.count
-
Number of datastores associated to this virtualmachine.
type: long
-
vsphere.virtualmachine.network.names
-
Names of the networks associated to this virtualmachine.
type: keyword
-
vsphere.virtualmachine.network.count
-
Number of networks associated to this virtualmachine.
type: long
-
vsphere.virtualmachine.status
-
Overall health and status of a virtual machine.
type: keyword
-
vsphere.virtualmachine.uptime
-
The uptime of the VM in seconds.
type: long
-
vsphere.virtualmachine.snapshot.info.*
-
Details of the snapshots of this virtualmachine.
type: object
-
vsphere.virtualmachine.snapshot.count
-
The number of snapshots of this virtualmachine.
type: long
-
vsphere.virtualmachine.triggered_alarms.*
-
List of all the triggered alarms.
type: object