[APM] OTel Agent names not recognized correctly after a change in mapping #180444
Assignees
Labels
apm
bug
Fixes for quality problems that affect the customer experience
OpenTelemetry
Team:obs-ux-infra_services
Observability Infrastructure & Services User Experience Team
Comments
AlexanderWert
added
bug
|
Pinging @elastic/apm-ui (Team:APM) |
smith
added
v8.14.0
OpenTelemetry
Team:obs-ux-infra_services
|
Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services) |
|
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 |
|
From what I found with the java agent with #180574 it is only impacting users of the 2.x versions that provide the |
cauemarcondes
added a commit
that referenced
this issue
Apr 22, 2024
## Summary With newer versions of the Java agent (tested with 2.2.0 here), the `agent.name` field now contains multiple parts and we should consider the prefix and not the whole string to properly detect if it's an otel agent or not. Fixing this is also a prerequisite for #174445 as the metric charts are not properly displayed for otel agents (and the java one in particular). Fixes #180444 #### Without the fix  #### After fixing it  ### Checklist Delete any items that are not applicable to this PR. I'm really not a typescript nor kibana expert, so I'm pretty sure there are better and cleaner ways to implement this. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Cauê Marcondes <[email protected]>
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this issue
Apr 22, 2024
## Summary With newer versions of the Java agent (tested with 2.2.0 here), the `agent.name` field now contains multiple parts and we should consider the prefix and not the whole string to properly detect if it's an otel agent or not. Fixing this is also a prerequisite for elastic#174445 as the metric charts are not properly displayed for otel agents (and the java one in particular). Fixes elastic#180444 #### Without the fix  #### After fixing it  ### Checklist Delete any items that are not applicable to this PR. I'm really not a typescript nor kibana expert, so I'm pretty sure there are better and cleaner ways to implement this. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Cauê Marcondes <[email protected]> (cherry picked from commit a695f52)
kibanamachine
referenced
this issue
Apr 22, 2024
# Backport This will backport the following commits from `main` to `8.14`: - [fix otel service detection (#180574)](#180574) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"SylvainJuge","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-04-22T11:39:47Z","message":"fix otel service detection (#180574)\n\n## Summary\r\n\r\nWith newer versions of the Java agent (tested with 2.2.0 here), the\r\n`agent.name` field now contains multiple parts and we should consider\r\nthe prefix and not the whole string to properly detect if it's an otel\r\nagent or not.\r\n\r\nFixing this is also a prerequisite for\r\nhttps://github.com//issues/174445 as the metric charts are\r\nnot properly displayed for otel agents (and the java one in particular).\r\n\r\nFixes https://github.com/elastic/kibana/issues/180444\r\n\r\n#### Without the fix\r\n\r\n\r\n\r\n\r\n#### After fixing it\r\n\r\n\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\nI'm really not a typescript nor kibana expert, so I'm pretty sure there\r\nare better and cleaner ways to implement this.\r\n\r\n- [ ] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n- [ ]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [ ] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [ ] [Flaky Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\r\nused on any tests changed\r\n- [ ] Any UI touched in this PR is usable by keyboard only (learn more\r\nabout [keyboard accessibility](https://webaim.org/techniques/keyboard/))\r\n- [ ] Any UI touched in this PR does not create any new axe failures\r\n(run axe in browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n- [ ] If a plugin configuration key changed, check if it needs to be\r\nallowlisted in the cloud and added to the [docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n- [ ] This renders correctly on smaller devices using a responsive\r\nlayout. (You can test this [in your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n- [ ] This was checked for [cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n### Risk Matrix\r\n\r\nDelete this section if it is not applicable to this PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other developers to\r\nidentify risks that should be tested prior to the change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider some of the following examples\r\nand how they may potentially impact the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes |\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n| Multiple Spaces—unexpected behavior in non-default Kibana Space.\r\n| Low | High | Integration tests will verify that all features are still\r\nsupported in non-default Kibana Space and when user switches between\r\nspaces. |\r\n| Multiple nodes—Elasticsearch polling might have race conditions\r\nwhen multiple Kibana nodes are polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so executing them multiple times will not result\r\nin logical error, but will degrade performance. To test for this case we\r\nadd plenty of unit tests around this logic and document manual testing\r\nprocedure. |\r\n| Code should gracefully handle cases when feature X or plugin Y are\r\ndisabled. | Medium | High | Unit tests will verify that any feature flag\r\nor plugin combination still results in our service operational. |\r\n| [See more potential risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Cauê Marcondes <[email protected]>","sha":"a695f528c0754ee1ae7eaed79c3244d5292f6f95","branchLabelMapping":{"^v8.15.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","v8.14.0","v8.15.0"],"title":"fix otel service detection","number":180574,"url":"https://github.com/elastic/kibana/pull/180574","mergeCommit":{"message":"fix otel service detection (#180574)\n\n## Summary\r\n\r\nWith newer versions of the Java agent (tested with 2.2.0 here), the\r\n`agent.name` field now contains multiple parts and we should consider\r\nthe prefix and not the whole string to properly detect if it's an otel\r\nagent or not.\r\n\r\nFixing this is also a prerequisite for\r\nhttps://github.com//issues/174445 as the metric charts are\r\nnot properly displayed for otel agents (and the java one in particular).\r\n\r\nFixes https://github.com/elastic/kibana/issues/180444\r\n\r\n#### Without the fix\r\n\r\n\r\n\r\n\r\n#### After fixing it\r\n\r\n\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\nI'm really not a typescript nor kibana expert, so I'm pretty sure there\r\nare better and cleaner ways to implement this.\r\n\r\n- [ ] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n- [ ]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [ ] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [ ] [Flaky Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\r\nused on any tests changed\r\n- [ ] Any UI touched in this PR is usable by keyboard only (learn more\r\nabout [keyboard accessibility](https://webaim.org/techniques/keyboard/))\r\n- [ ] Any UI touched in this PR does not create any new axe failures\r\n(run axe in browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n- [ ] If a plugin configuration key changed, check if it needs to be\r\nallowlisted in the cloud and added to the [docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n- [ ] This renders correctly on smaller devices using a responsive\r\nlayout. (You can test this [in your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n- [ ] This was checked for [cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n### Risk Matrix\r\n\r\nDelete this section if it is not applicable to this PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other developers to\r\nidentify risks that should be tested prior to the change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider some of the following examples\r\nand how they may potentially impact the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes |\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n| Multiple Spaces—unexpected behavior in non-default Kibana Space.\r\n| Low | High | Integration tests will verify that all features are still\r\nsupported in non-default Kibana Space and when user switches between\r\nspaces. |\r\n| Multiple nodes—Elasticsearch polling might have race conditions\r\nwhen multiple Kibana nodes are polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so executing them multiple times will not result\r\nin logical error, but will degrade performance. To test for this case we\r\nadd plenty of unit tests around this logic and document manual testing\r\nprocedure. |\r\n| Code should gracefully handle cases when feature X or plugin Y are\r\ndisabled. | Medium | High | Unit tests will verify that any feature flag\r\nor plugin combination still results in our service operational. |\r\n| [See more potential risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Cauê Marcondes <[email protected]>","sha":"a695f528c0754ee1ae7eaed79c3244d5292f6f95"}},"sourceBranch":"main","suggestedTargetBranches":["8.14"],"targetPullRequestStates":[{"branch":"8.14","label":"v8.14.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.15.0","branchLabelMappingKey":"^v8.15.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/180574","number":180574,"mergeCommit":{"message":"fix otel service detection (#180574)\n\n## Summary\r\n\r\nWith newer versions of the Java agent (tested with 2.2.0 here), the\r\n`agent.name` field now contains multiple parts and we should consider\r\nthe prefix and not the whole string to properly detect if it's an otel\r\nagent or not.\r\n\r\nFixing this is also a prerequisite for\r\nhttps://github.com//issues/174445 as the metric charts are\r\nnot properly displayed for otel agents (and the java one in particular).\r\n\r\nFixes https://github.com/elastic/kibana/issues/180444\r\n\r\n#### Without the fix\r\n\r\n\r\n\r\n\r\n#### After fixing it\r\n\r\n\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\r\n\r\nI'm really not a typescript nor kibana expert, so I'm pretty sure there\r\nare better and cleaner ways to implement this.\r\n\r\n- [ ] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n- [ ]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [ ] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [ ] [Flaky Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\r\nused on any tests changed\r\n- [ ] Any UI touched in this PR is usable by keyboard only (learn more\r\nabout [keyboard accessibility](https://webaim.org/techniques/keyboard/))\r\n- [ ] Any UI touched in this PR does not create any new axe failures\r\n(run axe in browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n- [ ] If a plugin configuration key changed, check if it needs to be\r\nallowlisted in the cloud and added to the [docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n- [ ] This renders correctly on smaller devices using a responsive\r\nlayout. (You can test this [in your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n- [ ] This was checked for [cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n### Risk Matrix\r\n\r\nDelete this section if it is not applicable to this PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other developers to\r\nidentify risks that should be tested prior to the change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider some of the following examples\r\nand how they may potentially impact the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes |\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n| Multiple Spaces—unexpected behavior in non-default Kibana Space.\r\n| Low | High | Integration tests will verify that all features are still\r\nsupported in non-default Kibana Space and when user switches between\r\nspaces. |\r\n| Multiple nodes—Elasticsearch polling might have race conditions\r\nwhen multiple Kibana nodes are polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so executing them multiple times will not result\r\nin logical error, but will degrade performance. To test for this case we\r\nadd plenty of unit tests around this logic and document manual testing\r\nprocedure. |\r\n| Code should gracefully handle cases when feature X or plugin Y are\r\ndisabled. | Medium | High | Unit tests will verify that any feature flag\r\nor plugin combination still results in our service operational. |\r\n| [See more potential risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Cauê Marcondes <[email protected]>","sha":"a695f528c0754ee1ae7eaed79c3244d5292f6f95"}}]}] BACKPORT--> Co-authored-by: SylvainJuge <[email protected]>
|
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 |
smith
added
the
needs-refinement
|
We'll take another look at this to make sure we're covering all the cases. IMO the best solution would to use |
|
It seems that for some APM only fails the Elastic's distributions, .NET example:
|
|
Hi team, I've created #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 |
rmyz
removed
the
needs-refinement
rmyz
added a commit
that referenced
this issue
Sep 20, 2024
## Summary Fixes #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| |-|-| ||| ## 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
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this issue
Sep 20, 2024
## 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| |-|-| ||| ## 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)
rmyz
added a commit
to rmyz/kibana
that referenced
this issue
Sep 20, 2024
## 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| |-|-| ||| ## 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
kibanamachine
referenced
this issue
Sep 20, 2024
# Backport This will backport the following commits from `main` to `8.x`: - [[APM UI] Fix OpenTelemetry agent names (#193134)](#193134) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Sergi Romeu","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-20T07:07:14Z","message":"[APM UI] Fix OpenTelemetry agent names (#193134)\n\n## Summary\r\n\r\nFixes https://github.com/elastic/kibana/issues/180444\r\n\r\nThis PR fixes the agent names not being able to properly be retrieved by\r\nthe APM UI, changing the way we map OpenTelemetry agent names.\r\nAs the format changed from `(opentelemetry|otlp)/{agentName}` to\r\n`(opentelemetry|otlp)/{agentName}/{details}`, we now get the second part\r\nsplitting by `/`.\r\n\r\nAdded mappings for RUM, Android, and iOS OpenTelemetry client, also\r\nfixed `get_service_metadata_details` to get the correct OpenTelemetry\r\ndetails.\r\n\r\n|Before|After|\r\n|-|-|\r\n\r\n|||\r\n\r\n## How to test\r\n1. Checkout to this branch\r\n2. Run `node scripts/synthtrace many_otel_services.ts --live --clean`\r\nwhich will fill some APM Otel services.\r\n3. Check that the icon is now rendering","sha":"735e216a952670eb57eaea1229be16e89f9bf1cd","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","v9.0.0","apm:opentelemetry","backport:prev-major","ci:project-deploy-observability","Team:obs-ux-infra_services","backport:version"],"title":"[APM UI] Fix OpenTelemetry agent names","number":193134,"url":"https://github.com/elastic/kibana/pull/193134","mergeCommit":{"message":"[APM UI] Fix OpenTelemetry agent names (#193134)\n\n## Summary\r\n\r\nFixes https://github.com/elastic/kibana/issues/180444\r\n\r\nThis PR fixes the agent names not being able to properly be retrieved by\r\nthe APM UI, changing the way we map OpenTelemetry agent names.\r\nAs the format changed from `(opentelemetry|otlp)/{agentName}` to\r\n`(opentelemetry|otlp)/{agentName}/{details}`, we now get the second part\r\nsplitting by `/`.\r\n\r\nAdded mappings for RUM, Android, and iOS OpenTelemetry client, also\r\nfixed `get_service_metadata_details` to get the correct OpenTelemetry\r\ndetails.\r\n\r\n|Before|After|\r\n|-|-|\r\n\r\n|||\r\n\r\n## How to test\r\n1. Checkout to this branch\r\n2. Run `node scripts/synthtrace many_otel_services.ts --live --clean`\r\nwhich will fill some APM Otel services.\r\n3. Check that the icon is now rendering","sha":"735e216a952670eb57eaea1229be16e89f9bf1cd"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193134","number":193134,"mergeCommit":{"message":"[APM UI] Fix OpenTelemetry agent names (#193134)\n\n## Summary\r\n\r\nFixes https://github.com/elastic/kibana/issues/180444\r\n\r\nThis PR fixes the agent names not being able to properly be retrieved by\r\nthe APM UI, changing the way we map OpenTelemetry agent names.\r\nAs the format changed from `(opentelemetry|otlp)/{agentName}` to\r\n`(opentelemetry|otlp)/{agentName}/{details}`, we now get the second part\r\nsplitting by `/`.\r\n\r\nAdded mappings for RUM, Android, and iOS OpenTelemetry client, also\r\nfixed `get_service_metadata_details` to get the correct OpenTelemetry\r\ndetails.\r\n\r\n|Before|After|\r\n|-|-|\r\n\r\n|||\r\n\r\n## How to test\r\n1. Checkout to this branch\r\n2. Run `node scripts/synthtrace many_otel_services.ts --live --clean`\r\nwhich will fill some APM Otel services.\r\n3. Check that the icon is now rendering","sha":"735e216a952670eb57eaea1229be16e89f9bf1cd"}}]}] BACKPORT--> --------- Co-authored-by: Sergi Romeu <[email protected]>
rmyz
referenced
this issue
Sep 20, 2024
# Backport This will backport the following commits from `main` to `8.15`: - [[APM UI] Fix OpenTelemetry agent names (#193134)](#193134) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Sergi Romeu","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-20T07:07:14Z","message":"[APM UI] Fix OpenTelemetry agent names (#193134)\n\n## Summary\r\n\r\nFixes https://github.com/elastic/kibana/issues/180444\r\n\r\nThis PR fixes the agent names not being able to properly be retrieved by\r\nthe APM UI, changing the way we map OpenTelemetry agent names.\r\nAs the format changed from `(opentelemetry|otlp)/{agentName}` to\r\n`(opentelemetry|otlp)/{agentName}/{details}`, we now get the second part\r\nsplitting by `/`.\r\n\r\nAdded mappings for RUM, Android, and iOS OpenTelemetry client, also\r\nfixed `get_service_metadata_details` to get the correct OpenTelemetry\r\ndetails.\r\n\r\n|Before|After|\r\n|-|-|\r\n\r\n|||\r\n\r\n## How to test\r\n1. Checkout to this branch\r\n2. Run `node scripts/synthtrace many_otel_services.ts --live --clean`\r\nwhich will fill some APM Otel services.\r\n3. Check that the icon is now rendering","sha":"735e216a952670eb57eaea1229be16e89f9bf1cd","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","v9.0.0","apm:opentelemetry","backport:prev-major","ci:project-deploy-observability","Team:obs-ux-infra_services","backport:version"],"number":193134,"url":"https://github.com/elastic/kibana/pull/193134","mergeCommit":{"message":"[APM UI] Fix OpenTelemetry agent names (#193134)\n\n## Summary\r\n\r\nFixes https://github.com/elastic/kibana/issues/180444\r\n\r\nThis PR fixes the agent names not being able to properly be retrieved by\r\nthe APM UI, changing the way we map OpenTelemetry agent names.\r\nAs the format changed from `(opentelemetry|otlp)/{agentName}` to\r\n`(opentelemetry|otlp)/{agentName}/{details}`, we now get the second part\r\nsplitting by `/`.\r\n\r\nAdded mappings for RUM, Android, and iOS OpenTelemetry client, also\r\nfixed `get_service_metadata_details` to get the correct OpenTelemetry\r\ndetails.\r\n\r\n|Before|After|\r\n|-|-|\r\n\r\n|||\r\n\r\n## How to test\r\n1. Checkout to this branch\r\n2. Run `node scripts/synthtrace many_otel_services.ts --live --clean`\r\nwhich will fill some APM Otel services.\r\n3. Check that the icon is now rendering","sha":"735e216a952670eb57eaea1229be16e89f9bf1cd"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193134","number":193134,"mergeCommit":{"message":"[APM UI] Fix OpenTelemetry agent names (#193134)\n\n## Summary\r\n\r\nFixes https://github.com/elastic/kibana/issues/180444\r\n\r\nThis PR fixes the agent names not being able to properly be retrieved by\r\nthe APM UI, changing the way we map OpenTelemetry agent names.\r\nAs the format changed from `(opentelemetry|otlp)/{agentName}` to\r\n`(opentelemetry|otlp)/{agentName}/{details}`, we now get the second part\r\nsplitting by `/`.\r\n\r\nAdded mappings for RUM, Android, and iOS OpenTelemetry client, also\r\nfixed `get_service_metadata_details` to get the correct OpenTelemetry\r\ndetails.\r\n\r\n|Before|After|\r\n|-|-|\r\n\r\n|||\r\n\r\n## How to test\r\n1. Checkout to this branch\r\n2. Run `node scripts/synthtrace many_otel_services.ts --live --clean`\r\nwhich will fill some APM Otel services.\r\n3. Check that the icon is now rendering","sha":"735e216a952670eb57eaea1229be16e89f9bf1cd"}},{"url":"https://github.com/elastic/kibana/pull/193509","number":193509,"branch":"8.x","state":"OPEN"}]}] BACKPORT-->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Kibana version:
8.13 +
Describe the bug:
With elastic/apm-data#203 the field
agent.namefor 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/elasticopentelemetry/java/opentelemetry-instrumentationopentelemetry/java/some-other-distro(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:
The text was updated successfully, but these errors were encountered: