From a07bcaef45cd77b4230fd97e7a9d0f9c583a742c Mon Sep 17 00:00:00 2001 From: Chris Cowan Date: Fri, 14 Apr 2023 07:22:00 -0600 Subject: [PATCH] Change all SLO assets to managed and indices to hidden (#154953) ## Summary This PR adds the Managed label to the transform definitions, ingest pipelines, and index components. It also sets the changes the destination indices to hidden with a dot prefix for the name so they show up as system indices. #### Transformer with Managed label image #### Ingest Pipeline with Managed label image #### Index Components image #### Hidden data indices image --- .../component_templates/slo_mappings_template.ts | 2 ++ .../component_templates/slo_settings_template.ts | 6 +++++- .../plugins/observability/server/assets/constants.ts | 6 +++--- .../assets/index_templates/slo_index_templates.ts | 2 ++ .../assets/ingest_templates/slo_pipeline_template.ts | 2 ++ .../transform_templates/slo_transform_template.ts | 2 ++ .../apm_transaction_duration.test.ts.snap | 12 ++++++++---- .../apm_transaction_error_rate.test.ts.snap | 12 ++++++++---- .../__snapshots__/kql_custom.test.ts.snap | 12 ++++++++---- 9 files changed, 40 insertions(+), 16 deletions(-) diff --git a/x-pack/plugins/observability/server/assets/component_templates/slo_mappings_template.ts b/x-pack/plugins/observability/server/assets/component_templates/slo_mappings_template.ts index 5b5340e75a232..6dec5baf58faf 100644 --- a/x-pack/plugins/observability/server/assets/component_templates/slo_mappings_template.ts +++ b/x-pack/plugins/observability/server/assets/component_templates/slo_mappings_template.ts @@ -43,5 +43,7 @@ export const getSLOMappingsTemplate = (name: string) => ({ _meta: { description: 'Mappings for SLO rollup data', version: 1, + managed: true, + managed_by: 'observability', }, }); diff --git a/x-pack/plugins/observability/server/assets/component_templates/slo_settings_template.ts b/x-pack/plugins/observability/server/assets/component_templates/slo_settings_template.ts index 1cec9c2c03900..f4e4c65003179 100644 --- a/x-pack/plugins/observability/server/assets/component_templates/slo_settings_template.ts +++ b/x-pack/plugins/observability/server/assets/component_templates/slo_settings_template.ts @@ -8,10 +8,14 @@ export const getSLOSettingsTemplate = (name: string) => ({ name, template: { - settings: {}, + settings: { + hidden: true, + }, }, _meta: { description: 'Settings for SLO rollup data', version: 1, + managed: true, + managed_by: 'observability', }, }); diff --git a/x-pack/plugins/observability/server/assets/constants.ts b/x-pack/plugins/observability/server/assets/constants.ts index 3b862a7eb3018..78ec6611ef633 100644 --- a/x-pack/plugins/observability/server/assets/constants.ts +++ b/x-pack/plugins/observability/server/assets/constants.ts @@ -5,9 +5,9 @@ * 2.0. */ -export const SLO_COMPONENT_TEMPLATE_MAPPINGS_NAME = 'slo-observability.sli-mappings'; -export const SLO_COMPONENT_TEMPLATE_SETTINGS_NAME = 'slo-observability.sli-settings'; -export const SLO_INDEX_TEMPLATE_NAME = 'slo-observability.sli'; +export const SLO_COMPONENT_TEMPLATE_MAPPINGS_NAME = '.slo-observability.sli-mappings'; +export const SLO_COMPONENT_TEMPLATE_SETTINGS_NAME = '.slo-observability.sli-settings'; +export const SLO_INDEX_TEMPLATE_NAME = '.slo-observability.sli'; export const SLO_RESOURCES_VERSION = 1; export const SLO_INGEST_PIPELINE_NAME = `${SLO_INDEX_TEMPLATE_NAME}.monthly`; export const SLO_DESTINATION_INDEX_NAME = `${SLO_INDEX_TEMPLATE_NAME}-v${SLO_RESOURCES_VERSION}`; diff --git a/x-pack/plugins/observability/server/assets/index_templates/slo_index_templates.ts b/x-pack/plugins/observability/server/assets/index_templates/slo_index_templates.ts index 519b726faf4c1..adc6c47a1e259 100644 --- a/x-pack/plugins/observability/server/assets/index_templates/slo_index_templates.ts +++ b/x-pack/plugins/observability/server/assets/index_templates/slo_index_templates.ts @@ -13,5 +13,7 @@ export const getSLOIndexTemplate = (name: string, indexPattern: string, composed _meta: { description: 'Template for SLO rollup data', version: 1, + managed: true, + managed_by: 'observability', }, }); diff --git a/x-pack/plugins/observability/server/assets/ingest_templates/slo_pipeline_template.ts b/x-pack/plugins/observability/server/assets/ingest_templates/slo_pipeline_template.ts index 4aaefc6ccc178..c33e3400d60cd 100644 --- a/x-pack/plugins/observability/server/assets/ingest_templates/slo_pipeline_template.ts +++ b/x-pack/plugins/observability/server/assets/ingest_templates/slo_pipeline_template.ts @@ -20,5 +20,7 @@ export const getSLOPipelineTemplate = (id: string, indexNamePrefix: string) => ( _meta: { description: 'SLO ingest pipeline', version: 1, + managed: true, + managed_by: 'observability', }, }); diff --git a/x-pack/plugins/observability/server/assets/transform_templates/slo_transform_template.ts b/x-pack/plugins/observability/server/assets/transform_templates/slo_transform_template.ts index 799a991ef7971..daa049033ec47 100644 --- a/x-pack/plugins/observability/server/assets/transform_templates/slo_transform_template.ts +++ b/x-pack/plugins/observability/server/assets/transform_templates/slo_transform_template.ts @@ -48,5 +48,7 @@ export const getSLOTransformTemplate = ( }, _meta: { version: 1, + managed: true, + managed_by: 'observability', }, }); diff --git a/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/apm_transaction_duration.test.ts.snap b/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/apm_transaction_duration.test.ts.snap index cdb0aac197c2e..5fd17391645ed 100644 --- a/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/apm_transaction_duration.test.ts.snap +++ b/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/apm_transaction_duration.test.ts.snap @@ -142,12 +142,14 @@ Object { exports[`APM Transaction Duration Transform Generator returns the expected transform params for timeslices slo 1`] = ` Object { "_meta": Object { + "managed": true, + "managed_by": "observability", "version": 1, }, "description": "Rolled-up SLI data for SLO: irrelevant", "dest": Object { - "index": "slo-observability.sli-v1", - "pipeline": "slo-observability.sli.monthly", + "index": ".slo-observability.sli-v1", + "pipeline": ".slo-observability.sli.monthly", }, "frequency": "1m", "pivot": Object { @@ -287,12 +289,14 @@ Object { exports[`APM Transaction Duration Transform Generator returns the expected transform params with every specified indicator params 1`] = ` Object { "_meta": Object { + "managed": true, + "managed_by": "observability", "version": 1, }, "description": "Rolled-up SLI data for SLO: irrelevant", "dest": Object { - "index": "slo-observability.sli-v1", - "pipeline": "slo-observability.sli.monthly", + "index": ".slo-observability.sli-v1", + "pipeline": ".slo-observability.sli.monthly", }, "frequency": "1m", "pivot": Object { diff --git a/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/apm_transaction_error_rate.test.ts.snap b/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/apm_transaction_error_rate.test.ts.snap index bbece9de8f886..abbdc35812c21 100644 --- a/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/apm_transaction_error_rate.test.ts.snap +++ b/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/apm_transaction_error_rate.test.ts.snap @@ -152,12 +152,14 @@ Object { exports[`APM Transaction Error Rate Transform Generator returns the expected transform params for timeslices slo 1`] = ` Object { "_meta": Object { + "managed": true, + "managed_by": "observability", "version": 1, }, "description": "Rolled-up SLI data for SLO: irrelevant", "dest": Object { - "index": "slo-observability.sli-v1", - "pipeline": "slo-observability.sli.monthly", + "index": ".slo-observability.sli-v1", + "pipeline": ".slo-observability.sli.monthly", }, "frequency": "1m", "pivot": Object { @@ -307,12 +309,14 @@ Object { exports[`APM Transaction Error Rate Transform Generator returns the expected transform params with every specified indicator params 1`] = ` Object { "_meta": Object { + "managed": true, + "managed_by": "observability", "version": 1, }, "description": "Rolled-up SLI data for SLO: irrelevant", "dest": Object { - "index": "slo-observability.sli-v1", - "pipeline": "slo-observability.sli.monthly", + "index": ".slo-observability.sli-v1", + "pipeline": ".slo-observability.sli.monthly", }, "frequency": "1m", "pivot": Object { diff --git a/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/kql_custom.test.ts.snap b/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/kql_custom.test.ts.snap index d83111944207e..011dfd9fe3438 100644 --- a/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/kql_custom.test.ts.snap +++ b/x-pack/plugins/observability/server/services/slo/transform_generators/__snapshots__/kql_custom.test.ts.snap @@ -103,12 +103,14 @@ Object { exports[`KQL Custom Transform Generator returns the expected transform params for timeslices slo 1`] = ` Object { "_meta": Object { + "managed": true, + "managed_by": "observability", "version": 1, }, "description": "Rolled-up SLI data for SLO: irrelevant", "dest": Object { - "index": "slo-observability.sli-v1", - "pipeline": "slo-observability.sli.monthly", + "index": ".slo-observability.sli-v1", + "pipeline": ".slo-observability.sli.monthly", }, "frequency": "1m", "pivot": Object { @@ -208,12 +210,14 @@ Object { exports[`KQL Custom Transform Generator returns the expected transform params with every specified indicator params 1`] = ` Object { "_meta": Object { + "managed": true, + "managed_by": "observability", "version": 1, }, "description": "Rolled-up SLI data for SLO: irrelevant", "dest": Object { - "index": "slo-observability.sli-v1", - "pipeline": "slo-observability.sli.monthly", + "index": ".slo-observability.sli-v1", + "pipeline": ".slo-observability.sli.monthly", }, "frequency": "1m", "pivot": Object {