- 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
- community_id
- convert
- copy_fields
- decode_base64_field
- 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
- rate_limit
- registered_domain
- rename
- script
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- metricbeat.reference.yml
- How to guides
- Modules
- ActiveMQ module
- Aerospike module
- Apache module
- App Search module
- AWS module
- 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
- 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 ml_job metricset
- Elasticsearch node metricset
- Elasticsearch node_stats metricset
- Elasticsearch pending_tasks metricset
- Elasticsearch shard metricset
- Envoyproxy module
- Etcd module
- Google Cloud Platform module
- 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_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
- MongoDB module
- MSSQL module
- Munin module
- MySQL module
- NATS module
- Nginx module
- Openmetrics module
- Oracle module
- PHP_FPM module
- PostgreSQL module
- Prometheus module
- RabbitMQ module
- Redis module
- Redis Enterprise module
- SQL module
- Stan module
- Statsd 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
- Apache fields
- App Search 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
- Coredns fields
- Couchbase fields
- CouchDB fields
- Docker fields
- Docker fields
- Dropwizard fields
- ECS fields
- Elasticsearch 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
- 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
- System fields
- Tomcat fields
- Traefik fields
- uWSGI fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- 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
- Contribute to Beats
Google Cloud Platform compute metricset
editGoogle Cloud Platform compute metricset
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Compute metricset to fetch metrics from Compute Engine Virtual Machines in Google Cloud Platform. No Monitoring or Logging agent is required in your instances to use this metricset.
The compute
metricset contains all metrics exported from the Stackdriver API. The field names have been left untouched for people already familiar with them.
Extra labels and metadata are also extracted using the Compute API. This is enough to get most of the info associated with a metric like Compute labels and metadata and metric specific Labels.
Metrics and labels
editHere is a list of metrics collected by compute
metricset:
firewall
edit-
instance.firewall.dropped_bytes_count
: Incoming bytes dropped by the firewall.-
instance_name
: The name of the VM instance.
-
-
instance.firewall.dropped_packets_count
: Incoming packets dropped by the firewall.-
instance_name
: The name of the VM instance.
-
cpu
edit-
instance.cpu.reserved_cores
: Number of cores reserved on the host of theinstance
.-
instance_name
: The name of the VM instance.
-
-
instance.cpu.utilization
: The fraction of the allocated CPU that is currently in use on theinstance
.-
instance_name
: The name of the VM instance.
-
-
instance.cpu.usage_time
: Usage for all cores in seconds.-
instance_name
: The name of the VM instance.
-
disk
edit-
instance.disk.read_bytes_count
: Count of bytes read from disk.-
instance_name
: The name of the VM instance. -
device_name
: The name of the disk device. -
storage_type
: The storage type:pd-standard
,pd-ssd
, orlocal-ssd
. -
device_type
: The disk type:ephemeral
orpermanent
.
-
-
instance.disk.read_ops_count
: Count of disk read IO operations.-
instance_name
: The name of the VM instance. -
device_name
: The name of the disk device. -
storage_type
: The storage type:pd-standard
,pd-ssd
, orlocal-ssd
. -
device_type
: The disk type:ephemeral
orpermanent
.
-
-
instance.disk.write_bytes_count
: Count of bytes written to disk-
instance_name
: The name of the VM instance. -
device_name
: The name of the disk device. -
storage_type
: The storage type:pd-standard
,pd-ssd
, orlocal-ssd
. -
device_type
: The disk type:ephemeral
orpermanent
.
-
-
instance.disk.write_ops_count
: Count of disk write IO operations.-
instance_name
: The name of the VM instance. -
device_name
: The name of the disk device. -
storage_type
: The storage type:pd-standard
,pd-ssd
, orlocal-ssd
. -
device_type
: The disk type:ephemeral
orpermanent
.
-
uptime
edit-
instance.uptime
: How long the VM has been running, in seconds-
instance_name
: The name of the VM instance.
-
network
edit-
instance.network.received_bytes_count
: Count of bytes received from the network-
instance_name
: The name of the VM instance. -
loadBalanced
: Whether traffic was sent from an L3 loadbalanced IP address assigned to the VM. Traffic that is externally routed from the VM’s standard internal or external IP address, such as L7 loadbalanced traffic, is not considered to be loadbalanced in this metric.
-
-
instance.network.received_packets_count
: Count of packets received from the network-
instance_name
: The name of the VM instance. -
loadBalanced
: Whether traffic was sent from an L3 loadbalanced IP address assigned to the VM. Traffic that is externally routed from the VM’s standard internal or external IP address, such as L7 loadbalanced traffic, is not considered to be loadbalanced in this metric.
-
-
instance.network.sent_bytes_count
: Count of bytes sent over the network-
instance_name
: The name of the VM instance. -
loadBalanced
: Whether traffic was sent from an L3 loadbalanced IP address assigned to the VM. Traffic that is externally routed from the VM’s standard internal or external IP address, such as L7 loadbalanced traffic, is not considered to be loadbalanced in this metric.
-
-
instance.network.sent_packets_count
: Count of packets sent over the network-
instance_name
: The name of the VM instance. -
loadBalanced
: Whether traffic was sent from an L3 loadbalanced IP address assigned to the VM. Traffic that is externally routed from the VM’s standard internal or external IP address, such as L7 loadbalanced traffic, is not considered to be loadbalanced in this metric.
-
memory
edit-
instance.memory.balloon.ram_size
: The total amount of memory in the VM. This metric is only available for VMs that belong to the e2 family.-
instance_name
: The name of the VM instance.
-
-
instance.memory.balloon.ram_used
: Memory currently used in the VM. This metric is only available for VMs that belong to the e2 family.-
instance_name
: The name of the VM instance.
-
-
instance.memory.balloon.swap_in_bytes_count
: The amount of memory read into the guest from its own swap space. This metric is only available for VMs that belong to the e2 family.-
instance_name
: The name of the VM instance.
-
-
instance.memory.balloon.swap_out_bytes_count
: The amount of memory written from the guest to its own swap space. This metric is only available for VMs that belong to the e2 family.-
instance_name
: The name of the VM instance.
-
This is a default metricset. If the host module is unconfigured, this metricset is enabled by default.
Fields
editFor a description of each field in the metricset, see the exported fields section.
Here is an example document generated by this metricset:
{ "@timestamp": "2017-10-12T08:05:34.853Z", "cloud": { "account": { "id": "elastic-observability", "name": "elastic-observability" }, "instance": { "id": "1113015278728017638", "name": "gke-apm-ci-k8s-cluster-pool-2-e8852348-58mx" }, "provider": "gcp" }, "cloud.availability_zone": "us-central1-c", "cloud.region": "us-central1", "event": { "dataset": "gcp.compute", "duration": 115000, "module": "gcp" }, "gcp": { "compute": { "instance": { "disk": { "read_bytes_count": { "value": 989296850 }, "read_ops_count": { "value": 14862 }, "write_bytes_count": { "value": 1323095 }, "write_ops_count": { "value": 105 } } } }, "labels": { "metrics": { "device_name": "gke-apm-ci-k8s-cluster-pool-2-e8852348-58mx", "device_type": "permanent", "storage_type": "pd-standard" } } }, "host": { "disk": { "read": { "bytes": 989296850 }, "write": { "bytes": 1323095 } }, "id": "1113015278728017638", "name": "gke-apm-ci-k8s-cluster-pool-2-e8852348-58mx" }, "metricset": { "name": "compute", "period": 10000 }, "service": { "type": "gcp" } }