Merge branch 'master' into persistable_stae

Author: kibanamachine

dev_docs/assets/pr_details.png

@@ -0,0 +1,85 @@
+---
+id: kibDevTutorialSubmitPullRequest
+slug: /kibana-dev-docs/tutorial/submit-pull-request
+title: Submitting a Kibana pull request
+summary: Learn how to submit a Kibana pull request
+date: 2021-06-24
+tags: ['kibana', 'onboarding', 'dev', 'tutorials', 'github', 'pr', 'pull request', 'ci']
+---
+
+## Create and clone a fork of Kibana
+
+Kibana has hundreds of developers, some of whom are outside of Elastic, so we use a fork-based approach for creating branches and pull requests.
+
+To create and clone a fork:
+
+1. Login to [GitHub](https://github.com)
+2. Navigate to the [Kibana repository](https://github.com/elastic/kibana)
+3. Follow the [GitHub instructions](https://docs.github.com/en/get-started/quickstart/fork-a-repo) for forking and cloning repos
+
+## Create a branch
+
+After cloning your fork and navigating to the directory containing your fork:
+
+```bash
+# Make sure you currently have the branch checked out off of which you'd like to work
+git checkout master
+
+# Create a new branch
+git checkout -b fix-typos-in-readme
+
+# Edit some code
+vi README.md
+
+# Add/commit the change
+git add README.md
+git commit -m "Fixed all of the typos in the README"
+
+# Push the branch to your fork
+git push -u origin fix-typos-in-readme
+```
+
+If this is a new branch, you will see a link in your terminal that points you directly to a page to create a pull request for that branch.
+
+## Create a pull request
+
+1. Navigate to your fork in Github
+2. If you see your branch at the top of the screen with a `Compare & pull request` button, click that. Otherwise:
+   1. Navigate to your branch
+   2. Click Contribute, followed by `Open pull request`
+3. Fill out the details that are relevant for your change in the pull request template
+   1. If your pull request relates to an open issue, you can also reference that issue here, e.g. `Closes #12345`
+4. [Elastic employees only] Add any teams/people that need to review your code under Reviewers. There's a good chance one or more teams will automatically be added based on which part of the codebase in which your changes were made.
+5. [Elastic employees only] Add any relevant labels
+   1. Versions: Add a label for each version of Kibana in which your change will ship. For example, `v8.0.0`, `v7.14.0`
+   2. Features: Add labels for any relevant feature areas, e.g. `Feature:Development`
+   3. Team: Most PRs should have at least one `Team:` label. Add labels for teams that should follow or are responsible for the pull request.
+   4. Release Note: Add `release_note:skip` if this pull request should not automatically get added to release notes for Kibana
+   5. Auto Backport: Add `auto-backport` if you'd like your pull request automatically backported to all labeled versions.
+6. Submit the pull request. If it's not quite ready for review, it can also be submitted as a Draft pull request.
+
+![Screenshot of Compare and pull request header](../assets/pr_header.png)
+
+![Screenshot of opening a pull request from the branch page](../assets/pr_open.png)
+
+![Screenshot of pull request details](../assets/pr_details.png)
+
+## Sign the Contributor Agreement
+
+If this is your first pull request, a bot will post a comment asking you to sign our [CLA / Contributor Agreement](https://www.elastic.co/contributor-agreement). Your pull request won't be able to be merged until you've reviewed and signed the agreement.
+
+## Review Process
+
+At this point, your pull request will be reviewed, discussed, etc. Changes will likely be requested. For complex pull requests, this process could take several weeks. Please be patient and understand we hold our code base to a high standard.
+
+See [Pull request review guidelines](https://www.elastic.co/guide/en/kibana/master/pr-review.html) for our general philosophy for pull request reviews.
+
+## Updating your PR with upstream
+
+If your pull request hasn't been updated with the latest code from the upstream/target branch, e.g. `master`, in the last 48 hours, it won't be able to merge until it is updated. This is to help prevent problems that could occur by merging stale code into upstream, e.g. something new was recently merged that is incompatible with something in your pull request.
+
+As an alternative to using `git` to manually update your branch, you can leave a comment on your pull request with the text `@elasticmachine merge upstream`. This will automatically update your branch and kick off CI for it.
+
+## Re-triggering CI
+
+The easiest way to re-trigger CI is to simply update your branch (see above) with the latest code from upstream. This has the added benefit of ensuring that your branch is up-to-date and compatible.

dev_docs/assets/pr_header.png

@@ -80,7 +80,7 @@ browser so that it does not block pop-up windows or create an exception for your
 
 For more information about the {anomaly-detect} feature, see
 https://www.elastic.co/what-is/elastic-stack-machine-learning[{ml-cap} in the {stack}]
-and {ml-docs}/xpack-ml.html[{ml-cap} {anomaly-detect}].
+and {ml-docs}/ml-ad-overview.html[{ml-cap} {anomaly-detect}].
 
 [[xpack-ml-dfanalytics]]
 == {dfanalytics-cap}

dev_docs/assets/pr_open.png

@@ -136,10 +136,10 @@ These can be used to automatically update the list of hosts as a cluster is resi
 [float]
 [[memory]]
 === Memory
-Kibana has a default maximum memory limit of 1.4 GB, and in most cases, we recommend leaving this unconfigured.  In some scenarios, such as large reporting jobs,
+Kibana has a default memory limit that scales based on total memory available.  In some scenarios, such as large reporting jobs, 
 it may make sense to tweak limits to meet more specific requirements.
 
-You can modify this limit by setting `--max-old-space-size` in the `node.options` config file that can be found inside `kibana/config` folder or any other configured with the environment variable `KBN_PATH_CONF` (for example in debian based system would be `/etc/kibana`).
+A limit can be defined by setting `--max-old-space-size` in the `node.options` config file found inside the `kibana/config` folder or any other folder configured with the environment variable `KBN_PATH_CONF`. For example, in the Debian-based system, the folder is `/etc/kibana`.
 
 The option accepts a limit in MB:
 [source,js]

dev_docs/tutorials/submit_a_pull_request.mdx

@@ -65,6 +65,10 @@ image::user/security/images/kibana-login.png["Login Selector UI"]
 
 For more information, refer to <<authentication-security-settings, authentication security settings>>.
 
+TIP: If you have multiple authentication providers configured, you can use the `auth_provider_hint` URL query parameter to create a deep
+link to any provider and bypass the Login Selector UI. Using the `kibana.yml` above as an example, you can add `?auth_provider_hint=basic1`
+to the login page URL, which will take you directly to the basic login page.
+
 [[basic-authentication]]
 ==== Basic authentication
 

docs/user/ml/index.asciidoc

@@ -83,7 +83,7 @@
     "**/minimist": "^1.2.5",
     "**/node-jose/node-forge": "^0.10.0",
     "**/pdfkit/crypto-js": "4.0.0",
-    "**/prismjs": "1.23.0",
+    "**/prismjs": "1.24.0",
     "**/react-syntax-highlighter": "^15.3.1",
     "**/react-syntax-highlighter/**/highlight.js": "^10.4.1",
     "**/refractor": "^3.3.1",
@@ -99,7 +99,7 @@
   "dependencies": {
     "@elastic/apm-rum": "^5.8.0",
     "@elastic/apm-rum-react": "^1.2.11",
-    "@elastic/charts": "31.0.0",
+    "@elastic/charts": "31.1.0",
     "@elastic/datemath": "link:bazel-bin/packages/elastic-datemath",
     "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@^8.0.0-canary.13",
     "@elastic/ems-client": "7.14.0",
@@ -310,7 +310,7 @@
     "nock": "12.0.3",
     "node-fetch": "^2.6.1",
     "node-forge": "^0.10.0",
-    "nodemailer": "^6.4.16",
+    "nodemailer": "^6.6.2",
     "normalize-path": "^3.0.0",
     "object-hash": "^1.3.1",
     "object-path-immutable": "^3.1.1",

docs/user/production-considerations/production.asciidoc

@@ -17,10 +17,11 @@ import {
 
 import { ApmConfiguration } from './config';
 
-const initialEnv = { ...process.env };
-
 describe('ApmConfiguration', () => {
   beforeEach(() => {
+    // start with an empty env to avoid CI from spoiling snapshots, env is unique for each jest file
+    process.env = {};
+
     packageMock.raw = {
       version: '8.0.0',
       build: {
@@ -30,7 +31,6 @@ describe('ApmConfiguration', () => {
   });
 
   afterEach(() => {
-    process.env = { ...initialEnv };
     resetAllMocks();
   });
 
@@ -46,7 +46,7 @@ describe('ApmConfiguration', () => {
   it('sets the git revision from `git rev-parse` command in non distribution mode', () => {
     gitRevExecMock.mockReturnValue('some-git-rev');
     const config = new ApmConfiguration(mockedRootDir, {}, false);
-    expect(config.getConfig('serviceName').globalLabels.git_rev).toBe('some-git-rev');
+    expect(config.getConfig('serviceName').globalLabels?.git_rev).toBe('some-git-rev');
   });
 
   it('sets the git revision from `pkg.build.sha` in distribution mode', () => {
@@ -58,13 +58,13 @@ describe('ApmConfiguration', () => {
       },
     };
     const config = new ApmConfiguration(mockedRootDir, {}, true);
-    expect(config.getConfig('serviceName').globalLabels.git_rev).toBe('distribution-sha');
+    expect(config.getConfig('serviceName').globalLabels?.git_rev).toBe('distribution-sha');
   });
 
   it('reads the kibana uuid from the uuid file', () => {
     readUuidFileMock.mockReturnValue('instance-uuid');
     const config = new ApmConfiguration(mockedRootDir, {}, false);
-    expect(config.getConfig('serviceName').globalLabels.kibana_uuid).toBe('instance-uuid');
+    expect(config.getConfig('serviceName').globalLabels?.kibana_uuid).toBe('instance-uuid');
   });
 
   it('uses the uuid from the kibana config if present', () => {
@@ -75,23 +75,51 @@ describe('ApmConfiguration', () => {
       },
     };
     const config = new ApmConfiguration(mockedRootDir, kibanaConfig, false);
-    expect(config.getConfig('serviceName').globalLabels.kibana_uuid).toBe('uuid-from-config');
+    expect(config.getConfig('serviceName').globalLabels?.kibana_uuid).toBe('uuid-from-config');
   });
 
-  it('uses the correct default config depending on the `isDistributable` parameter', () => {
+  it('overrides metricsInterval, breakdownMetrics, captureHeaders, and captureBody when `isDistributable` is true', () => {
     let config = new ApmConfiguration(mockedRootDir, {}, false);
-    expect(config.getConfig('serviceName')).toEqual(
-      expect.objectContaining({
-        breakdownMetrics: true,
-      })
-    );
+    expect(config.getConfig('serviceName')).toMatchInlineSnapshot(`
+      Object {
+        "active": false,
+        "breakdownMetrics": true,
+        "captureSpanStackTraces": false,
+        "centralConfig": false,
+        "environment": "development",
+        "globalLabels": Object {},
+        "logUncaughtExceptions": true,
+        "metricsInterval": "30s",
+        "secretToken": "ZQHYvrmXEx04ozge8F",
+        "serverUrl": "https://38b80fbd79fb4c91bae06b4642d4d093.apm.us-east-1.aws.cloud.es.io",
+        "serviceName": "serviceName",
+        "serviceVersion": "8.0.0",
+        "transactionSampleRate": 1,
+      }
+    `);
 
     config = new ApmConfiguration(mockedRootDir, {}, true);
-    expect(config.getConfig('serviceName')).toEqual(
-      expect.objectContaining({
-        breakdownMetrics: false,
-      })
-    );
+    expect(config.getConfig('serviceName')).toMatchInlineSnapshot(`
+      Object {
+        "active": false,
+        "breakdownMetrics": false,
+        "captureBody": "off",
+        "captureHeaders": false,
+        "captureSpanStackTraces": false,
+        "centralConfig": false,
+        "environment": "development",
+        "globalLabels": Object {
+          "git_rev": "sha",
+        },
+        "logUncaughtExceptions": true,
+        "metricsInterval": "120s",
+        "secretToken": "ZQHYvrmXEx04ozge8F",
+        "serverUrl": "https://38b80fbd79fb4c91bae06b4642d4d093.apm.us-east-1.aws.cloud.es.io",
+        "serviceName": "serviceName",
+        "serviceVersion": "8.0.0",
+        "transactionSampleRate": 1,
+      }
+    `);
   });
 
   it('loads the configuration from the kibana config file', () => {
@@ -119,7 +147,7 @@ describe('ApmConfiguration', () => {
       active: true,
       serverUrl: 'https://dev-url.co',
     };
-    const config = new ApmConfiguration(mockedRootDir, {}, true);
+    const config = new ApmConfiguration(mockedRootDir, {}, false);
     expect(config.getConfig('serviceName')).toEqual(
       expect.objectContaining({
         active: true,
@@ -128,7 +156,20 @@ describe('ApmConfiguration', () => {
     );
   });
 
-  it('respect the precedence of the dev config', () => {
+  it('does not load the configuration from the dev config in distributable', () => {
+    devConfigMock.raw = {
+      active: true,
+      serverUrl: 'https://dev-url.co',
+    };
+    const config = new ApmConfiguration(mockedRootDir, {}, true);
+    expect(config.getConfig('serviceName')).toEqual(
+      expect.objectContaining({
+        active: false,
+      })
+    );
+  });
+
+  it('overwrites the standard config file with the dev config', () => {
     const kibanaConfig = {
       elastic: {
         apm: {
@@ -142,7 +183,7 @@ describe('ApmConfiguration', () => {
       active: true,
       serverUrl: 'https://dev-url.co',
     };
-    const config = new ApmConfiguration(mockedRootDir, kibanaConfig, true);
+    const config = new ApmConfiguration(mockedRootDir, kibanaConfig, false);
     expect(config.getConfig('serviceName')).toEqual(
       expect.objectContaining({
         active: true,
@@ -152,7 +193,7 @@ describe('ApmConfiguration', () => {
     );
   });
 
-  it('correctly sets environment', () => {
+  it('correctly sets environment by reading env vars', () => {
     delete process.env.ELASTIC_APM_ENVIRONMENT;
     delete process.env.NODE_ENV;