[APM UI] Fix OpenTelemetry agent names #193134

rmyz · 2024-09-17T10:18:44Z

Summary

This PR fixes the agent names not being able to properly be retrieved by the APM UI, changing the way we map OpenTelemetry agent names.
As the format changed from (opentelemetry|otlp)/{agentName} to (opentelemetry|otlp)/{agentName}/{details}, we now get the second part splitting by /.

Added mappings for RUM, Android, and iOS OpenTelemetry client, also fixed get_service_metadata_details to get the correct OpenTelemetry details.

Before	After

How to test

Checkout to this branch
Run node scripts/synthtrace many_otel_services.ts --live --clean which will fill some APM Otel services.
Check that the icon is now rendering

obltmachine · 2024-09-17T10:18:57Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2024-09-17T10:19:15Z

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

packages/kbn-custom-icons/src/components/agent_icon/get_agent_icon.ts

crespocarlos

I haven't tested it, but the code is looking good. Thanks for the synthtrace scenario. Left a few comments

packages/kbn-elastic-agent-utils/src/agent_guards.ts

rogercoll · 2024-09-17T13:00:59Z

Thanks for pushing this! 🚀

Will this PR also cover the "otlp" prefix? For example, this is the case for the OpenTelemetry Go auto-instrumentation agent:

AlexanderWert · 2024-09-17T13:10:56Z

Will this PR also cover the "otlp" prefix?

Great point, @rogercoll !

@rmyz Can we cover that case as well please? So that the prefix can be either opentelemetry or otlp

jennypavlova

Good job, checked with the scenario and works as expected, added some small comments/questions, should be quick to add

packages/kbn-elastic-agent-utils/src/agent_guards.ts

packages/kbn-custom-icons/src/components/agent_icon/get_agent_icon.ts

rmyz · 2024-09-17T13:57:04Z

Will this PR also cover the "otlp" prefix?

Great point, @rogercoll !

@rmyz Can we cover that case as well please? So that the prefix can be either opentelemetry or otlp

will add that case @rogercoll @AlexanderWert , thanks for checking guys! 🚀

rmyz · 2024-09-17T15:16:59Z

Added otlp/ prefix check and fixed get_service_metadata_details to get the proper OpenTelemetry agent details.
CC @rogercoll @AlexanderWert

I will be fixing the failing tests

jennypavlova

Code LGTM 💯 Thanks for the changes!

jennypavlova · 2024-09-17T15:46:49Z

packages/kbn-elastic-agent-utils/src/agent_guards.ts

+  }
+
+  return (
+    agentName.startsWith(`opentelemetry/${language}`) || agentName.startsWith(`otlp/${language}`)


Nit:

Suggested change

agentName.startsWith(`opentelemetry/${language}`) || agentName.startsWith(`otlp/${language}`)

agentName.startsWith(`opentelemetry/${language}` || `otlp/${language}`);

I think the proposed solution does not apply here, as || acts as a fallback value if the first one is falsy, but as it isn't it's not going to work, the function is not able to know which value should compare it to, so it does it for the first one always.

See the example below

packages/kbn-elastic-agent-utils/src/agent_guards.ts

afharo

Telemetry changes LGTM

rmyz · 2024-09-18T11:26:15Z

@elasticmachine merge upstream

crespocarlos · 2024-09-18T12:22:23Z

packages/kbn-elastic-agent-utils/src/agent_guards.test.ts

@@ -8,6 +8,7 @@
 */


crespocarlos

LGTM! Thanks for the changes.

rmyz · 2024-09-18T14:43:44Z

@elasticmachine merge upstream

…ry details

kibana-ci · 2024-09-19T16:46:55Z

💚 Build Succeeded

Buildkite Build
Commit: 548d7a3
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-193134-548d7a3545a8

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/elastic-agent-utils`	34	37	+3

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`apm`	3.4MB	3.4MB	+783.0B
`discover`	812.5KB	812.9KB	+423.0B
`infra`	1.6MB	1.6MB	+425.0B
total			+1.6KB

Unknown metric groups

API count

id	before	after	diff
`@kbn/elastic-agent-utils`	35	38	+3

History

💔 Build #235660 failed 9ca7365
💛 Build #235587 was flaky 4c339b4
💔 Build #235489 failed d178063
💔 Build #235477 failed 53a31b0
💛 Build #235275 was flaky c04a27d

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @rmyz

## Summary Fixes elastic#180444 This PR fixes the agent names not being able to properly be retrieved by the APM UI, changing the way we map OpenTelemetry agent names. As the format changed from `(opentelemetry|otlp)/{agentName}` to `(opentelemetry|otlp)/{agentName}/{details}`, we now get the second part splitting by `/`. Added mappings for RUM, Android, and iOS OpenTelemetry client, also fixed `get_service_metadata_details` to get the correct OpenTelemetry details. |Before|After| |-|-| |![image](https://github.com/user-attachments/assets/28732018-511b-44e0-ac86-cdbe7ed0d1e0)|![image](https://github.com/user-attachments/assets/45a29cc6-f939-4c52-bcc7-54dc15b1a403)| ## How to test 1. Checkout to this branch 2. Run `node scripts/synthtrace many_otel_services.ts --live --clean` which will fill some APM Otel services. 3. Check that the icon is now rendering (cherry picked from commit 735e216)

kibanamachine · 2024-09-20T07:12:13Z

💔 Some backports could not be created

Status	Branch	Result
❌	8.15	Backport failed because of merge conflicts
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 193134

Questions ?

Please refer to the Backport tool documentation

rmyz · 2024-09-20T07:27:35Z

💚 All backports created successfully

Status	Branch	Result
✅	8.15

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

## Summary Fixes elastic#180444 This PR fixes the agent names not being able to properly be retrieved by the APM UI, changing the way we map OpenTelemetry agent names. As the format changed from `(opentelemetry|otlp)/{agentName}` to `(opentelemetry|otlp)/{agentName}/{details}`, we now get the second part splitting by `/`. Added mappings for RUM, Android, and iOS OpenTelemetry client, also fixed `get_service_metadata_details` to get the correct OpenTelemetry details. |Before|After| |-|-| |![image](https://github.com/user-attachments/assets/28732018-511b-44e0-ac86-cdbe7ed0d1e0)|![image](https://github.com/user-attachments/assets/45a29cc6-f939-4c52-bcc7-54dc15b1a403)| ## How to test 1. Checkout to this branch 2. Run `node scripts/synthtrace many_otel_services.ts --live --clean` which will fill some APM Otel services. 3. Check that the icon is now rendering (cherry picked from commit 735e216) # Conflicts: # src/plugins/telemetry/schema/oss_plugins.json

# Backport This will backport the following commits from `main` to `8.x`: - [[APM UI] Fix OpenTelemetry agent names (#193134)](#193134)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  --------- Co-authored-by: Sergi Romeu <sergi.romeu@elastic.co>

# Backport This will backport the following commits from `main` to `8.15`: - [[APM UI] Fix OpenTelemetry agent names (#193134)](#193134)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

rmyz added release_note:fix apm:opentelemetry APM UI - OTEL Work ci:project-deploy-observability Create an Observability project Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team labels Sep 17, 2024

rmyz self-assigned this Sep 17, 2024

rmyz marked this pull request as ready for review September 17, 2024 10:19

rmyz requested review from a team as code owners September 17, 2024 10:19

rmyz mentioned this pull request Sep 17, 2024

[APM] OTel Agent names not recognized correctly after a change in mapping #180444

Closed

rmyz force-pushed the 180444-apm-ui-fix-opentelemetry-agent-names branch from d2faabb to a80cbd0 Compare September 17, 2024 11:12

AlexanderWert reviewed Sep 17, 2024

View reviewed changes

packages/kbn-custom-icons/src/components/agent_icon/get_agent_icon.ts Outdated Show resolved Hide resolved

jennypavlova self-requested a review September 17, 2024 11:59

crespocarlos reviewed Sep 17, 2024

View reviewed changes

packages/kbn-elastic-agent-utils/src/agent_guards.ts Outdated Show resolved Hide resolved

packages/kbn-elastic-agent-utils/src/agent_guards.ts Outdated Show resolved Hide resolved

packages/kbn-elastic-agent-utils/src/agent_guards.ts Outdated Show resolved Hide resolved

rmyz requested review from a team as code owners September 17, 2024 12:04

jennypavlova reviewed Sep 17, 2024

View reviewed changes

packages/kbn-elastic-agent-utils/src/agent_guards.ts Outdated Show resolved Hide resolved

packages/kbn-custom-icons/src/components/agent_icon/get_agent_icon.ts Outdated Show resolved Hide resolved

jennypavlova approved these changes Sep 17, 2024

View reviewed changes

crespocarlos reviewed Sep 18, 2024

View reviewed changes

packages/kbn-elastic-agent-utils/src/agent_guards.ts Show resolved Hide resolved

packages/kbn-elastic-agent-utils/src/agent_guards.ts Show resolved Hide resolved

packages/kbn-elastic-agent-utils/src/agent_guards.ts Show resolved Hide resolved

afharo approved these changes Sep 18, 2024

View reviewed changes

rmyz force-pushed the 180444-apm-ui-fix-opentelemetry-agent-names branch from 238b91f to 7c1f216 Compare September 18, 2024 11:20

crespocarlos reviewed Sep 18, 2024

View reviewed changes

packages/kbn-elastic-agent-utils/src/agent_guards.test.ts

@@ -8,6 +8,7 @@

*/

Copy link

Contributor

crespocarlos Sep 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💪 !

rmyz reacted with heart emoji

crespocarlos approved these changes Sep 18, 2024

View reviewed changes

rmyz added 14 commits September 19, 2024 17:45

refactor: avoid hardcoded values and extract into variables

bb68173

refactor: remove unused prop

7efe12a

chore: improve otel synthtrace scenario

f3f6c49

chore: export hasOpenTelemetryPrefix from @kbn-elastic-agent-utils

ef2b7bf

fix: check opentelemetry for 'otlp' prefix

093f206

refactor: adapt get_service_metadata to retrieve properly opentelemet…

88b55fd

…ry details

chore: add otlp/ fields to schema

603ad30

chore: add schema

20e8dbf

test: regenerate snapshots

e6f524d

test: add testing for hasOpenTelemetryPrefix

389309e

refactor: export android and ios into agent names

a0eb923

fix: fix schema

1a30541

fix: add xpack_plugins missing fields

ce15b08

test: update snapshot

548d7a3

rmyz force-pushed the 180444-apm-ui-fix-opentelemetry-agent-names branch from 9ca7365 to 548d7a3 Compare September 19, 2024 15:45

PhilippeOberti removed the request for review from a team September 19, 2024 21:51

rmyz merged commit 735e216 into elastic:main Sep 20, 2024
24 checks passed

kibanamachine added the v9.0.0 label Sep 20, 2024

kibanamachine mentioned this pull request Sep 20, 2024

[8.x] [APM UI] Fix OpenTelemetry agent names (#193134) #193509

Merged

rmyz mentioned this pull request Sep 20, 2024

[8.15] [APM UI] Fix OpenTelemetry agent names (#193134) #193511

Merged

rmyz deleted the 180444-apm-ui-fix-opentelemetry-agent-names branch September 20, 2024 08:21

kibanamachine added the v8.16.0 label Sep 20, 2024

kibanamachine added the v8.15.2 label Sep 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[APM UI] Fix OpenTelemetry agent names #193134

[APM UI] Fix OpenTelemetry agent names #193134

rmyz commented Sep 17, 2024 •

edited by kibanamachine

Loading

obltmachine commented Sep 17, 2024

elasticmachine commented Sep 17, 2024

crespocarlos left a comment

rogercoll commented Sep 17, 2024

AlexanderWert commented Sep 17, 2024

jennypavlova left a comment

rmyz commented Sep 17, 2024

rmyz commented Sep 17, 2024 •

edited

Loading

jennypavlova left a comment

jennypavlova Sep 17, 2024

rmyz Sep 18, 2024

afharo left a comment

rmyz commented Sep 18, 2024

crespocarlos Sep 18, 2024

crespocarlos left a comment

rmyz commented Sep 18, 2024

kibana-ci commented Sep 19, 2024 •

edited

Loading

API count

kibanamachine commented Sep 20, 2024

rmyz commented Sep 20, 2024

	agentName.startsWith(`opentelemetry/${language}`) \|\| agentName.startsWith(`otlp/${language}`)
	agentName.startsWith(`opentelemetry/${language}` \|\| `otlp/${language}`);

[APM UI] Fix OpenTelemetry agent names #193134

[APM UI] Fix OpenTelemetry agent names #193134

Conversation

rmyz commented Sep 17, 2024 • edited by kibanamachine Loading

Summary

How to test

obltmachine commented Sep 17, 2024

🤖 GitHub comments

elasticmachine commented Sep 17, 2024

crespocarlos left a comment

Choose a reason for hiding this comment

rogercoll commented Sep 17, 2024

AlexanderWert commented Sep 17, 2024

jennypavlova left a comment

Choose a reason for hiding this comment

rmyz commented Sep 17, 2024

rmyz commented Sep 17, 2024 • edited Loading

jennypavlova left a comment

Choose a reason for hiding this comment

jennypavlova Sep 17, 2024

Choose a reason for hiding this comment

rmyz Sep 18, 2024

Choose a reason for hiding this comment

afharo left a comment

Choose a reason for hiding this comment

rmyz commented Sep 18, 2024

crespocarlos Sep 18, 2024

Choose a reason for hiding this comment

crespocarlos left a comment

Choose a reason for hiding this comment

rmyz commented Sep 18, 2024

kibana-ci commented Sep 19, 2024 • edited Loading

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

API count

History

kibanamachine commented Sep 20, 2024

💔 Some backports could not be created

Manual backport

Questions ?

rmyz commented Sep 20, 2024

💚 All backports created successfully

Questions ?

rmyz commented Sep 17, 2024 •

edited by kibanamachine

Loading

rmyz commented Sep 17, 2024 •

edited

Loading

kibana-ci commented Sep 19, 2024 •

edited

Loading