Remove agent.hostname field from libbeat by andrewkroh · Pull Request #18328 · elastic/beats

andrewkroh · 2020-05-06T22:07:42Z

What does this PR do?

agent.hostname is not part of ECS so this removes the field. Instead the
agent.name field can be used for this purpose and it it part of ECS.
This add an alias pointing from agent.hostname to agent.name. The alias
can be removed once we confirm all the Kibana apps are migrated to agent.name
for 8.0.

This will not be part of 7.x.

Why is it important?

From #16377

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.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
~~[ ] I have made corresponding change to the default configuration files~~
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Related issues

Closes #16377

elasticmachine · 2020-05-06T22:08:24Z

Pinging @elastic/siem (Team:SIEM)

agent.hostname is not part of ECS so this removes the field. Instead the agent.name field can be used for this purpose and it it part of ECS. This add a migration alias pointing from agent.hostname to agent.name. Closes elastic#16377

elasticmachine · 2020-05-06T22:12:18Z

💚 Build Succeeded

Expand to view the summary

Build stats

Build Cause: [andrewkroh commented: run tests]
Start Time: 2020-05-12T13:16:57.670+0000
Duration: 92 min 22 sec (5541891)

Test stats 🧪

Test	Results
Failed	0
Passed	7769
Skipped	1236
Total	9005

Steps errors

Expand to view the steps failures

Name: Report to Codecov
- Description: curl -sSLo codecov https://codecov.io/bash for i in auditbeat filebeat heartbeat libbeat metricbeat packetbeat winlogbeat journalbeat do FILE="${i}/build/coverage/full.cov" if [ -f "${FILE}" ]; then bash codecov -f "${FILE}" fi done
- Result: FAILURE
- Duration: 2 min 22 sec
- Start Time: 2020-05-12T14:25:20.716+0000
- log

andrewkroh · 2020-05-06T22:37:36Z

I created #18329 to track removing the old 6.x-to-7.0 migration aliases.

elasticmachine · 2020-05-06T22:44:47Z

Pinging @elastic/integrations-services (Team:Services)

exekias · 2020-05-08T08:26:54Z

script/ecs-migration-8x.yml

@@ -0,0 +1,17 @@
+# The ECS migration file contains the information about all the Beats fields


exekias · 2020-05-08T08:28:06Z

libbeat/_meta/fields.common.yml

+      type: alias
+      path: agent.name
+      migration: true


I wonder if we want to keep an alias, is this used by any UI?

There is at least one place using agent.hostname in Kibana. There may be more instances. So I'll remove the migration tag so that the alias always exists (at least until we can confirm all of Kibana is updated in 8.0).

I'll ask the uptime team if they can update 8.0 to use agent.name.

https://github.com/elastic/kibana/blob/523926f0a49a5bd951ed0e056610b049482adbca/x-pack/plugins/uptime/common/runtime_types/ping/ping.ts#L58

cc @andrewvc

exekias

Thank you for tackling this! PR is looking good to me, just left a question on keeping the alias or not

Remove migration: true from beat.hostname alias. We can add it back after we are sure that Kibana has been updated to use beat.name for 8.0.

andrewkroh · 2020-05-12T13:16:29Z

run tests

kaiyan-sheng · 2021-09-08T23:00:10Z

We are considering removing agent.hostname from libbeat for 8.0. @simianhacker Do you know if this field is still used by Kibana metrics UI?

simianhacker · 2021-09-08T23:07:50Z

@kaiyan-sheng We are not using agent.hostname

kaiyan-sheng · 2021-09-09T19:12:19Z

Thank you!! @simianhacker We will add removing agent.hostname to our todo list for 8.0 then.

andrewkroh added libbeat breaking change labels May 6, 2020

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label May 6, 2020

andrewkroh added ecs Team:SIEM and removed needs_team Indicates that the issue/PR needs a Team:* label labels May 6, 2020

Remove agent.hostname field from libbeat

4af663b

agent.hostname is not part of ECS so this removes the field. Instead the agent.name field can be used for this purpose and it it part of ECS. This add a migration alias pointing from agent.hostname to agent.name. Closes elastic#16377

andrewkroh force-pushed the feature/libbeat/remove-agent-hostname branch from 8463d27 to 4af663b Compare May 6, 2020 22:09

andrewkroh mentioned this pull request May 6, 2020

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

Closed

4 tasks

andrewkroh added the Team:Services (Deprecated) Label for the former Integrations-Services team label May 6, 2020

andrewkroh marked this pull request as ready for review May 6, 2020 22:49

andrewkroh requested review from a team as code owners May 6, 2020 22:49

andrewkroh added the review label May 6, 2020

Fix beat.hostname alias

4f17af4

andrewkroh requested a review from exekias May 7, 2020 18:22

exekias reviewed May 8, 2020

View reviewed changes

andresrc added [zube]: Inbox Team:Integrations Label for the Integrations team [zube]: In Review and removed [zube]: Inbox labels May 9, 2020

andrewkroh added 2 commits May 11, 2020 19:44

Unmark alias as migration

112ae67

Remove migration: true from beat.hostname alias. We can add it back after we are sure that Kibana has been updated to use beat.name for 8.0.

Keep deprecation field description

8bb5ff7

exekias approved these changes May 12, 2020

View reviewed changes

andrewkroh merged commit 78b957a into elastic:master May 12, 2020

zube bot added [zube]: Done and removed [zube]: In Review labels May 12, 2020

andresrc removed the [zube]: Done label May 14, 2020

simitt mentioned this pull request May 26, 2020

Update beats framework to 33e323cd6200 elastic/apm-server#3819

Merged

8 tasks

kaiyan-sheng mentioned this pull request Sep 8, 2021

Breaking changes for 8.0 #13911

Closed

19 tasks

		@@ -0,0 +1,17 @@
		# The ECS migration file contains the information about all the Beats fields

Conversation

andrewkroh commented May 6, 2020 • edited by andresrc Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

Checklist

Related issues

Uh oh!

elasticmachine commented May 6, 2020

Uh oh!

elasticmachine commented May 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Build stats

Test stats 🧪

Steps errors

Uh oh!

andrewkroh commented May 6, 2020

Uh oh!

elasticmachine commented May 6, 2020

Uh oh!

exekias May 8, 2020

Choose a reason for hiding this comment

Uh oh!

exekias May 8, 2020

Choose a reason for hiding this comment

Uh oh!

andrewkroh May 11, 2020

Choose a reason for hiding this comment

Uh oh!

exekias May 12, 2020

Choose a reason for hiding this comment

Uh oh!

exekias left a comment

Choose a reason for hiding this comment

Uh oh!

andrewkroh commented May 12, 2020

Uh oh!

kaiyan-sheng commented Sep 8, 2021

Uh oh!

simianhacker commented Sep 8, 2021

Uh oh!

kaiyan-sheng commented Sep 9, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

andrewkroh commented May 6, 2020 •

edited by andresrc

Loading

elasticmachine commented May 6, 2020 •

edited

Loading