[APM] Migrate server routes to NP

Closes elastic#49238. Pass legacy API to NP plugin in order to use internal SO client Fix issues with agent configuration APIs Update tsconfig template for TS optimization Fix typo
dgieselaar · Nov 21, 2019 · 9b368b4 · 9b368b4
1 parent db401e4
commit 9b368b4
Show file tree

Hide file tree

Showing 102 changed files with 1,212 additions and 849 deletions.
diff --git a/src/legacy/core_plugins/apm_oss/index.js b/src/legacy/core_plugins/apm_oss/index.js
@@ -38,7 +38,6 @@ export default function apmOss(kibana) {
         spanIndices: Joi.string().default('apm-*'),
         metricsIndices: Joi.string().default('apm-*'),
         onboardingIndices: Joi.string().default('apm-*'),
-        apmAgentConfigurationIndex: Joi.string().default('.apm-agent-configuration'),
       }).default();
     },
 

diff --git a/src/plugins/apm_oss/kibana.json b/src/plugins/apm_oss/kibana.json
@@ -0,0 +1,11 @@
+{
+  "id": "apm_oss",
+  "version": "8.0.0",
+  "server": true,
+  "kibanaVersion": "kibana",
+  "configPath": [
+    "apm_oss"
+  ],
+  "ui": false,
+  "requiredPlugins": []
+}
diff --git a/src/plugins/apm_oss/server/index.ts b/src/plugins/apm_oss/server/index.ts
@@ -0,0 +1,41 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { schema, TypeOf } from '@kbn/config-schema';
+import { PluginInitializerContext } from '../../../core/server';
+import { APMOSSPlugin } from './plugin';
+
+export const config = {
+  schema: schema.object({
+    transactionIndices: schema.string({ defaultValue: 'apm-*' }),
+    spanIndices: schema.string({ defaultValue: 'apm-*' }),
+    errorIndices: schema.string({ defaultValue: 'apm-*' }),
+    metricsIndices: schema.string({ defaultValue: 'apm-*' }),
+    sourcemapIndices: schema.string({ defaultValue: 'apm-*' }),
+    onboardingIndices: schema.string({ defaultValue: 'apm-*' }),
+    indexPattern: schema.string({ defaultValue: 'apm-*' }),
+  }),
+};
+
+export function plugin(initializerContext: PluginInitializerContext) {
+  return new APMOSSPlugin(initializerContext);
+}
+
+export type APMOSSConfig = TypeOf<typeof config.schema>;
+
+export { APMOSSPlugin as Plugin };
diff --git a/src/plugins/apm_oss/server/plugin.ts b/src/plugins/apm_oss/server/plugin.ts
@@ -0,0 +1,38 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { Plugin, CoreSetup, PluginInitializerContext } from 'src/core/server';
+import { Observable } from 'rxjs';
+import { APMOSSConfig } from './';
+
+export class APMOSSPlugin implements Plugin<{ config$: Observable<APMOSSConfig> }> {
+  constructor(private readonly initContext: PluginInitializerContext) {
+    this.initContext = initContext;
+  }
+
+  public setup(core: CoreSetup) {
+    const config$ = this.initContext.config.create<APMOSSConfig>();
+
+    return {
+      config$,
+    };
+  }
+
+  start() {}
+  stop() {}
+}
diff --git a/x-pack/legacy/plugins/apm/common/projections/errors.ts b/x-pack/legacy/plugins/apm/common/projections/errors.ts
@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { Setup } from '../../server/lib/helpers/setup_request';
+import { SetupWithAllFilters } from '../../server/lib/helpers/setup_request';
 import {
   PROCESSOR_EVENT,
   SERVICE_NAME,
@@ -16,7 +16,7 @@ export function getErrorGroupsProjection({
   setup,
   serviceName
 }: {
-  setup: Setup;
+  setup: SetupWithAllFilters;
   serviceName: string;
 }) {
   const { start, end, uiFiltersES, indices } = setup;

diff --git a/x-pack/legacy/plugins/apm/common/projections/metrics.ts b/x-pack/legacy/plugins/apm/common/projections/metrics.ts
@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { Setup } from '../../server/lib/helpers/setup_request';
+import { SetupWithAllFilters } from '../../server/lib/helpers/setup_request';
 import {
   SERVICE_NAME,
   PROCESSOR_EVENT,
@@ -30,7 +30,7 @@ export function getMetricsProjection({
   serviceName,
   serviceNodeName
 }: {
-  setup: Setup;
+  setup: SetupWithAllFilters;
   serviceName: string;
   serviceNodeName?: string;
 }) {

diff --git a/x-pack/legacy/plugins/apm/common/projections/service_nodes.ts b/x-pack/legacy/plugins/apm/common/projections/service_nodes.ts
@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { Setup } from '../../server/lib/helpers/setup_request';
+import { SetupWithAllFilters } from '../../server/lib/helpers/setup_request';
 import { SERVICE_NODE_NAME } from '../elasticsearch_fieldnames';
 import { mergeProjection } from './util/merge_projection';
 import { getMetricsProjection } from './metrics';
@@ -14,7 +14,7 @@ export function getServiceNodesProjection({
   serviceName,
   serviceNodeName
 }: {
-  setup: Setup;
+  setup: SetupWithAllFilters;
   serviceName: string;
   serviceNodeName?: string;
 }) {

diff --git a/x-pack/legacy/plugins/apm/common/projections/services.ts b/x-pack/legacy/plugins/apm/common/projections/services.ts
@@ -4,11 +4,15 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { Setup } from '../../server/lib/helpers/setup_request';
+import { SetupWithAllFilters } from '../../server/lib/helpers/setup_request';
 import { SERVICE_NAME, PROCESSOR_EVENT } from '../elasticsearch_fieldnames';
 import { rangeFilter } from '../../server/lib/helpers/range_filter';
 
-export function getServicesProjection({ setup }: { setup: Setup }) {
+export function getServicesProjection({
+  setup
+}: {
+  setup: SetupWithAllFilters;
+}) {
   const { start, end, uiFiltersES, indices } = setup;
 
   return {

diff --git a/x-pack/legacy/plugins/apm/common/projections/transaction_groups.ts b/x-pack/legacy/plugins/apm/common/projections/transaction_groups.ts
@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 import { omit } from 'lodash';
-import { Setup } from '../../server/lib/helpers/setup_request';
+import { SetupWithAllFilters } from '../../server/lib/helpers/setup_request';
 import { TRANSACTION_NAME, PARENT_ID } from '../elasticsearch_fieldnames';
 import { Options } from '../../server/lib/transaction_groups/fetcher';
 import { getTransactionsProjection } from './transactions';
@@ -14,7 +14,7 @@ export function getTransactionGroupsProjection({
   setup,
   options
 }: {
-  setup: Setup;
+  setup: SetupWithAllFilters;
   options: Options;
 }) {
   const transactionsProjection = getTransactionsProjection({

diff --git a/x-pack/legacy/plugins/apm/common/projections/transactions.ts b/x-pack/legacy/plugins/apm/common/projections/transactions.ts
@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { Setup } from '../../server/lib/helpers/setup_request';
+import { SetupWithAllFilters } from '../../server/lib/helpers/setup_request';
 import {
   SERVICE_NAME,
   TRANSACTION_TYPE,
@@ -19,7 +19,7 @@ export function getTransactionsProjection({
   transactionName,
   transactionType
 }: {
-  setup: Setup;
+  setup: SetupWithAllFilters;
   serviceName?: string;
   transactionName?: string;
   transactionType?: string;

diff --git a/x-pack/legacy/plugins/apm/index.ts b/x-pack/legacy/plugins/apm/index.ts
@@ -7,10 +7,10 @@
 import { i18n } from '@kbn/i18n';
 import { Server } from 'hapi';
 import { resolve } from 'path';
-import { PluginInitializerContext } from '../../../../src/core/server';
+import { APMPluginContract } from '../../../plugins/apm/server/plugin';
 import { LegacyPluginInitializer } from '../../../../src/legacy/types';
 import mappings from './mappings.json';
-import { plugin } from './server/new-platform';
+import { makeApmUsageCollector } from './server/lib/apm_telemetry';
 
 export const apm: LegacyPluginInitializer = kibana => {
   return new kibana.Plugin({
@@ -112,15 +112,11 @@ export const apm: LegacyPluginInitializer = kibana => {
           }
         }
       });
+      makeApmUsageCollector(server);
+      const apmPlugin = server.newPlatform.setup.plugins
+        .apm as APMPluginContract;
 
-      const initializerContext = {} as PluginInitializerContext;
-      const legacySetup = {
-        server
-      };
-      plugin(initializerContext).setup(
-        server.newPlatform.setup.core,
-        legacySetup
-      );
+      apmPlugin.registerLegacyAPI({ server });
     }
   });
 };
diff --git a/x-pack/legacy/plugins/apm/mappings.json b/x-pack/legacy/plugins/apm/mappings.json
@@ -61,9 +61,6 @@
       },
       "apm_oss.metricsIndices": {
         "type": "keyword"
-      },
-      "apm_oss.apmAgentConfigurationIndex": {
-        "type": "keyword"
       }
     }
   }

diff --git a/x-pack/legacy/plugins/apm/public/components/app/Settings/ApmIndices/index.tsx b/x-pack/legacy/plugins/apm/public/components/app/Settings/ApmIndices/index.tsx
@@ -63,13 +63,6 @@ const APM_INDEX_LABELS = [
     label: i18n.translate('xpack.apm.settings.apmIndices.metricsIndicesLabel', {
       defaultMessage: 'Metrics Indices'
     })
-  },
-  {
-    configurationName: 'apm_oss.apmAgentConfigurationIndex',
-    label: i18n.translate(
-      'xpack.apm.settings.apmIndices.apmAgentConfigurationIndexLabel',
-      { defaultMessage: 'Agent Configuration Index' }
-    )
   }
 ];
 

diff --git a/x-pack/legacy/plugins/apm/public/services/__test__/callApi.test.ts b/x-pack/legacy/plugins/apm/public/services/__test__/callApi.test.ts
@@ -48,7 +48,7 @@ describe('callApi', () => {
     it('should not add debug param for non-APM endpoints', async () => {
       await callApi(http, { pathname: `/api/kibana` });
 
-      expect(http.get).toHaveBeenCalledWith('/api/kibana', {});
+      expect(http.get).toHaveBeenCalledWith('/api/kibana', { query: {} });
     });
   });
 

diff --git a/x-pack/legacy/plugins/apm/public/services/__test__/callApmApi.test.ts b/x-pack/legacy/plugins/apm/public/services/__test__/callApmApi.test.ts
@@ -81,10 +81,10 @@ describe('callApmApi', () => {
       expect.objectContaining({
         pathname: '/api/apm',
         method: 'POST',
-        body: JSON.stringify({
+        body: {
           foo: 'bar',
           bar: 'foo'
-        })
+        }
       })
     );
   });

diff --git a/x-pack/legacy/plugins/apm/public/services/rest/callApi.ts b/x-pack/legacy/plugins/apm/public/services/rest/callApi.ts
@@ -20,15 +20,23 @@ function fetchOptionsWithDebug(fetchOptions: FetchOptions) {
     sessionStorage.getItem('apm_debug') === 'true' &&
     startsWith(fetchOptions.pathname, '/api/apm');
 
-  if (!debugEnabled) {
-    return fetchOptions;
-  }
+  const isGet = !fetchOptions.method || fetchOptions.method === 'GET';
+
+  // Need an empty body to pass route validation
+  const body = isGet
+    ? {}
+    : {
+        body: JSON.stringify(
+          fetchOptions.body || ({} as HttpFetchOptions['body'])
+        )
+      };
 
   return {
     ...fetchOptions,
+    ...body,
     query: {
       ...fetchOptions.query,
-      _debug: true
+      ...(debugEnabled ? { _debug: true } : {})
     }
   };
 }

diff --git a/x-pack/legacy/plugins/apm/public/services/rest/createCallApmApi.ts b/x-pack/legacy/plugins/apm/public/services/rest/createCallApmApi.ts
@@ -22,10 +22,6 @@ export const createCallApmApi = (http: HttpServiceBase) =>
     const { pathname, params = {}, ...opts } = options;
 
     const path = (params.path || {}) as Record<string, any>;
-    const body = params.body
-      ? { body: JSON.stringify(params.body) }
-      : undefined;
-    const query = params.query ? { query: params.query } : undefined;
 
     const formattedPathname = Object.keys(path).reduce((acc, paramName) => {
       return acc.replace(`{${paramName}}`, path[paramName]);
@@ -34,7 +30,7 @@ export const createCallApmApi = (http: HttpServiceBase) =>
     return callApi(http, {
       ...opts,
       pathname: formattedPathname,
-      ...body,
-      ...query
+      body: params.body,
+      query: params.query
     });
   }) as APMClient;
diff --git a/x-pack/legacy/plugins/apm/public/utils/testHelpers.tsx b/x-pack/legacy/plugins/apm/public/utils/testHelpers.tsx
@@ -15,6 +15,7 @@ import { Moment } from 'moment-timezone';
 import React from 'react';
 import { render, waitForElement } from 'react-testing-library';
 import { MemoryRouter } from 'react-router-dom';
+import { APMConfig } from '../../../../../plugins/apm/server';
 import { LocationProvider } from '../context/LocationContext';
 import { PromiseReturnType } from '../../typings/common';
 import { ESFilter } from '../../typings/elasticsearch';
@@ -99,10 +100,7 @@ interface MockSetup {
   end: number;
   client: any;
   internalClient: any;
-  config: {
-    get: any;
-    has: any;
-  };
+  config: APMConfig;
   uiFiltersES: ESFilter[];
   indices: {
     'apm_oss.sourcemapIndices': string;
@@ -111,7 +109,7 @@ interface MockSetup {
     'apm_oss.spanIndices': string;
     'apm_oss.transactionIndices': string;
     'apm_oss.metricsIndices': string;
-    'apm_oss.apmAgentConfigurationIndex': string;
+    apmAgentConfigurationIndex: string;
   };
 }
 
@@ -139,10 +137,12 @@ export async function inspectSearchParams(
     internalClient: {
       search: internalClientSpy
     } as any,
-    config: {
-      get: () => 'myIndex' as any,
-      has: () => true
-    },
+    config: new Proxy(
+      {},
+      {
+        get: () => 'myIndex'
+      }
+    ) as APMConfig,
     uiFiltersES: [
       {
         term: { 'service.environment': 'prod' }
@@ -155,7 +155,7 @@ export async function inspectSearchParams(
       'apm_oss.spanIndices': 'myIndex',
       'apm_oss.transactionIndices': 'myIndex',
       'apm_oss.metricsIndices': 'myIndex',
-      'apm_oss.apmAgentConfigurationIndex': 'myIndex'
+      apmAgentConfigurationIndex: 'myIndex'
     },
     dynamicIndexPattern: null as any
   };

diff --git a/x-pack/legacy/plugins/apm/scripts/optimize-tsconfig/tsconfig.json b/x-pack/legacy/plugins/apm/scripts/optimize-tsconfig/tsconfig.json
@@ -2,6 +2,7 @@
   "extends": "../../../apm.tsconfig.json",
   "include": [
     "./**/*",
+    "../../../plugins/apm/**/*",
     "../../../typings/**/*"
   ],
   "exclude": [