APM execution context - app, page, entitiy id

docs/development/core/public/kibana-plugin-core-public.coresetup.executioncontext.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [CoreSetup](./kibana-plugin-core-public.coresetup.md) &gt; [executionContext](./kibana-plugin-core-public.coresetup.executioncontext.md)
+
+## CoreSetup.executionContext property
+
+
+<b>Signature:</b>
+
+```typescript
+executionContext: ExecutionContextSetup;
+```

docs/development/core/public/kibana-plugin-core-public.coresetup.md

@@ -17,6 +17,7 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [application](./kibana-plugin-core-public.coresetup.application.md) | ApplicationSetup | [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) |
+|  [executionContext](./kibana-plugin-core-public.coresetup.executioncontext.md) | ExecutionContextSetup |  |
 |  [fatalErrors](./kibana-plugin-core-public.coresetup.fatalerrors.md) | FatalErrorsSetup | [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) |
 |  [getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md) | StartServicesAccessor&lt;TPluginsStart, TStart&gt; | [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) |
 |  [http](./kibana-plugin-core-public.coresetup.http.md) | HttpSetup | [HttpSetup](./kibana-plugin-core-public.httpsetup.md) |

docs/development/core/public/kibana-plugin-core-public.corestart.executioncontext.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [CoreStart](./kibana-plugin-core-public.corestart.md) &gt; [executionContext](./kibana-plugin-core-public.corestart.executioncontext.md)
+
+## CoreStart.executionContext property
+
+
+<b>Signature:</b>
+
+```typescript
+executionContext: ExecutionContextStart;
+```

docs/development/core/public/kibana-plugin-core-public.corestart.md

@@ -20,6 +20,7 @@ export interface CoreStart
 |  [chrome](./kibana-plugin-core-public.corestart.chrome.md) | ChromeStart | [ChromeStart](./kibana-plugin-core-public.chromestart.md) |
 |  [deprecations](./kibana-plugin-core-public.corestart.deprecations.md) | DeprecationsServiceStart | [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) |
 |  [docLinks](./kibana-plugin-core-public.corestart.doclinks.md) | DocLinksStart | [DocLinksStart](./kibana-plugin-core-public.doclinksstart.md) |
+|  [executionContext](./kibana-plugin-core-public.corestart.executioncontext.md) | ExecutionContextStart |  |
 |  [fatalErrors](./kibana-plugin-core-public.corestart.fatalerrors.md) | FatalErrorsStart | [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) |
 |  [http](./kibana-plugin-core-public.corestart.http.md) | HttpStart | [HttpStart](./kibana-plugin-core-public.httpstart.md) |
 |  [i18n](./kibana-plugin-core-public.corestart.i18n.md) | I18nStart | [I18nStart](./kibana-plugin-core-public.i18nstart.md) |

docs/development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.md

@@ -10,9 +10,10 @@ Represents a meta-information about a Kibana entity initiating a search request.
 
 ```typescript
 export declare type KibanaExecutionContext = {
-    readonly type: string;
-    readonly name: string;
-    readonly id: string;
+    readonly type?: string;
+    readonly name?: string;
+    readonly page?: string;
+    readonly id?: string;
     readonly description?: string;
     readonly url?: string;
     child?: KibanaExecutionContext;

docs/development/core/server/kibana-plugin-core-server.kibanaexecutioncontext.md

@@ -10,9 +10,10 @@ Represents a meta-information about a Kibana entity initiating a search request.
 
 ```typescript
 export declare type KibanaExecutionContext = {
-    readonly type: string;
-    readonly name: string;
-    readonly id: string;
+    readonly type?: string;
+    readonly name?: string;
+    readonly page?: string;
+    readonly id?: string;
     readonly description?: string;
     readonly url?: string;
     child?: KibanaExecutionContext;

src/core/public/apm_system.test.ts

@@ -13,6 +13,7 @@ import type { Transaction } from '@elastic/apm-rum';
 import { ApmSystem } from './apm_system';
 import { Subject } from 'rxjs';
 import { InternalApplicationStart } from './application/types';
+import { executionContextServiceMock } from './execution_context/execution_context_service.mock';
 
 const initMock = init as jest.Mocked<typeof init>;
 const apmMock = apm as DeeplyMockedKeys<typeof apm>;
@@ -96,6 +97,7 @@ describe('ApmSystem', () => {
           application: {
             currentAppId$,
           } as any as InternalApplicationStart,
+          executionContext: executionContextServiceMock.createInternalStartContract(),
         });
 
         expect(mark).toHaveBeenCalledWith('apm-start');
@@ -118,6 +120,7 @@ describe('ApmSystem', () => {
           application: {
             currentAppId$,
           } as any as InternalApplicationStart,
+          executionContext: executionContextServiceMock.createInternalStartContract(),
         });
         currentAppId$.next('myapp');
 
@@ -145,6 +148,7 @@ describe('ApmSystem', () => {
           application: {
             currentAppId$,
           } as any as InternalApplicationStart,
+          executionContext: executionContextServiceMock.createInternalStartContract(),
         });
         currentAppId$.next('myapp');
 

src/core/public/apm_system.ts

@@ -10,6 +10,7 @@ import type { ApmBase, AgentConfigOptions, Transaction } from '@elastic/apm-rum'
 import { modifyUrl } from '@kbn/std';
 import { CachedResourceObserver } from './apm_resource_counter';
 import type { InternalApplicationStart } from './application';
+import { ExecutionContextStart } from './execution_context';
 
 /** "GET protocol://hostname:port/pathname" */
 const HTTP_REQUEST_TRANSACTION_NAME_REGEX =
@@ -27,13 +28,15 @@ interface ApmConfig extends AgentConfigOptions {
 
 interface StartDeps {
   application: InternalApplicationStart;
+  executionContext: ExecutionContextStart;
 }
 
 export class ApmSystem {
   private readonly enabled: boolean;
   private pageLoadTransaction?: Transaction;
   private resourceObserver: CachedResourceObserver;
   private apm?: ApmBase;
+
   /**
    * `apmConfig` would be populated with relevant APM RUM agent
    * configuration if server is started with elastic.apm.* config.
@@ -64,6 +67,20 @@ export class ApmSystem {
 
     this.markPageLoadStart();
 
+    start.executionContext.context$.subscribe((c) => {
+      // We're using labels because we want the context to be indexed
+      // https://www.elastic.co/guide/en/apm/get-started/current/metadata.html
+      const apmContext = {
+        appId: c.name,
+        page: c.page,
+        id: c.id,
+      };
+
+      this.apm?.addLabels(apmContext);
+    });
+
+    // TODO: Start a new transaction every page change instead of every app change.
+
     /**
      * Register listeners for navigation changes and capture them as
      * route-change transactions after Kibana app is bootstrapped

src/core/public/core_system.ts

@@ -31,6 +31,7 @@ import { DeprecationsService } from './deprecations';
 import { ThemeService } from './theme';
 import { CoreApp } from './core_app';
 import type { InternalApplicationSetup, InternalApplicationStart } from './application/types';
+import { ExecutionContextService } from './execution_context';
 
 interface Params {
   rootDomElement: HTMLElement;
@@ -87,6 +88,7 @@ export class CoreSystem {
   private readonly theme: ThemeService;
   private readonly rootDomElement: HTMLElement;
   private readonly coreContext: CoreContext;
+  private readonly executionContext: ExecutionContextService;
   private fatalErrorsSetup: FatalErrorsSetup | null = null;
 
   constructor(params: Params) {
@@ -121,6 +123,7 @@ export class CoreSystem {
     this.application = new ApplicationService();
     this.integrations = new IntegrationsService();
     this.deprecations = new DeprecationsService();
+    this.executionContext = new ExecutionContextService();
 
     this.plugins = new PluginsService(this.coreContext, injectedMetadata.uiPlugins);
     this.coreApp = new CoreApp(this.coreContext);
@@ -137,7 +140,13 @@ export class CoreSystem {
       });
       await this.integrations.setup();
       this.docLinks.setup();
-      const http = this.http.setup({ injectedMetadata, fatalErrors: this.fatalErrorsSetup });
+
+      const executionContext = this.executionContext.setup();
+      const http = this.http.setup({
+        injectedMetadata,
+        fatalErrors: this.fatalErrorsSetup,
+        executionContext,
+      });
       const uiSettings = this.uiSettings.setup({ http, injectedMetadata });
       const notifications = this.notifications.setup({ uiSettings });
       const theme = this.theme.setup({ injectedMetadata });
@@ -153,6 +162,7 @@ export class CoreSystem {
         notifications,
         theme,
         uiSettings,
+        executionContext,
       };
 
       // Services that do not expose contracts at setup
@@ -201,6 +211,11 @@ export class CoreSystem {
         targetDomElement: notificationsTargetDomElement,
       });
       const application = await this.application.start({ http, theme, overlays });
+
+      const executionContext = this.executionContext.start({
+        curApp$: application.currentAppId$,
+      });
+
       const chrome = await this.chrome.start({
         application,
         docLinks,
@@ -216,6 +231,7 @@ export class CoreSystem {
         application,
         chrome,
         docLinks,
+        executionContext,
         http,
         theme,
         savedObjects,
@@ -248,6 +264,7 @@ export class CoreSystem {
 
       return {
         application,
+        executionContext,
       };
     } catch (error) {
       if (this.fatalErrorsSetup) {

src/core/public/execution_context/execution_context_service.mock.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { PublicMethodsOf } from '@kbn/utility-types';
+import { BehaviorSubject } from 'rxjs';
+
+import { ExecutionContextService, ExecutionContextSetup } from './execution_context_service';
+
+const createContractMock = (): jest.Mocked<ExecutionContextSetup> => ({
+  context$: new BehaviorSubject({}),
+  clear: jest.fn(),
+  set: jest.fn(),
+  getAll: jest.fn(),
+});
+
+const createMock = (): jest.Mocked<PublicMethodsOf<ExecutionContextService>> => ({
+  setup: jest.fn().mockReturnValue(createContractMock()),
+  start: jest.fn().mockReturnValue(createContractMock()),
+  stop: jest.fn(),
+});
+
+export const executionContextServiceMock = {
+  create: createMock,
+  createSetupContract: createContractMock,
+  createStartContract: createContractMock,
+  createInternalSetupContract: createContractMock,
+  createInternalStartContract: createContractMock,
+};

src/core/public/execution_context/execution_context_service.ts

@@ -0,0 +1,85 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { isEqual } from 'lodash';
+import { BehaviorSubject, Observable, Subscription } from 'rxjs';
+import { distinctUntilChanged } from 'rxjs/operators';
+import { CoreService } from '../../types';
+
+export type ExecutionContext = Record<string, any>;
+
+/** @public */
+export interface ExecutionContextSetup {
+  context$: Observable<ExecutionContext>;
+  set(c$: ExecutionContext): void;
+  getAll(): ExecutionContext;
+  clear(): void;
+}
+
+/**
+ * See {@link ExecutionContextSetup}.
+ * @public
+ */
+export type ExecutionContextStart = ExecutionContextSetup;
+
+export interface StartDeps {
+  curApp$: Observable<string | undefined>;
+}
+
+/** @internal */
+export class ExecutionContextService
+  implements CoreService<ExecutionContextSetup, ExecutionContextStart>
+{
+  private context$: BehaviorSubject<ExecutionContext> = new BehaviorSubject({});
+  private appId?: string;
+  private subscription: Subscription = new Subscription();
+  private contract?: ExecutionContextSetup;
+
+  public setup() {
+    this.contract = {
+      context$: this.context$,
+      clear: () => {
+        this.context$.next({});
+      },
+      set: (c: ExecutionContext) => {
+        const newVal = {
+          url: window.location.pathname,
+          name: this.appId,
+          ...this.context$.value,
+          ...c,
+        };
+        if (!isEqual(newVal, this.context$.value)) {
+          this.context$.next(newVal);
+        }
+      },
+      getAll: () => {
+        return this.context$.value;
+      },
+    };
+
+    return this.contract;
+  }
+
+  public start({ curApp$ }: StartDeps) {
+    const start = this.contract!;
+
+    // Track app id changes and clear context on app change
+    this.subscription.add(
+      curApp$.pipe(distinctUntilChanged()).subscribe((appId) => {
+        start.clear();
+        this.appId = appId;
+      })
+    );
+
+    return start;
+  }
+
+  public stop() {
+    this.subscription.unsubscribe();
+  }
+}

src/core/public/execution_context/index.ts

@@ -8,3 +8,5 @@
 
 export type { KibanaExecutionContext } from '../../types';
 export { ExecutionContextContainer } from './execution_context_container';
+export { ExecutionContextService } from './execution_context_service';
+export type { ExecutionContextSetup, ExecutionContextStart } from './execution_context_service';

src/core/public/http/fetch.test.ts

@@ -15,6 +15,7 @@ import { first } from 'rxjs/operators';
 import { Fetch } from './fetch';
 import { BasePath } from './base_path';
 import { HttpResponse, HttpFetchOptionsWithPath } from './types';
+import { executionContextServiceMock } from '../execution_context/execution_context_service.mock';
 
 function delay<T>(duration: number) {
   return new Promise<T>((r) => setTimeout(r, duration));
@@ -26,6 +27,7 @@ describe('Fetch', () => {
   const fetchInstance = new Fetch({
     basePath: new BasePath(BASE_PATH),
     kibanaVersion: 'VERSION',
+    executionContext: executionContextServiceMock.createSetupContract(),
   });
   afterEach(() => {
     fetchMock.restore();