- Auditbeat Reference: other versions:
- Overview
- Getting started with Auditbeat
- Breaking changes in 6.2
- Setting up and running Auditbeat
- Configuring Auditbeat
- Specify which modules to run
- Specify general settings
- Reload the configuration dynamically
- 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
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- auditbeat.reference.yml
- Modules
- Exported fields
- Monitoring Auditbeat
- Securing Auditbeat
- Troubleshooting
- Contributing to Beats
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" } } }
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now