Merge branch 'main' into markdown

Author: rshen91

.eslintrc.js

@@ -1111,7 +1111,10 @@ module.exports = {
       },
       overrides: [
         {
-          files: ['x-pack/plugins/security_solution/**/*.{js,mjs,ts,tsx}'],
+          files: [
+            'x-pack/plugins/security_solution/**/*.{js,mjs,ts,tsx}',
+            'x-pack/plugins/cases/public/**/*.{js,mjs,ts,tsx}',
+          ],
           rules: {
             '@typescript-eslint/consistent-type-imports': 'error',
           },

docs/apm/apm-app-users.asciidoc

@@ -28,6 +28,7 @@ Select your use-case to get started:
 * <<apm-app-reader>>
 * <<apm-app-annotation-user-create>>
 * <<apm-app-central-config-user>>
+* <<apm-app-storage-explorer-user-create>>
 * <<apm-app-api-user>>
 
 ////
@@ -53,11 +54,12 @@ To create an APM reader user:
 . Create a new role, named something like `read-apm`, and assign the following privileges:
 +
 --
+:apm-read-view:
+:apm-monitor:
 include::./tab-widgets/apm-app-reader/widget.asciidoc[]
+:!apm-read-view:
+:!apm-monitor:
 --
-+
-TIP: Using the deprecated APM Server binaries?
-Add the privileges under the **Classic APM indices** tab above.
 
 . Assign the `read-apm` role created in the previous step, and the following built-in roles to
 any APM reader users:
@@ -83,9 +85,6 @@ In some instances, you may wish to restrict certain Kibana apps that a user has
 --
 include::./tab-widgets/apm-app-reader/widget.asciidoc[]
 --
-+
-TIP: Using the deprecated APM Server binaries?
-Add the privileges under the **Classic APM indices** tab above.
 
 . Assign feature privileges to any Kibana feature that the user needs access to.
 Here are two examples:
@@ -235,6 +234,33 @@ See <<apm-app-api-user>>.
 ***********************************  ***********************************
 ////
 
+[role="xpack"]
+[[apm-app-storage-explorer-user-create]]
+=== APM app storage explorer user
+
+++++
+<titleabbrev>Create a storage explorer user</titleabbrev>
+++++
+
+[[apm-app-storage-explorer-user]]
+==== Storage explorer user
+
+View the **Storage explorer** in the APM app.
+
+. Create a new role, named something like `storage-explorer_user`,
+and assign the following privileges:
++
+--
+include::./tab-widgets/storage-explorer-user/widget.asciidoc[]
+--
+
+. Assign the `storage-explorer_user` created previously, and the roles and privileges necessary to create
+a <<apm-app-reader-full,full>> or <<apm-app-reader-partial,partial>> APM reader to any users that need to view **Storage explorer** in the APM app.
+
+////
+***********************************  ***********************************
+////
+
 [role="xpack"]
 [[apm-app-api-user]]
 === APM app API user

docs/apm/how-to-guides.asciidoc

@@ -14,6 +14,7 @@ Learn how to perform common APM app tasks.
 * <<machine-learning-integration>>
 * <<apm-lambda>>
 * <<advanced-queries>>
+* <<storage-explorer>>
 * <<transactions-annotations>>
 
 
@@ -35,4 +36,6 @@ include::lambda.asciidoc[]
 
 include::advanced-queries.asciidoc[]
 
+include::storage-explorer.asciidoc[]
+
 include::deployment-annotations.asciidoc[]

docs/apm/images/storage-explorer-expanded.png

@@ -0,0 +1,93 @@
+[[storage-explorer]]
+=== Storage explorer
+
+beta::[]
+
+Analyze your APM data and manage costs with **storage explorer**.
+For example, analyze the storage footprint of each of your services to see which are producing
+large amounts of data--then change the sample rate of a service to lower the amount of data ingested.
+Or, expand the time filter to visualize data trends over time so that you can better forecast
+and prepare for future storage needs.
+
+[role="screenshot"]
+image::apm/images/storage-explorer-overview.png[APM Storage explorer]
+
+[float]
+==== Index lifecycle phases
+
+A default {apm-guide-ref}/ilm-how-to.html[index lifecycle policy] is applied to each APM data stream,
+but can be customized depending on your business needs.
+Use the **Index lifecycle phase** dropdown to visualize and analyze your storage by phase.
+
+Customizing the default APM index lifecycle policies can save money by specifying things like:
+
+* The point at which an index can be moved to less performant hardware.
+* The point at which availability is not as critical and the number of replicas can be reduced.
+* When the index can be safely deleted.
+
+See {apm-guide-ref}/ilm-how-to.html[Index lifecycle management] to learn more about customizing
+the default APM index lifecycle policies.
+
+[float]
+==== Service size chart
+
+The service size chart displays the estimated size of each service over time.
+Expand the time filter to visualize data trends and estimate daily data generation.
+
+[float]
+==== Service statistics table
+
+The service statistics table provides detailed information on each service:
+
+* A list of **service environments**.
+* The **sampling rate**. This value is calculated by dividing the number of sampled transactions by total throughput.
+It might differ from the configured sampling rate for two reasons: with head-based sampling,
+the initial service makes the sampling decision, and with tail-based sampling,
+granular policies allow you to set multiple sample rates.
+* The estimated **size on disk**. This storage size includes both primary and replica shards and is
+calculated by prorating the total size of your indices by the service's document count divided by
+the total number of documents.
+* Number of **transactions**, **spans**, **errors**, and **metrics** — doc count and size on disk.
+
+[role="screenshot"]
+image::apm/images/storage-explorer-expanded.png[APM Storage explorer service breakdown]
+
+As you explore your service statistics, you might want to take action to reduce the number of
+documents and therefore storage size of a particular service.
+
+[float]
+===== Reduce the number of transactions
+To reduce the number of transactions a service generates, configure a more aggressive
+{apm-guide-ref}/sampling.html[transaction sampling policy]. Transaction sampling lowers
+the amount of data ingested without negatively impacting the usefulness of your data.
+
+[float]
+===== Reduce the number of spans
+To reduce the number of spans a service generates, enable
+{apm-guide-ref}/span-compression.html[span compression]. Span compression saves on data
+and transfer costs by compressing multiple, similar spans into a single span.
+
+[float]
+===== Reduce the number of metrics
+To reduce the number of system, runtime, and application metrics,
+tune the APM agent or agents that are collecting the data.
+You can disable the collection of specific metrics with the **disable metrics** configuration.
+Or, you can set the **metrics interval** to zero seconds to deactivate metrics entirely.
+Most APM agents support both options.
+See the relevant {apm-agents-ref}[agent configuration options] for more details.
+
+[float]
+===== Reduce the number of errors
+To reduce the number of errors a service generate,
+work with your developers to change how exceptions are handled in your code.
+
+[float]
+==== Privileges
+
+Storage explorer requires expanded privileges to view.
+See <<apm-app-storage-explorer-user-create>> for more information.
+
+[float]
+==== Limitations
+
+Multi-cluster deployments are not supported.

docs/apm/images/storage-explorer-overview.png

@@ -0,0 +1,29 @@
+// tag::classic-indices[]
+[options="header"]
+|====
+|Type |Privilege |Purpose
+
+|Index
+|`monitor` on `apm-*`
+|Monitor access to `apm-*` for storage explorer
+|====
+// end::classic-indices[]
+
+// tag::data-streams[]
+[options="header"]
+|====
+|Type |Privilege |Purpose
+
+|Index
+|`monitor` on `logs-apm*`
+|Monitor access to `logs-apm*` for storage explorer
+
+|Index
+|`monitor` on `metrics-apm*`
+|Monitor access to `metrics-apm*` for storage explorer
+
+|Index
+|`monitor` on `traces-apm*`
+|Monitor access to `traces-apm*` for storage explorer
+|====
+// end::data-streams[]

docs/apm/storage-explorer.asciidoc

@@ -0,0 +1,40 @@
+++++
+<div class="tabs" data-tab-group="apm-app-storage-explorer-reader">
+  <div role="tablist" aria-label="APM app storage explorer-reader">
+    <button role="tab"
+          aria-selected="true"
+          aria-controls="data-streams-tab"
+          id="data-streams">
+      Data streams
+    </button>
+    <button role="tab"
+            aria-selected="false"
+            aria-controls="classic-indices-tab"
+            id="classic-indices"
+            tabindex="-1">
+      Classic APM indices
+    </button>
+  </div>
+  <div tabindex="0"
+       role="tabpanel"
+       id="data-streams-tab"
+       aria-labelledby="data-streams">
+++++
+
+include::content.asciidoc[tag=data-streams]
+
+++++
+  </div>
+  <div tabindex="0"
+       role="tabpanel"
+       id="classic-indices-tab"
+       aria-labelledby="classic-indices"
+       hidden="">
+++++
+
+include::content.asciidoc[tag=classic-indices]
+
+++++
+  </div>
+</div>
+++++

docs/apm/tab-widgets/storage-explorer-user/content.asciidoc

@@ -0,0 +1,21 @@
+/*
+ * 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 { createBrowserHistory } from 'history';
+import { getState } from '../application/main/services/discover_state';
+import { savedSearchMockWithTimeField, savedSearchMock } from './saved_search';
+import { discoverServiceMock } from './services';
+
+export function getDiscoverStateMock({ isTimeBased = true }) {
+  const history = createBrowserHistory();
+  history.push('/');
+  return getState({
+    savedSearch: isTimeBased ? savedSearchMockWithTimeField : savedSearchMock,
+    services: discoverServiceMock,
+    history,
+  });
+}

docs/apm/tab-widgets/storage-explorer-user/widget.asciidoc

@@ -37,9 +37,20 @@ import { LocalStorageMock } from '../../../../__mocks__/local_storage_mock';
 import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
 import { DiscoverServices } from '../../../../build_services';
 import { buildDataTableRecord } from '../../../../utils/build_data_record';
+import { DiscoverAppStateProvider } from '../../services/discover_app_state_container';
+import { getDiscoverStateMock } from '../../../../__mocks__/discover_state.mock';
 
 setHeaderActionMenuMounter(jest.fn());
 
+function getAppStateContainer() {
+  const appStateContainer = getDiscoverStateMock({ isTimeBased: true }).appStateContainer;
+  appStateContainer.set({
+    query: { query: '', language: 'lucene' },
+    filters: [],
+  });
+  return appStateContainer;
+}
+
 function mountComponent(
   dataView: DataView,
   prevSidebarClosed?: boolean,
@@ -167,7 +178,9 @@ function mountComponent(
 
   return mountWithIntl(
     <KibanaContextProvider services={services}>
-      <DiscoverLayout {...(props as DiscoverLayoutProps)} />
+      <DiscoverAppStateProvider value={getAppStateContainer()}>
+        <DiscoverLayout {...(props as DiscoverLayoutProps)} />
+      </DiscoverAppStateProvider>
     </KibanaContextProvider>,
     mountOptions
   );

src/plugins/discover/public/__mocks__/discover_state.mock.ts

@@ -251,7 +251,6 @@ export function DiscoverLayout({
               onRemoveField={onRemoveColumn}
               onChangeDataView={onChangeDataView}
               selectedDataView={dataView}
-              state={state}
               isClosed={isSidebarClosed}
               trackUiMetric={trackUiMetric}
               useNewFieldsApi={useNewFieldsApi}

src/plugins/discover/public/application/main/components/layout/discover_layout.test.tsx

@@ -19,6 +19,8 @@ import { DiscoverField, DiscoverFieldProps } from './discover_field';
 import { DataViewField } from '@kbn/data-views-plugin/public';
 import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
 import { stubDataView } from '@kbn/data-views-plugin/common/data_view.stub';
+import { DiscoverAppStateProvider } from '../../services/discover_app_state_container';
+import { getDiscoverStateMock } from '../../../../__mocks__/discover_state.mock';
 
 jest.mock('@kbn/unified-field-list-plugin/public/services/field_stats', () => ({
   loadFieldStats: jest.fn().mockResolvedValue({
@@ -88,10 +90,6 @@ async function getComponent({
     onRemoveField: jest.fn(),
     showFieldStats,
     selected,
-    state: {
-      query: { query: '', language: 'lucene' },
-      filters: [],
-    },
     contextualFields: [],
   };
   const services = {
@@ -135,9 +133,16 @@ async function getComponent({
     fieldFormats: fieldFormatsServiceMock.createStartContract(),
     charts: chartPluginMock.createSetupContract(),
   };
+  const appStateContainer = getDiscoverStateMock({ isTimeBased: true }).appStateContainer;
+  appStateContainer.set({
+    query: { query: '', language: 'lucene' },
+    filters: [],
+  });
   const comp = await mountWithIntl(
     <KibanaContextProvider services={services}>
-      <DiscoverField {...props} />
+      <DiscoverAppStateProvider value={appStateContainer}>
+        <DiscoverField {...props} />
+      </DiscoverAppStateProvider>
     </KibanaContextProvider>
   );
   // wait for lazy modules