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

[AlexanderWert]

Kibana version: 8.13 +

Describe the bug: With https://github.com/elastic/apm-data/pull/203 the field agent.name for OTel data got an additional suffix. For example, for Java OTel, before the name was always: opentelemetry/java. With the above change, we now can differentiate different distributions of the OTel SDKs / agents, resulting in agent names like:

• opentelemetry/java/elastic
• opentelemetry/java/opentelemetry-instrumentation
• opentelemetry/java/some-other-distro
• etc.

(Note: The above is not Java specific, but a general change for all languages).

With that change the APM UI broke in terms of not being able to recognize the Agent icon and additional OpenTelemetry meta-information anymore:

Before:

After:

[elasticmachine]

Pinging @elastic/apm-ui (Team:APM)

[elasticmachine]

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

[smith]

We have some stories with agent icons under ServiceLink but maybe we should add a complete list of examples we would expect similar to what we have for span icons: https://ci-artifacts.kibana.dev/storybooks/main/00a637c8ce0d33df6a12b40a6ab6c765afaf440d/apm/index.html?path=/story/shared-spanicon--list

I believe all the client-side logic for dealing with agent names is in this package: https://github.com/elastic/kibana/blob/a6a6823d284fc0ca63ef362612750b0d97ebf30d/packages/kbn-elastic-agent-utils/src/agent_names.ts

[SylvainJuge]

From what I found with the java agent with https://github.com/elastic/kibana/pull/180574 it is only impacting users of the 2.x versions that provide the telemetry.* attributes, with 1.x java agent versions the otel and java badges are properly shown.

[rogercoll]

Reopening this issue because the https://github.com/elastic/kibana/pull/180574/files PR seems to fix Java agents only. Dotnet, PHP and Node.js seems to be not recognized yet:

I think a more generic option would be to skip/remove any prefix (e.g opentelemetry/) from the agent name check.

[smith]

We'll take another look at this to make sure we're covering all the cases.

IMO the best solution would to use telemetry.sdk and process.runtime OpenTelemetry fields directly as the inputs for the function that returns an icon for a service. I don't know which of these attributes we currently have.

[rogercoll]

It seems that for some APM only fails the Elastic's distributions, .NET example:

• Using upstream vanila agent:

• Using the Elastic's .NET SDK distribution:

[rmyz]

Hi team, I've created https://github.com/elastic/kibana/pull/193134 which will solve the issue regarding the icon.

I've also noticed that we are receiving a malformed language under OpenTelemetry details:

This info is fetched by GET /internal/apm/services/{serviceName}/metadata/details on this file, should we change anything here as well?

[AlexanderWert]

This info is fetched by GET /internal/apm/services/{serviceName}/metadata/details on this file, should we change anything here as well?

@rmyz Yes, let's please fix everything related to agent name that broke with the change of the name.