- 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
- Specify SSL settings
- Filter and enhance the exported data
- Parse data by using ingest node
- Set up project paths
- Set up 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
- Modules
- Aerospike module
- Apache module
- Ceph module
- Couchbase module
- Docker module
- Dropwizard module
- Elasticsearch module
- Elasticsearch cluster_stats metricset
- Elasticsearch index metricset
- Elasticsearch index_recovery metricset
- Elasticsearch index_summary metricset
- Elasticsearch ml_job metricset
- elasticsearch ml_job MetricSet
- Elasticsearch node metricset
- Elasticsearch node_stats metricset
- Elasticsearch pending_tasks 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
- Munin module
- MySQL 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 uptime metricset
- traefik module
- uwsgi 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
- envoyproxy fields
- Etcd fields
- Golang fields
- Graphite fields
- HAProxy fields
- Host fields
- HTTP fields
- Jolokia fields
- Kafka fields
- Kibana fields
- Kubernetes fields
- Kubernetes fields
- kvm fields
- Logstash fields
- Memcached fields
- MongoDB fields
- Munin fields
- MySQL fields
- Nginx fields
- PHP_FPM fields
- PostgreSQL fields
- Prometheus fields
- RabbitMQ fields
- Redis fields
- System fields
- traefik fields
- uwsgi fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Monitoring Metricbeat
- Securing Metricbeat
- Troubleshooting
- Contributing to Beats
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Add cloud metadata
editAdd cloud metadata
editThe add_cloud_metadata processor enriches each event with instance metadata
from the machine’s hosting provider. At startup it will detect the hosting
provider and cache the instance metadata.
The following cloud providers are supported:
- Amazon Elastic Compute Cloud (EC2)
- Digital Ocean
- Google Compute Engine (GCE)
- Tencent Cloud (QCloud)
- Alibaba Cloud (ECS)
- Azure Virtual Machine
- Openstack Nova
The simple configuration below enables the processor.
processors: - add_cloud_metadata: ~
The add_cloud_metadata processor has one optional configuration setting named
timeout that specifies the maximum amount of time to wait for a successful
response when detecting the hosting provider. The default timeout value is
3s.
If a timeout occurs then no instance metadata will be added to the events. This makes it possible to enable this processor for all your deployments (in the cloud or on-premise).
The metadata that is added to events varies by hosting provider. Below are examples for each of the supported providers.
EC2
{ "meta": { "cloud": { "availability_zone": "us-east-1c", "instance_id": "i-4e123456", "machine_type": "t2.medium", "provider": "ec2", "region": "us-east-1" } } }
Digital Ocean
{ "meta": { "cloud": { "instance_id": "1234567", "provider": "digitalocean", "region": "nyc2" } } }
GCE
{ "meta": { "cloud": { "availability_zone": "projects/1234567890/zones/us-east1-b", "instance_id": "1234556778987654321", "machine_type": "projects/1234567890/machineTypes/f1-micro", "project_id": "my-dev", "provider": "gce" } } }
Tencent Cloud
{ "meta": { "cloud": { "availability_zone": "gz-azone2", "instance_id": "ins-qcloudv5", "provider": "qcloud", "region": "china-south-gz" } } }
Alibaba Cloud
This metadata is only available when VPC is selected as the network type of the ECS instance.
{ "meta": { "cloud": { "availability_zone": "cn-shenzhen", "instance_id": "i-wz9g2hqiikg0aliyun2b", "provider": "ecs", "region": "cn-shenzhen-a" } } }
Azure Virtual Machine
{ "meta": { "cloud": { "provider": "az", "instance_id": "04ab04c3-63de-4709-a9f9-9ab8c0411d5e", "instance_name": "test-az-vm", "machine_type": "Standard_D3_v2", "region": "eastus2" } } }
Openstack Nova
{ "meta": { "cloud": { "provider": "openstack", "instance_name": "test-998d932195.mycloud.tld", "availability_zone": "xxxx-az-c", "instance_id": "i-00011a84", "machine_type": "m2.large" } } }
Was this helpful?
Thank you for your feedback.