Add Observer metadata
Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability This functionality is generally available and ready for production usage. Serverless interfaces and procedures might differ from classic Elastic Stack deployments. The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Serverless
Generally available
Stack
Generally available
This 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.
The add_observer_metadata processor annotates each event with relevant metadata from the observer machine.
- add_observer_metadata:
cache.ttl: 5m
geo:
name: nyc-dc1-rack1
location: 40.7128, -74.0060
continent_name: North America
country_iso_code: US
region_name: New York
region_iso_code: NY
city_name: New York
The fields added to the event look like this:
{
"observer" : {
"hostname" : "avce",
"type" : "heartbeat",
"vendor" : "elastic",
"ip" : [
"192.168.1.251",
"fe80::64b2:c3ff:fe5b:b974",
],
"mac" : [
"dc:c1:02:6f:1b:ed",
],
"geo": {
"continent_name": "North America",
"country_iso_code": "US",
"region_name": "New York",
"region_iso_code": "NY",
"city_name": "New York",
"name": "nyc-dc1-rack1",
"location": "40.7128, -74.0060"
}
}
}
Elastic Agent processors execute before ingest pipelines, which means that they process the raw event data rather than the final event sent to Elasticsearch. For related limitations, refer to What are some limitations of using processors?
| Name | Required | Default | Description |
|---|---|---|---|
netinfo.enabled |
No | true |
Whether to include IP addresses and MAC addresses as fields observer.ip and observer.mac. |
cache.ttl |
No | 5m |
Sets the cache expiration time for the internal cache used by the processor. Negative values disable caching altogether. |
geo.name |
No | User-definable token to be used for identifying a discrete location. Frequently a data center, rack, or similar. | |
geo.location |
No | Longitude and latitude in comma-separated format. | |
geo.continent_name |
No | Name of the continent. | |
geo.country_name |
No | Name of the country. | |
geo.region_name |
No | Name of the region. | |
geo.city_name |
No | Name of the city. | |
geo.country_iso_code |
No | ISO country code. | |
geo.region_iso_code |
No | ISO region code. |