Skip to content

Commit a695f52

Browse files
SylvainJugekibanamachinecauemarcondes
authored
fix otel service detection (#180574)
## 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 ![Screenshot from 2024-04-11 12-01-55](https://github.com/elastic/kibana/assets/763082/986a6728-1d84-48ed-ba7e-9236f258545b) #### After fixing it ![image](https://github.com/elastic/kibana/assets/763082/4726427d-6d18-4f9b-a389-f860924f512c) ### 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&mdash;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&mdash;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]>
1 parent 6299736 commit a695f52

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

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

+6
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,17 @@ import {
2323
describe('Agents guards', () => {
2424
it('isOpenTelemetryAgentName should guard if the passed agent is an OpenTelemetry one.', () => {
2525
expect(isOpenTelemetryAgentName('otlp')).toBe(true);
26+
expect(isOpenTelemetryAgentName('opentelemetry/java')).toBe(true);
27+
expect(isOpenTelemetryAgentName('opentelemetry/java/opentelemetry-java-instrumentation')).toBe(
28+
true
29+
);
2630
expect(isOpenTelemetryAgentName('not-an-agent')).toBe(false);
2731
});
2832

2933
it('isJavaAgentName should guard if the passed agent is an Java one.', () => {
3034
expect(isJavaAgentName('java')).toBe(true);
35+
expect(isJavaAgentName('opentelemetry/java')).toBe(true);
36+
expect(isJavaAgentName('opentelemetry/java/opentelemetry-java-instrumentation')).toBe(true);
3137
expect(isJavaAgentName('not-an-agent')).toBe(false);
3238
});
3339

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

+8-2
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,17 @@ import type {
1616
} from './agent_names';
1717

1818
export function isOpenTelemetryAgentName(agentName: string): agentName is OpenTelemetryAgentName {
19-
return OPEN_TELEMETRY_AGENT_NAMES.includes(agentName as OpenTelemetryAgentName);
19+
return (
20+
agentName?.startsWith('opentelemetry/') ||
21+
OPEN_TELEMETRY_AGENT_NAMES.includes(agentName as OpenTelemetryAgentName)
22+
);
2023
}
2124

2225
export function isJavaAgentName(agentName?: string): agentName is JavaAgentName {
23-
return JAVA_AGENT_NAMES.includes(agentName! as JavaAgentName);
26+
return (
27+
agentName?.startsWith('opentelemetry/java') ||
28+
JAVA_AGENT_NAMES.includes(agentName! as JavaAgentName)
29+
);
2430
}
2531

2632
export function isRumAgentName(agentName?: string): agentName is RumAgentName {

0 commit comments

Comments
 (0)