Instrument Kibana with Elastic APM

.gitignore

@@ -29,6 +29,7 @@ disabledPlugins
 webpackstats.json
 /config/*
 !/config/kibana.yml
+!/config/apm.js
 coverage
 selenium
 .babel_register_cache.json

CONTRIBUTING.md

@@ -24,6 +24,7 @@ A high level overview of our contributing guidelines.
   - [Internationalization](#internationalization)
   - [Testing and Building](#testing-and-building)
     - [Debugging server code](#debugging-server-code)
+    - [Instrumenting with Elastic APM](#instrumenting-with-elastic-apm)
   - [Debugging Unit Tests](#debugging-unit-tests)
   - [Unit Testing Plugins](#unit-testing-plugins)
   - [Cross-browser compatibility](#cross-browser-compatibility)
@@ -374,6 +375,21 @@ macOS users on a machine with a discrete graphics card may see significant speed
 ### Debugging Server Code
 `yarn debug` will start the server with Node's inspect flag. Kibana's development mode will start three processes on ports `9229`, `9230`, and `9231`. Chrome's developer tools need to be configured to connect to all three connections. Add `localhost:<port>` for each Kibana process in Chrome's developer tools connection tab.
 
+### Instrumenting with Elastic APM
+Kibana ships with the [Elastic APM Node.js Agent](https://github.com/elastic/apm-agent-nodejs) built-in for debugging purposes.
+
+Its default configuration is meant to be used by core Kibana developers only, but it can easily be re-configured to your needs.
+In its default configuration it's disabled and will, once enabled, send APM data to a centrally managed Elasticsearch cluster accessible only to Elastic employees.
+
+To change the location where data is sent, use the [`serverUrl`](https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html#server-url) APM config option.
+To activate the APM agent, use the [`active`](https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html#active) APM config option.
+
+All config options can be set either via environment variables, or by creating an appropriate config file under `config/apm.dev.js`.
+For more information about configuring the APM agent, please refer to [the documentation](https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuring-the-agent.html).
+
+Once the agent is active, it will trace all incoming HTTP requests to Kibana, monitor for errors, and collect process-level metrics.
+The collected data will be sent to the APM Server and is viewable in the APM UI in Kibana.
+
 ### Unit testing frameworks
 Kibana is migrating unit testing from Mocha to Jest. Legacy unit tests still
 exist in Mocha but all new unit tests should be written in Jest. Mocha tests

config/apm.js

@@ -0,0 +1,81 @@
+/*
+ * 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.
+ */
+
+/**
+ * DO NOT EDIT THIS FILE!
+ *
+ * This file contains the configuration for the Elastic APM instrumentaion of
+ * Kibana itself and is only intented to be used during development of Kibana.
+ *
+ * Instrumentation is turned off by default. Once activated it will send APM
+ * data to an Elasticsearch cluster accessible by Elastic employees.
+ *
+ * To modify the configuration, either use environment variables, or create a
+ * file named `config/apm.dev.js`, which exports a config object as described
+ * in the docs.
+ *
+ * For an overview over the available configuration files, see:
+ * https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html
+ *
+ * For general information about Elastic APM, see:
+ * https://www.elastic.co/guide/en/apm/get-started/current/index.html
+ */
+
+const { readFileSync } = require('fs');
+const { join } = require('path');
+const { execSync } = require('child_process');
+const merge = require('lodash.merge');
+
+module.exports = merge({
+  active: false,
+  serverUrl: 'https://f1542b814f674090afd914960583265f.apm.us-central1.gcp.cloud.es.io:443',
+  // The secretToken below is intended to be hardcoded in this file even though
+  // it makes it public. This is not a security/privacy issue. Normally we'd
+  // instead disable the need for a secretToken in the APM Server config where
+  // the data is transmitted to, but due to how it's being hosted, it's easier,
+  // for now, to simply leave it in.
+  secretToken: 'R0Gjg46pE9K9wGestd',
+  globalLabels: {},
+  centralConfig: false,
+  logUncaughtExceptions: true
+}, devConfig());
+
+const rev = gitRev();
+if (rev !== null) module.exports.globalLabels.git_rev = rev;
+
+try {
+  const filename = join(__dirname, '..', 'data', 'uuid');
+  module.exports.globalLabels.kibana_uuid = readFileSync(filename, 'utf-8');
+} catch (e) {} // eslint-disable-line no-empty
+
+function gitRev() {
+  try {
+    return execSync('git rev-parse --short HEAD', { encoding: 'utf-8' }).trim();
+  } catch (e) {
+    return null;
+  }
+}
+
+function devConfig() {
+  try {
+    return require('./apm.dev'); // eslint-disable-line import/no-unresolved
+  } catch (e) {
+    return {};
+  }
+}

package.json

@@ -159,6 +159,7 @@
     "d3-cloud": "1.2.5",
     "deepmerge": "^4.2.2",
     "del": "^5.1.0",
+    "elastic-apm-node": "^3.2.0",
     "elasticsearch": "^16.5.0",
     "elasticsearch-browser": "^16.5.0",
     "encode-uri-query": "1.0.1",

scripts/kibana.js

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

src/apm.js

@@ -0,0 +1,39 @@
+/*
+ * 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.
+ */
+
+const { existsSync } = require('fs');
+const { join } = require('path');
+const { name, version } = require('../package.json');
+
+module.exports = function (serviceName = name) {
+  if (process.env.kbnWorkerType === 'optmzr') return;
+
+  const conf = {
+    serviceName: `${serviceName}-${version.replace(/\./g, '_')}`
+  };
+
+  if (configFileExists()) conf.configFile = 'config/apm.js';
+  else conf.active = false;
+
+  require('elastic-apm-node').start(conf);
+};
+
+function configFileExists() {
+  return existsSync(join(__dirname, '..', 'config', 'apm.js'));
+}

src/cli/index.js

@@ -17,5 +17,6 @@
  * under the License.
  */
 
+require('../apm')();
 require('../setup_node_env');
 require('./cli');

src/core/server/http/base_path_proxy_server.ts

@@ -17,6 +17,8 @@
  * under the License.
  */
 
+import apm from 'elastic-apm-node';
+
 import { ByteSizeValue } from '@kbn/config-schema';
 import { Server, Request } from 'hapi';
 import Url from 'url';
@@ -139,6 +141,7 @@ export class BasePathProxyServer {
           // Before we proxy request to a target port we may want to wait until some
           // condition is met (e.g. until target listener is ready).
           async (request, responseToolkit) => {
+            apm.setTransactionName(`${request.method.toUpperCase()} /{basePath}/{kbnPath*}`);
             await blockUntil();
             return responseToolkit.continue;
           },

src/dev/build/tasks/copy_source_task.js

@@ -46,6 +46,7 @@ export const CopySourceTask = {
         'typings/**',
         'webpackShims/**',
         'config/kibana.yml',
+        'config/apm.js',
         'tsconfig*.json',
         '.i18nrc.json',
         'kibana.d.ts'