Merge branch '7.x' into backport/7.x/pr-78889

examples/embeddable_examples/kibana.json

@@ -4,7 +4,7 @@
   "kibanaVersion": "kibana",
   "server": true,
   "ui": true,
-  "requiredPlugins": ["embeddable", "uiActions", "dashboard"],
+  "requiredPlugins": ["embeddable", "uiActions", "dashboard", "savedObjects"],
   "optionalPlugins": [],
   "extraPublicDirs": ["public/todo", "public/hello_world", "public/todo/todo_ref_embeddable"],
   "requiredBundles": ["kibanaReact"]

examples/embeddable_examples/public/book/book_embeddable_factory.tsx

@@ -33,12 +33,19 @@ import {
   BookEmbeddableOutput,
 } from './book_embeddable';
 import { CreateEditBookComponent } from './create_edit_book_component';
-import { OverlayStart } from '../../../../src/core/public';
+import {
+  OverlayStart,
+  SavedObjectsClientContract,
+  SimpleSavedObject,
+} from '../../../../src/core/public';
 import { DashboardStart, AttributeService } from '../../../../src/plugins/dashboard/public';
+import { checkForDuplicateTitle, OnSaveProps } from '../../../../src/plugins/saved_objects/public';
 
 interface StartServices {
   getAttributeService: DashboardStart['getAttributeService'];
   openModal: OverlayStart['openModal'];
+  savedObjectsClient: SavedObjectsClientContract;
+  overlays: OverlayStart;
 }
 
 export type BookEmbeddableFactory = EmbeddableFactory<
@@ -117,11 +124,55 @@ export class BookEmbeddableFactoryDefinition
     });
   }
 
+  private async unwrapMethod(savedObjectId: string): Promise<BookSavedObjectAttributes> {
+    const { savedObjectsClient } = await this.getStartServices();
+    const savedObject: SimpleSavedObject<BookSavedObjectAttributes> = await savedObjectsClient.get<
+      BookSavedObjectAttributes
+    >(this.type, savedObjectId);
+    return { ...savedObject.attributes };
+  }
+
+  private async saveMethod(
+    type: string,
+    attributes: BookSavedObjectAttributes,
+    savedObjectId?: string
+  ) {
+    const { savedObjectsClient } = await this.getStartServices();
+    if (savedObjectId) {
+      return savedObjectsClient.update(type, savedObjectId, attributes);
+    }
+    return savedObjectsClient.create(type, attributes);
+  }
+
+  private async checkForDuplicateTitleMethod(props: OnSaveProps): Promise<true> {
+    const start = await this.getStartServices();
+    const { savedObjectsClient, overlays } = start;
+    return checkForDuplicateTitle(
+      {
+        title: props.newTitle,
+        copyOnSave: false,
+        lastSavedTitle: '',
+        getEsType: () => this.type,
+        getDisplayName: this.getDisplayName || (() => this.type),
+      },
+      props.isTitleDuplicateConfirmed,
+      props.onTitleDuplicate,
+      {
+        savedObjectsClient,
+        overlays,
+      }
+    );
+  }
+
   private async getAttributeService() {
     if (!this.attributeService) {
-      this.attributeService = await (await this.getStartServices()).getAttributeService<
+      this.attributeService = (await this.getStartServices()).getAttributeService<
         BookSavedObjectAttributes
-      >(this.type);
+      >(this.type, {
+        saveMethod: this.saveMethod.bind(this),
+        unwrapMethod: this.unwrapMethod.bind(this),
+        checkForDuplicateTitle: this.checkForDuplicateTitleMethod.bind(this),
+      });
     }
     return this.attributeService!;
   }

examples/embeddable_examples/public/book/edit_book_action.tsx

@@ -31,10 +31,13 @@ import {
 } from './book_embeddable';
 import { CreateEditBookComponent } from './create_edit_book_component';
 import { DashboardStart } from '../../../../src/plugins/dashboard/public';
+import { OnSaveProps } from '../../../../src/plugins/saved_objects/public';
+import { SavedObjectsClientContract } from '../../../../src/core/target/types/public/saved_objects';
 
 interface StartServices {
   openModal: OverlayStart['openModal'];
   getAttributeService: DashboardStart['getAttributeService'];
+  savedObjectsClient: SavedObjectsClientContract;
 }
 
 interface ActionContext {
@@ -56,8 +59,24 @@ export const createEditBookAction = (getStartServices: () => Promise<StartServic
       );
     },
     execute: async ({ embeddable }: ActionContext) => {
-      const { openModal, getAttributeService } = await getStartServices();
-      const attributeService = getAttributeService<BookSavedObjectAttributes>(BOOK_SAVED_OBJECT);
+      const { openModal, getAttributeService, savedObjectsClient } = await getStartServices();
+      const attributeService = getAttributeService<BookSavedObjectAttributes>(BOOK_SAVED_OBJECT, {
+        saveMethod: async (
+          type: string,
+          attributes: BookSavedObjectAttributes,
+          savedObjectId?: string
+        ) => {
+          if (savedObjectId) {
+            return savedObjectsClient.update(type, savedObjectId, attributes);
+          }
+          return savedObjectsClient.create(type, attributes);
+        },
+        checkForDuplicateTitle: (props: OnSaveProps) => {
+          return new Promise(() => {
+            return true;
+          });
+        },
+      });
       const onSave = async (attributes: BookSavedObjectAttributes, useRefType: boolean) => {
         const newInput = await attributeService.wrapAttributes(
           attributes,

examples/embeddable_examples/public/plugin.ts

@@ -22,7 +22,7 @@ import {
   EmbeddableStart,
   CONTEXT_MENU_TRIGGER,
 } from '../../../src/plugins/embeddable/public';
-import { Plugin, CoreSetup, CoreStart } from '../../../src/core/public';
+import { Plugin, CoreSetup, CoreStart, SavedObjectsClient } from '../../../src/core/public';
 import {
   HelloWorldEmbeddableFactory,
   HELLO_WORLD_EMBEDDABLE,
@@ -76,6 +76,7 @@ export interface EmbeddableExamplesSetupDependencies {
 export interface EmbeddableExamplesStartDependencies {
   embeddable: EmbeddableStart;
   dashboard: DashboardStart;
+  savedObjectsClient: SavedObjectsClient;
 }
 
 interface ExampleEmbeddableFactories {
@@ -158,12 +159,15 @@ export class EmbeddableExamplesPlugin
       new BookEmbeddableFactoryDefinition(async () => ({
         getAttributeService: (await core.getStartServices())[1].dashboard.getAttributeService,
         openModal: (await core.getStartServices())[0].overlays.openModal,
+        savedObjectsClient: (await core.getStartServices())[0].savedObjects.client,
+        overlays: (await core.getStartServices())[0].overlays,
       }))
     );
 
     const editBookAction = createEditBookAction(async () => ({
       getAttributeService: (await core.getStartServices())[1].dashboard.getAttributeService,
       openModal: (await core.getStartServices())[0].overlays.openModal,
+      savedObjectsClient: (await core.getStartServices())[0].savedObjects.client,
     }));
     deps.uiActions.registerAction(editBookAction);
     deps.uiActions.attachAction(CONTEXT_MENU_TRIGGER, editBookAction.id);

packages/kbn-apm-config-loader/src/config.test.ts

@@ -42,12 +42,13 @@ describe('ApmConfiguration', () => {
     resetAllMocks();
   });
 
-  it('sets the correct service name', () => {
+  it('sets the correct service name and version', () => {
     packageMock.raw = {
       version: '9.2.1',
     };
     const config = new ApmConfiguration(mockedRootDir, {}, false);
-    expect(config.getConfig('myservice').serviceName).toBe('myservice-9_2_1');
+    expect(config.getConfig('myservice').serviceName).toBe('myservice');
+    expect(config.getConfig('myservice').serviceVersion).toBe('9.2.1');
   });
 
   it('sets the git revision from `git rev-parse` command in non distribution mode', () => {

packages/kbn-apm-config-loader/src/config.ts

@@ -30,8 +30,15 @@ const getDefaultConfig = (isDistributable: boolean): ApmAgentConfig => {
     return {
       active: false,
       globalLabels: {},
+      // Do not use a centralized controlled config
+      centralConfig: false,
+      // Capture all exceptions that are not caught
+      logUncaughtExceptions: true,
+      // Can be performance intensive, disabling by default
+      breakdownMetrics: false,
     };
   }
+
   return {
     active: false,
     serverUrl: 'https://f1542b814f674090afd914960583265f.apm.us-central1.gcp.cloud.es.io:443',
@@ -60,14 +67,14 @@ export class ApmConfiguration {
   ) {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const { version, build } = require(join(this.rootDir, 'package.json'));
-    this.kibanaVersion = version.replace(/\./g, '_');
+    this.kibanaVersion = version;
     this.pkgBuild = build;
   }
 
   public getConfig(serviceName: string): ApmAgentConfig {
     return {
       ...this.getBaseConfig(),
-      serviceName: `${serviceName}-${this.kibanaVersion}`,
+      serviceName,
     };
   }
 
@@ -76,7 +83,8 @@ export class ApmConfiguration {
       const apmConfig = merge(
         getDefaultConfig(this.isDistributable),
         this.getConfigFromKibanaConfig(),
-        this.getDevConfig()
+        this.getDevConfig(),
+        this.getDistConfig()
       );
 
       const rev = this.getGitRev();
@@ -88,6 +96,8 @@ export class ApmConfiguration {
       if (uuid) {
         apmConfig.globalLabels.kibana_uuid = uuid;
       }
+
+      apmConfig.serviceVersion = this.kibanaVersion;
       this.baseConfig = apmConfig;
     }
 
@@ -123,6 +133,19 @@ export class ApmConfiguration {
     }
   }
 
+  /** Config keys that cannot be overridden in production builds */
+  private getDistConfig(): ApmAgentConfig {
+    if (!this.isDistributable) {
+      return {};
+    }
+
+    return {
+      // Headers & body may contain sensitive info
+      captureHeaders: false,
+      captureBody: 'off',
+    };
+  }
+
   private getGitRev() {
     if (this.isDistributable) {
       return this.pkgBuild.sha;

src/apm.js

@@ -36,7 +36,22 @@ module.exports = function (serviceName = name) {
 
   apmConfig = loadConfiguration(process.argv, ROOT_DIR, isKibanaDistributable);
   const conf = apmConfig.getConfig(serviceName);
-  require('elastic-apm-node').start(conf);
+  const apm = require('elastic-apm-node');
+
+  // Filter out all user PII
+  apm.addFilter((payload) => {
+    try {
+      if (payload.context && payload.context.user && typeof payload.context.user === 'object') {
+        Object.keys(payload.context.user).forEach((key) => {
+          payload.context.user[key] = '[REDACTED]';
+        });
+      }
+    } finally {
+      return payload;
+    }
+  });
+
+  apm.start(conf);
 };
 
 module.exports.getConfig = (serviceName) => {
@@ -50,4 +65,3 @@ module.exports.getConfig = (serviceName) => {
   }
   return {};
 };
-module.exports.isKibanaDistributable = isKibanaDistributable;

src/cli/cluster/cluster_manager.ts

@@ -110,6 +110,7 @@ export class ClusterManager {
         type: 'server',
         log: this.log,
         argv: serverArgv,
+        apmServiceName: 'kibana',
       })),
     ];
 

src/cli/cluster/worker.ts

@@ -49,6 +49,7 @@ interface WorkerOptions {
   title?: string;
   watch?: boolean;
   baseArgv?: string[];
+  apmServiceName?: string;
 }
 
 export class Worker extends EventEmitter {
@@ -89,6 +90,7 @@ export class Worker extends EventEmitter {
       NODE_OPTIONS: process.env.NODE_OPTIONS || '',
       kbnWorkerType: this.type,
       kbnWorkerArgv: JSON.stringify([...(opts.baseArgv || baseArgv), ...(opts.argv || [])]),
+      ELASTIC_APM_SERVICE_NAME: opts.apmServiceName || '',
     };
   }
 

src/cli/dev.js

@@ -17,6 +17,6 @@
  * under the License.
  */
 
-require('../apm')(process.env.ELASTIC_APM_PROXY_SERVICE_NAME || 'kibana-proxy');
+require('../apm')(process.env.ELASTIC_APM_SERVICE_NAME || 'kibana-proxy');
 require('../setup_node_env');
 require('./cli');

src/core/public/apm_system.ts

@@ -28,6 +28,7 @@ import type { InternalApplicationStart } from './application';
 
 interface ApmConfig {
   // AgentConfigOptions is not exported from @elastic/apm-rum
+  active?: boolean;
   globalLabels?: Record<string, string>;
 }
 
@@ -39,10 +40,10 @@ export class ApmSystem {
   private readonly enabled: boolean;
   /**
    * `apmConfig` would be populated with relevant APM RUM agent
-   * configuration if server is started with `ELASTIC_APM_ACTIVE=true`
+   * configuration if server is started with elastic.apm.* config.
    */
   constructor(private readonly apmConfig?: ApmConfig) {
-    this.enabled = process.env.IS_KIBANA_DISTRIBUTABLE !== 'true' && apmConfig != null;
+    this.enabled = apmConfig != null && !!apmConfig.active;
   }
 
   async setup() {

src/legacy/server/config/schema.js

@@ -25,6 +25,10 @@ const HANDLED_IN_NEW_PLATFORM = Joi.any().description(
 );
 export default () =>
   Joi.object({
+    elastic: Joi.object({
+      apm: HANDLED_IN_NEW_PLATFORM,
+    }).default(),
+
     pkg: Joi.object({
       version: Joi.string().default(Joi.ref('$version')),
       branch: Joi.string().default(Joi.ref('$branch')),

src/legacy/ui/apm/index.js

@@ -17,30 +17,20 @@
  * under the License.
  */
 
-import { getConfig, isKibanaDistributable } from '../../../apm';
+import { getConfig } from '../../../apm';
 import agent from 'elastic-apm-node';
 
-const apmEnabled = !isKibanaDistributable && process.env.ELASTIC_APM_ACTIVE === 'true';
-
-export function apmImport() {
-  return apmEnabled ? 'import { init } from "@elastic/apm-rum"' : '';
-}
-
-export function apmInit(config) {
-  return apmEnabled ? `init(${config})` : '';
-}
+const apmEnabled = getConfig()?.active;
 
 export function getApmConfig(requestPath) {
   if (!apmEnabled) {
     return null;
   }
   const config = {
     ...getConfig('kibana-frontend'),
-    ...{
-      active: true,
-      pageLoadTransactionName: requestPath,
-    },
+    pageLoadTransactionName: requestPath,
   };
+
   /**
    * Get current active backend transaction to make distrubuted tracing
    * work for rendering the app