[9.0] Add trace.id to EBT events (#222366) (#223517)

# Backport This will backport the following commits from `main` to `9.0`: - [Add trace.id to EBT events (#222366)](https://github.com/elastic/kibana/pull/222366)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Maryam Saeidi <maryam.saeidi@elastic.co> Co-authored-by: Alejandro Fernández Haro <alejandro.haro@elastic.co>
2025-06-27 18:51:07 -04:00 · 2025-06-12 13:46:11 +02:00 · 2025-06-12 13:46:11 +02:00 · 5419984424
commit 5419984424
parent 01bb8fc018
6 changed files with 44 additions and 6 deletions
--- a/src/core/packages/analytics/browser-internal/src/analytics_service.ts
+++ b/src/core/packages/analytics/browser-internal/src/analytics_service.ts
@ -8,6 +8,7 @@
 */

 import { of, Subscription } from 'rxjs';
+import { apm, type Transaction } from '@elastic/apm-rum';
 import type { AnalyticsClient } from '@elastic/ebt/client';
 import { createAnalytics } from '@elastic/ebt/client';
 import { registerPerformanceMetricEventType } from '@kbn/ebt-tools';
@ -25,6 +26,10 @@ export interface AnalyticsServiceSetupDeps {
  injectedMetadata: InternalInjectedMetadataSetup;
 }

+interface TransactionWithUndocumentedProps extends Transaction {
+  traceId: string;
+}
+
 export class AnalyticsService {
  private readonly analyticsClient: AnalyticsClient;
  private readonly subscriptionsHandler = new Subscription();
@ -33,6 +38,9 @@ export class AnalyticsService {
    this.analyticsClient = createAnalytics({
      isDev: core.env.mode.dev,
      logger: core.logger.get('analytics'),
+      getTraceContext: () => ({
+        id: (apm.getCurrentTransaction() as TransactionWithUndocumentedProps | undefined)?.traceId,
+      }),
    });

    this.registerBuildInfoAnalyticsContext(core);
--- a/src/core/packages/analytics/server-internal/src/analytics_service.ts
+++ b/src/core/packages/analytics/server-internal/src/analytics_service.ts
@ -8,6 +8,7 @@
 */

 import { of } from 'rxjs';
+import apm from 'elastic-apm-node';
 import type { AnalyticsClient } from '@elastic/ebt/client';
 import { createAnalytics } from '@elastic/ebt/client';
 import { registerPerformanceMetricEventType } from '@kbn/ebt-tools';
@ -25,6 +26,9 @@ export class AnalyticsService {
    this.analyticsClient = createAnalytics({
      isDev: core.env.mode.dev,
      logger: core.logger.get('analytics'),
+      getTraceContext: () => ({
+        id: apm.currentTraceIds?.['trace.id'],
+      }),
    });

    this.registerBuildInfoAnalyticsContext(core);
--- a/test/analytics/plugins/analytics_plugin_a/public/plugin.ts
+++ b/test/analytics/plugins/analytics_plugin_a/public/plugin.ts
@ -7,6 +7,7 @@
 * License v3.0 only", or the "Server Side Public License, v 1".
 */

+import { apm, Transaction } from '@elastic/apm-rum';
 import { BehaviorSubject, filter, firstValueFrom, ReplaySubject } from 'rxjs';
 import { takeWhile, tap, toArray } from 'rxjs';
 import type { Plugin, CoreSetup, CoreStart, TelemetryCounter, Event } from '@kbn/core/server';
@ -45,6 +46,13 @@ export class AnalyticsPluginA implements Plugin {
            description: 'The lifecycle step in which the plugin is',
          },
        },
+        traceId: {
+          type: 'keyword',
+          _meta: {
+            description: 'The trace ID of the APM transaction',
+            optional: true,
+          },
+        },
      },
    });

@ -52,6 +60,7 @@ export class AnalyticsPluginA implements Plugin {
    reportEvent('test-plugin-lifecycle', {
      plugin: 'analyticsPluginA',
      step: 'setup',
+      traceId: this.getTransactionTraceId(),
    });
    let found = false;
    window.__analyticsPluginA__ = {
@ -96,9 +105,14 @@ export class AnalyticsPluginA implements Plugin {
    analytics.reportEvent('test-plugin-lifecycle', {
      plugin: 'analyticsPluginA',
      step: 'start',
+      traceId: this.getTransactionTraceId(),
    });
  }
  public stop() {}
+
+  private getTransactionTraceId(): string | undefined {
+    return (apm.getCurrentTransaction() as Transaction & { traceId: string })?.traceId;
+  }
 }

 function isTestPluginLifecycleReportEventAction({ action, meta }: Action): boolean {
--- a/test/analytics/plugins/analytics_plugin_a/server/plugin.ts
+++ b/test/analytics/plugins/analytics_plugin_a/server/plugin.ts
@ -7,6 +7,7 @@
 * License v3.0 only", or the "Server Side Public License, v 1".
 */

+import apm from 'elastic-apm-node';
 import { BehaviorSubject, filter, firstValueFrom, ReplaySubject } from 'rxjs';
 import { takeWhile, tap, toArray } from 'rxjs';
 import { schema } from '@kbn/config-schema';
@ -42,6 +43,13 @@ export class AnalyticsPluginAPlugin implements Plugin {
            description: 'The lifecycle step in which the plugin is',
          },
        },
+        traceId: {
+          type: 'keyword',
+          _meta: {
+            description: 'The trace ID of the APM transaction',
+            optional: true,
+          },
+        },
      },
    });

@ -49,6 +57,7 @@ export class AnalyticsPluginAPlugin implements Plugin {
    reportEvent('test-plugin-lifecycle', {
      plugin: 'analyticsPluginA',
      step: 'setup',
+      traceId: apm.currentTraceIds?.['trace.id'],
    });

    const actions$ = new ReplaySubject<Action>();
@ -125,6 +134,7 @@ export class AnalyticsPluginAPlugin implements Plugin {
    analytics.reportEvent('test-plugin-lifecycle', {
      plugin: 'analyticsPluginA',
      step: 'start',
+      traceId: apm.currentTraceIds?.['trace.id'],
    });
  }

--- a/test/analytics/tests/analytics_from_the_browser.ts
+++ b/test/analytics/tests/analytics_from_the_browser.ts
@ -153,15 +153,15 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
            timestamp: reportTestPluginLifecycleEventsAction!.meta[setupEvent].timestamp,
            event_type: 'test-plugin-lifecycle',
            context: initialContext,
-            properties: { plugin: 'analyticsPluginA', step: 'setup' },
-            trace: null,
+            properties: { plugin: 'analyticsPluginA', step: 'setup', traceId: events[0].trace?.id },
+            trace: { id: events[0].properties.traceId }, // Cross-checking with the properties.traceId to validate that the event reporter (plugin) and the client see the same transaction.
          },
          {
            timestamp: reportTestPluginLifecycleEventsAction!.meta[startEvent].timestamp,
            event_type: 'test-plugin-lifecycle',
            context: reportEventContext,
-            properties: { plugin: 'analyticsPluginA', step: 'start' },
-            trace: null,
+            properties: { plugin: 'analyticsPluginA', step: 'start', traceId: events[1].trace?.id },
+            trace: { id: events[1].properties.traceId }, // Cross-checking with the properties.traceId to validate that the event reporter (plugin) and the client see the same transaction.
          },
        ]);
      });
--- a/test/analytics/tests/analytics_from_the_server.ts
+++ b/test/analytics/tests/analytics_from_the_server.ts
@ -151,13 +151,15 @@ export default function ({ getService }: FtrProviderContext) {
            timestamp: reportTestPluginLifecycleEventsAction!.meta[setupEvent].timestamp,
            event_type: 'test-plugin-lifecycle',
            context: initialContext,
-            properties: { plugin: 'analyticsPluginA', step: 'setup' },
+            properties: { plugin: 'analyticsPluginA', step: 'setup', traceId: events[0].trace?.id },
+            trace: { id: events[0].properties.traceId }, // Cross-checking with the properties.traceId to validate that the event reporter (plugin) and the client see the same transaction.
          },
          {
            timestamp: reportTestPluginLifecycleEventsAction!.meta[startEvent].timestamp,
            event_type: 'test-plugin-lifecycle',
            context: reportEventContext,
-            properties: { plugin: 'analyticsPluginA', step: 'start' },
+            properties: { plugin: 'analyticsPluginA', step: 'start', traceId: events[1].trace?.id },
+            trace: { id: events[1].properties.traceId }, // Cross-checking with the properties.traceId to validate that the event reporter (plugin) and the client see the same transaction.
          },
        ]);
      });