Skip to content

Beats use of non-ECS field agent.hostname causing user confusion #16377

@MikePaquette

Description

@MikePaquette

During the introduction of ECS-support with the 7.0 release, some breaking changes were made in certain fields populated by beats.

Specifically, a new field agent.hostname was introduced - however this field is not an ECS field, and it's continued use and documentation are creating user confusion.

A recent SIEM discuss topic highlights the issue: 219088

Assumptions:

  • All module dashboards, apps, and other ECS data consumers should use the ECS field host.name to display general information about the host object.
  • In special cases, such as DNS, where the visualization is specifically looking for the hostname field, host.hostname may be used.
  • All beats that operate locally on a host should be populating host.name and host.hostname in their default configurations, either by enabling add_host_metadata, or some other means.
  • Beats that operate remotely, such as heartbeat, should be populating observer.hostname

Recommended changes:

  • Remove mention of agent.hostname from the beats docs and replace it with host.name and optionally host.hostname.
  • Change target of alias beat.hostname from agent.hostname to host.hostname in https://github.com/elastic/beats/blob/master/libbeat/_meta/fields.common.yml
  • Consider marking agent.hostname as deprecated and stop populating it in 8.0
  • Consider adding a new alias from agent.hostname to host.hostname once it is no longer populated, to enable any analysis content that used the agent.hostname field to continue to operate

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions