[Dataset Quality] Add fix it flow for field limit

src/plugins/management/common/locator.ts

@@ -12,10 +12,22 @@ import { LocatorDefinition, LocatorPublic } from '@kbn/share-plugin/common';
 import { MANAGEMENT_APP_LOCATOR } from '@kbn/deeplinks-management/constants';
 import { MANAGEMENT_APP_ID } from './contants';
 
-export interface ManagementAppLocatorParams extends SerializableRecord {
- sectionId: string;
- appId?: string;
-}
+export type ManagementAppLocatorParams = SerializableRecord &
+ (
+ | {
+ sectionId: string;
+ appId?: string;
+ }
+ | {
+ componentTemplate: string;
+ }
+ | {
+ indexTemplate: string;
+ }
+ | {
+ pipeline: string;
+ }
+ );
 
 export type ManagementAppLocator = LocatorPublic<ManagementAppLocatorParams>;
 
@@ -25,7 +37,7 @@ export class ManagementAppLocatorDefinition
  public readonly id = MANAGEMENT_APP_LOCATOR;
 
  public readonly getLocation = async (params: ManagementAppLocatorParams) => {
- const path = `/${params.sectionId}${params.appId ? '/' + params.appId : ''}`;
+ const path = buildPathFromParams(params);
 
  return {
  app: MANAGEMENT_APP_ID,
@@ -34,3 +46,23 @@ export class ManagementAppLocatorDefinition
  };
  };
 }
+
+const buildPathFromParams = (params: ManagementAppLocatorParams) => {
+ if (params.sectionId) {
+ return `/${params.sectionId}${params.appId ? '/' + params.appId : ''}`;
+ }
+
+ if (params.indexTemplate) {
+ return `/data/index_management/templates/${params.indexTemplate}`;
+ }
+
+ if (params.componentTemplate) {
+ return `/data/index_management/component_templates/${params.componentTemplate}`;
+ }
+
+ if (params.pipeline) {
+ return `/ingest/ingest_pipelines/?pipeline=${params.pipeline}`;
+ }
+
+ return '/';
+};

x-pack/plugins/observability_solution/dataset_quality/common/api_types.ts

@@ -134,22 +134,39 @@ export const degradedFieldAnalysisRt = rt.intersection([
  type: rt.string,
  ignore_above: rt.number,
  }),
+ defaultPipeline: rt.string,
  }),
 ]);
 
 export type DegradedFieldAnalysis = rt.TypeOf<typeof degradedFieldAnalysisRt>;
 
-export const dataStreamSettingsRt = rt.intersection([
+export const updateFieldLimitResponseRt = rt.intersection([
  rt.type({
- lastBackingIndexName: rt.string,
+ isComponentTemplateUpdated: rt.union([rt.boolean, rt.undefined]),
+ isLatestBackingIndexUpdated: rt.union([rt.boolean, rt.undefined]),
+ customComponentTemplateName: rt.string,
  }),
  rt.partial({
- createdOn: rt.union([rt.null, rt.number]), // rt.null is needed because `createdOn` is not available on Serverless
- integration: rt.string,
- datasetUserPrivileges: datasetUserPrivilegesRt,
+ error: rt.string,
  }),
 ]);
 
+export type UpdateFieldLimitResponse = rt.TypeOf<typeof updateFieldLimitResponseRt>;
+
+export const dataStreamRolloverResponseRt = rt.type({
+ acknowledged: rt.boolean,
+});
+
+export type DataStreamRolloverResponse = rt.TypeOf<typeof dataStreamRolloverResponseRt>;
+
+export const dataStreamSettingsRt = rt.partial({
+ lastBackingIndexName: rt.string,
+ indexTemplate: rt.string,
+ createdOn: rt.union([rt.null, rt.number]), // rt.null is needed because `createdOn` is not available on Serverless
+ integration: rt.string,
+ datasetUserPrivileges: datasetUserPrivilegesRt,
+});
+
 export type DataStreamSettings = rt.TypeOf<typeof dataStreamSettingsRt>;
 
 export const dataStreamDetailsRt = rt.partial({

x-pack/plugins/observability_solution/dataset_quality/common/data_stream_details/types.ts

@@ -14,3 +14,8 @@ export interface AnalyzeDegradedFieldsParams {
  lastBackingIndex: string;
  degradedField: string;
 }
+
+export interface UpdateFieldLimitParams {
+ dataStream: string;
+ newFieldLimit: number;
+}

x-pack/plugins/observability_solution/dataset_quality/common/translations.ts

@@ -500,3 +500,161 @@ export const degradedFieldMessageIssueDoesNotExistInLatestIndex = i18n.translate
  'This issue was detected in an older version of the dataset, but not in the most recent version.',
  }
 );
+
+export const possibleMitigationTitle = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigationTitle',
+ {
+ defaultMessage: 'Possible mitigation',
+ }
+);
+
+export const increaseFieldMappingLimitTitle = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.increaseFieldMappingLimitTitle',
+ {
+ defaultMessage: 'Increase field mapping limit',
+ }
+);
+
+export const fieldLimitMitigationDescriptionText = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationDescription',
+ {
+ defaultMessage:
+ 'The field mapping limit sets the maximum number of fields in an index. When exceeded, additional fields are ignored. To prevent this, increase your field mapping limit.',
+ }
+);
+
+export const fieldLimitMitigationConsiderationText = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationConsiderations',
+ {
+ defaultMessage: 'Before changing the field limit, consider the following:',
+ }
+);
+
+export const fieldLimitMitigationConsiderationText1 = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationConsiderations1',
+ {
+ defaultMessage: 'Increasing the field limit could slow cluster performance.',
+ }
+);
+
+export const fieldLimitMitigationConsiderationText2 = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationConsiderations2',
+ {
+ defaultMessage: 'Increasing the field limit also resolves field limit issues for other fields.',
+ }
+);
+
+export const fieldLimitMitigationConsiderationText3 = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationConsiderations3',
+ {
+ defaultMessage:
+ 'This change applies to the [name] component template and affects all namespaces in the template.',
+ }
+);
+
+export const fieldLimitMitigationConsiderationText4 = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationConsiderations4',
+ {
+ defaultMessage:
+ 'You need to roll over affected data streams to apply mapping changes to component templates.',
+ }
+);
+
+export const fieldLimitMitigationCurrentLimitLabelText = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationCurrentLimitLabelText',
+ {
+ defaultMessage: 'Current limit',
+ }
+);
+
+export const fieldLimitMitigationNewLimitButtonText = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationNewLimitButtonText',
+ {
+ defaultMessage: 'New limit',
+ }
+);
+
+export const fieldLimitMitigationNewLimitPlaceholderText = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationNewLimitPlaceholderText',
+ {
+ defaultMessage: 'New field limit',
+ }
+);
+
+export const fieldLimitMitigationApplyButtonText = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationApplyButtonText',
+ {
+ defaultMessage: 'Apply',
+ }
+);
+
+export const otherMitigationsCustomComponentTemplate = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.otherMitigationsCustomComponentTemplate',
+ {
+ defaultMessage: 'Add or edit custom component template',
+ }
+);
+
+export const otherMitigationsCustomIngestPipeline = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.otherMitigationsCustomIngestPipeline',
+ {
+ defaultMessage: 'Add or edit custom ingest pipeline',
+ }
+);
+
+export const fieldLimitMitigationOfficialDocumentation = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationOfficialDocumentation',
+ {
+ defaultMessage: 'Documentation',
+ }
+);
+
+export const fieldLimitMitigationSuccessMessage = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationSuccessMessage',
+ {
+ defaultMessage: 'New limit set!',
+ }
+);
+
+export const fieldLimitMitigationSuccessComponentTemplateLinkText = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationSuccessComponentTemplateLinkText',
+ {
+ defaultMessage: 'See component template',
+ }
+);
+
+export const fieldLimitMitigationFailedMessage = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationFailedMessage',
+ {
+ defaultMessage: 'Changes not applied to new data',
+ }
+);
+
+export const fieldLimitMitigationFailedMessageDescription = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationFailedMessageDescription',
+ {
+ defaultMessage:
+ 'The component template was successfully updated with the new field limit, but the changes were not applied to the most recent backing index. Perform a rollover to apply your changes to new data.',
+ }
+);
+
+export const fieldLimitMitigationRolloverButton = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.fieldLimitMitigationRolloverButton',
+ {
+ defaultMessage: 'Rollover',
+ }
+);
+
+export const manualMitigationCustomPipelineCopyPipelineNameAriaText = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.copyPipelineNameAriaText',
+ {
+ defaultMessage: 'Copy pipeline name',
+ }
+);
+
+export const manualMitigationCustomPipelineCreateEditPipelineLink = i18n.translate(
+ 'xpack.datasetQuality.details.degradedField.possibleMitigation.createEditPipelineLink',
+ {
+ defaultMessage: 'create or edit the pipeline',
+ }
+);

x-pack/plugins/observability_solution/dataset_quality/common/utils/component_template_name.ts

@@ -0,0 +1,18 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+/*
+ * There are index templates like this metrics-apm.service_transaction.10m@template which exists.
+ * Hence this @ needs to be removed to derive the custom component template name.
+ */
+export function getComponentTemplatePrefixFromIndexTemplate(indexTemplate: string) {
+ if (indexTemplate.includes('@')) {
+ return indexTemplate.split('@')[0];
+ }
+
+ return indexTemplate;
+}

x-pack/plugins/observability_solution/dataset_quality/public/components/dataset_quality_details/degraded_field_flyout/field_info.tsx

@@ -125,7 +125,7 @@ export const DegradedFieldInfo = ({ fieldList }: { fieldList?: DegradedField })
  </>
  )}
 
- {!isAnalysisInProgress && degradedFieldAnalysisResult?.shouldDisplayValues && (
+ {!isAnalysisInProgress && degradedFieldAnalysisResult?.shouldDisplayIgnoredValuesAndLimit && (
  <>
  <EuiFlexGroup
  data-test-subj={'datasetQualityDetailsDegradedFieldFlyoutFieldsList-characterLimit'}

x-pack/plugins/observability_solution/dataset_quality/public/components/dataset_quality_details/degraded_field_flyout/index.tsx

@@ -6,6 +6,7 @@
  */
 
 import React, { useMemo } from 'react';
+import { i18n } from '@kbn/i18n';
 import {
  EuiBadge,
  EuiFlyout,
@@ -20,6 +21,7 @@ import {
  EuiButtonIcon,
  EuiToolTip,
 } from '@elastic/eui';
+import { FormattedMessage } from '@kbn/i18n-react';
 import { NavigationSource } from '../../../services/telemetry';
 import {
  useDatasetDetailsRedirectLinkTelemetry,
@@ -38,11 +40,18 @@ import {
 } from '../../../../common/translations';
 import { DegradedFieldInfo } from './field_info';
 import { _IGNORED } from '../../../../common/es_fields';
+import { PossibleMitigations } from './possible_mitigations';
 
 // Allow for lazy loading
 // eslint-disable-next-line import/no-default-export
 export default function DegradedFieldFlyout() {
- const { closeDegradedFieldFlyout, expandedDegradedField, renderedItems } = useDegradedFields();
+ const {
+ closeDegradedFieldFlyout,
+ expandedDegradedField,
+ renderedItems,
+ isAnalysisInProgress,
+ degradedFieldAnalysisResult,
+ } = useDegradedFields();
  const { dataStreamSettings, datasetDetails, timeRange } = useDatasetQualityDetailsState();
  const pushedFlyoutTitleId = useGeneratedHtmlId({
  prefix: 'pushedFlyoutTitle',
@@ -118,9 +127,42 @@ export default function DegradedFieldFlyout() {
  </EuiTextColor>
  </>
  )}
+ {isUserViewingTheIssueOnLatestBackingIndex &&
+ !isAnalysisInProgress &&
+ degradedFieldAnalysisResult &&
+ !degradedFieldAnalysisResult.identifiedUsingHeuristics && (
+ <>
+ <EuiSpacer size="s" />
+ <EuiTextColor
+ color="danger"
+ data-test-subj="datasetQualityDetailsDegradedFieldFlyoutIssueDoesNotExist"
+ >
+ <FormattedMessage
+ id="xpack.datasetQuality.details.degradedField.potentialCause.ignoreMalformedWarning"
+ defaultMessage="If you've recently updated your {field_limit} settings, this quality issue may not be relevant. Rollover the data stream to verify."
+ values={{
+ field_limit: (
+ <strong>
+ {i18n.translate(
+ 'xpack.datasetQuality.degradedFieldFlyout.strong.fieldLimitLabel',
+ { defaultMessage: 'field limit' }
+ )}
+ </strong>
+ ),
+ }}
+ />
+ </EuiTextColor>
+ </>
+ )}
  </EuiFlyoutHeader>
  <EuiFlyoutBody>
  <DegradedFieldInfo fieldList={fieldList} />
+ {isUserViewingTheIssueOnLatestBackingIndex && (
+ <>
+ <EuiSpacer size="s" />
+ <PossibleMitigations />
+ </>
+ )}
  </EuiFlyoutBody>
  </EuiFlyout>
  );