New slo plugin (#177937)

Fixes #176420 ## 🍒 Summary This PR copies the SLO code that was inside the Observability app into its own app under `observability-solution/slo` folder. https://github.com/elastic/kibana/assets/2852703/4f6b8dfb-9612-4d30-ad50-4ee5c55a9c32 ## ✔️ Acceptance criteria - URL of new app: `app/slos` - Design and functionality are not changed. - Git history has been retained for all files in `x-pack/plugins/observability_solution/slo`. - SLO should appear on server less - SLO code inside `observability_solution/observability` code has been removed. A new clean up round might be needed though for possible leftovers. - Burn rate rule is registered within the new slo app - SLO embeddables are moved inside the new slo app - overview - alerts embeddable - error budget burn down - Alerts table configuration registration for slo details page and alerts table embeddable is still done in the observability app. Response Ops team is working on removing the need to register the alert table anyway - Slo app is wrapped into `ApplicationUsageTrackingProvider` which will send slo `Application usage` information tracked by the `slo` appId - Redirect old `app/observability/slos` route to `app/slos` - Rename old `xpack.observability.slo` keys to `xpack.slo` in the translation files ## 🌮 How to test Design and functionality didn't change, so simply navigate to existing slo pages and try to break it - Slo list page - group by - unified search - toggle buttons - actions - Slo creation - try group by as well - Slo detail page - Actions on top - navigate to overview and alerts tabs - Create SLO flyout in Logs Explorer - Create burn rate rules and verify they appear on rules page - Verify SLO alerts appear on Alerts page and slo details page - Embeddables - Through the dashboard app - Using the attach to dashboard action on the slo card item on slo list page and the error budget burn down chart on the slo detail page - SLOs only for platinum users - Permissions - Spaces ## TODO - [x] Move slo stuff from observability folder to new slo plugin - [x] Remove old slo stuff from observability folder - [x] Update references - [x] Fix typescript and eslint errors - [x] Paths - [x] Locators - [x] Burn rate rule registration - [x] Embeddable Alerts table configuration registration - [x] Embeddables - [x] Translations - [x] Verify plugin.ts files contain all registration logic - [x] public - [x] server - [x] Final cleanup for observability folder - [x] Run tests - [x] Application Usage (Telemetry) - [x] Permissions --------- Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: shahzad31 <[email protected]> Co-authored-by: Coen Warmer <[email protected]>
elastic · Mar 19, 2024 · d5dfee7 · d5dfee7
1 parent e90d7fe
commit d5dfee7
Show file tree

Hide file tree

Showing 589 changed files with 5,174 additions and 3,220 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -875,6 +875,7 @@ module.exports = {
         'x-pack/plugins/observability_solution/observability/**/*.{js,mjs,ts,tsx}',
         'x-pack/plugins/observability_solution/exploratory_view/**/*.{js,mjs,ts,tsx}',
         'x-pack/plugins/observability_solution/ux/**/*.{js,mjs,ts,tsx}',
+        'x-pack/plugins/observability_solution/slo/**/*.{js,mjs,ts,tsx}',
       ],
       rules: {
         'no-console': ['warn', { allow: ['error'] }],
@@ -897,6 +898,7 @@ module.exports = {
         'x-pack/plugins/observability_solution/apm/**/*.stories.*',
         'x-pack/plugins/observability_solution/observability/**/*.stories.*',
         'x-pack/plugins/observability_solution/exploratory_view/**/*.stories.*',
+        'x-pack/plugins/observability_solution/slo/**/*.stories.*',
       ],
       rules: {
         'react/function-component-definition': [

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -783,6 +783,7 @@ packages/shared-ux/router/types @elastic/appex-sharedux
 packages/shared-ux/storybook/config @elastic/appex-sharedux
 packages/shared-ux/storybook/mock @elastic/appex-sharedux
 packages/kbn-shared-ux-utility @elastic/appex-sharedux
+x-pack/plugins/observability_solution/slo @elastic/obs-ux-management-team
 x-pack/packages/kbn-slo-schema @elastic/obs-ux-management-team
 x-pack/plugins/snapshot_restore @elastic/kibana-management
 packages/solution-nav/es @elastic/appex-sharedux

diff --git a/config/serverless.oblt.yml b/config/serverless.oblt.yml
@@ -7,11 +7,14 @@ xpack.infra.enabled: true
 xpack.uptime.enabled: true
 xpack.securitySolution.enabled: false
 
+## Enable the slo plugin
+xpack.slo.enabled: true
+
 ## Cloud settings
 xpack.cloud.serverless.project_type: observability
 
 ## Enable the Serverless Observability plugin
-xpack.serverless.observability.enabled: true
+xpack.serverless.observability.enabled: true 
 
 ## Configure plugins
 

diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc
@@ -794,6 +794,10 @@ It leverages universal configuration and other APIs in the serverless plugin to
 |Session View is meant to provide a visualization into what is going on in a particular Linux environment where the agent is running. It looks likes a terminal emulator; however, it is a tool for introspecting process activity and understanding user and service behaviour in your Linux servers and infrastructure. It is a time-ordered series of process executions displayed in a tree over time.
 
 
+|{kib-repo}blob/{branch}/x-pack/plugins/observability_solution/slo/README.md[slo]
+|A Kibana plugin
+
+
 |{kib-repo}blob/{branch}/x-pack/plugins/snapshot_restore/README.md[snapshotRestore]
 |or
 

diff --git a/package.json b/package.json
@@ -785,6 +785,7 @@
     "@kbn/shared-ux-storybook-config": "link:packages/shared-ux/storybook/config",
     "@kbn/shared-ux-storybook-mock": "link:packages/shared-ux/storybook/mock",
     "@kbn/shared-ux-utility": "link:packages/kbn-shared-ux-utility",
+    "@kbn/slo-plugin": "link:x-pack/plugins/observability_solution/slo",
     "@kbn/slo-schema": "link:x-pack/packages/kbn-slo-schema",
     "@kbn/snapshot-restore-plugin": "link:x-pack/plugins/snapshot_restore",
     "@kbn/solution-nav-es": "link:packages/solution-nav/es",

diff --git a/packages/deeplinks/observability/constants.ts b/packages/deeplinks/observability/constants.ts
@@ -19,3 +19,5 @@ export const APM_APP_ID = 'apm';
 export const SYNTHETICS_APP_ID = 'synthetics';
 
 export const OBSERVABILITY_ONBOARDING_APP_ID = 'observabilityOnboarding';
+
+export const SLO_APP_ID = 'slo';
diff --git a/packages/deeplinks/observability/deep_links.ts b/packages/deeplinks/observability/deep_links.ts
@@ -14,6 +14,7 @@ import {
   OBSERVABILITY_ONBOARDING_APP_ID,
   OBSERVABILITY_OVERVIEW_APP_ID,
   SYNTHETICS_APP_ID,
+  SLO_APP_ID,
 } from './constants';
 
 type LogsApp = typeof LOGS_APP_ID;
@@ -23,6 +24,7 @@ type MetricsApp = typeof METRICS_APP_ID;
 type ApmApp = typeof APM_APP_ID;
 type SyntheticsApp = typeof SYNTHETICS_APP_ID;
 type ObservabilityOnboardingApp = typeof OBSERVABILITY_ONBOARDING_APP_ID;
+type SLO_APP = typeof SLO_APP_ID;
 
 export type AppId =
   | LogsApp
@@ -31,7 +33,8 @@ export type AppId =
   | ObservabilityOnboardingApp
   | ApmApp
   | MetricsApp
-  | SyntheticsApp;
+  | SyntheticsApp
+  | SLO_APP;
 
 export type LogsLinkId = 'log-categories' | 'settings' | 'anomalies' | 'stream';
 
@@ -40,8 +43,7 @@ export type ObservabilityOverviewLinkId =
   | 'cases'
   | 'cases_configure'
   | 'cases_create'
-  | 'rules'
-  | 'slos';
+  | 'rules';
 
 export type MetricsLinkId =
   | 'inventory'
@@ -61,12 +63,15 @@ export type ApmLinkId =
 
 export type SyntheticsLinkId = 'certificates' | 'overview';
 
+export type SLOLinkId = 'slo';
+
 export type LinkId =
   | LogsLinkId
   | ObservabilityOverviewLinkId
   | MetricsLinkId
   | ApmLinkId
-  | SyntheticsLinkId;
+  | SyntheticsLinkId
+  | SLOLinkId;
 
 export type DeepLinkId =
   | AppId

diff --git a/packages/kbn-babel-preset/styled_components_files.js b/packages/kbn-babel-preset/styled_components_files.js
@@ -14,7 +14,7 @@ module.exports = {
   USES_STYLED_COMPONENTS: [
     /packages[\/\\]kbn-ui-shared-deps-(npm|src)[\/\\]/,
     /src[\/\\]plugins[\/\\](kibana_react)[\/\\]/,
-    /x-pack[\/\\]plugins[\/\\](observability_solution\/apm|beats_management|cases|fleet|observability_solution\/infra|lists|observability_solution\/observability|observability_solution\/observability_shared|observability_solution\/exploratory_view|security_solution|timelines|observability_solution\/synthetics|observability_solution\/ux|observability_solution\/uptime)[\/\\]/,
+    /x-pack[\/\\]plugins[\/\\](observability_solution\/apm|beats_management|cases|fleet|observability_solution\/infra|lists|observability_solution\/observability|observability_solution\/observability_shared|observability_solution\/exploratory_view|observability_solution\/slo|security_solution|timelines|observability_solution\/synthetics|observability_solution\/ux|observability_solution\/uptime)[\/\\]/,
     /x-pack[\/\\]test[\/\\]plugin_functional[\/\\]plugins[\/\\]resolver_test[\/\\]/,
     /x-pack[\/\\]packages[\/\\]elastic_assistant[\/\\]/,
     /x-pack[\/\\]packages[\/\\]security-solution[\/\\]ecs_data_quality_dashboard[\/\\]/,

diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml
@@ -103,7 +103,7 @@ pageLoadAssetSize:
   navigation: 37269
   newsfeed: 42228
   noDataPage: 5000
-  observability: 115443
+  observability: 167673
   observabilityAIAssistant: 58230
   observabilityAIAssistantApp: 27680
   observabilityLogsExplorer: 46650
@@ -136,6 +136,7 @@ pageLoadAssetSize:
   serverlessSearch: 72995
   sessionView: 77750
   share: 71239
+  slo: 37039
   snapshotRestore: 79032
   spaces: 57868
   stackAlerts: 58316

diff --git a/src/dev/storybook/aliases.ts b/src/dev/storybook/aliases.ts
@@ -57,6 +57,7 @@ export const storybookAliases = {
   security_solution_packages: 'x-pack/packages/security-solution/storybook/config',
   serverless: 'packages/serverless/storybook/config',
   shared_ux: 'packages/shared-ux/storybook/config',
+  slo: 'x-pack/plugins/observability_solution/slo/.storybook',
   threat_intelligence: 'x-pack/plugins/threat_intelligence/.storybook',
   triggers_actions_ui: 'x-pack/plugins/triggers_actions_ui/.storybook',
   ui_actions_enhanced: 'src/plugins/ui_actions_enhanced/.storybook',

diff --git a/src/plugins/kibana_usage_collection/server/collectors/application_usage/schema.ts b/src/plugins/kibana_usage_collection/server/collectors/application_usage/schema.ts
@@ -162,6 +162,7 @@ export const applicationUsageSchema = {
   'exploratory-view': commonSchema,
   osquery: commonSchema,
   profiling: commonSchema,
+  slo: commonSchema,
   security_account: commonSchema,
   reportingRedirect: commonSchema,
   security_access_agreement: commonSchema,

diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json
@@ -5635,6 +5635,137 @@
             }
           }
         },
+        "slo": {
+          "properties": {
+            "appId": {
+              "type": "keyword",
+              "_meta": {
+                "description": "The application being tracked"
+              }
+            },
+            "viewId": {
+              "type": "keyword",
+              "_meta": {
+                "description": "Always `main`"
+              }
+            },
+            "clicks_total": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application since we started counting them"
+              }
+            },
+            "clicks_7_days": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application over the last 7 days"
+              }
+            },
+            "clicks_30_days": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application over the last 30 days"
+              }
+            },
+            "clicks_90_days": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application over the last 90 days"
+              }
+            },
+            "minutes_on_screen_total": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen since we started counting them."
+              }
+            },
+            "minutes_on_screen_7_days": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen over the last 7 days"
+              }
+            },
+            "minutes_on_screen_30_days": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen over the last 30 days"
+              }
+            },
+            "minutes_on_screen_90_days": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen over the last 90 days"
+              }
+            },
+            "views": {
+              "type": "array",
+              "items": {
+                "properties": {
+                  "appId": {
+                    "type": "keyword",
+                    "_meta": {
+                      "description": "The application being tracked"
+                    }
+                  },
+                  "viewId": {
+                    "type": "keyword",
+                    "_meta": {
+                      "description": "The application view being tracked"
+                    }
+                  },
+                  "clicks_total": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the application sub view since we started counting them"
+                    }
+                  },
+                  "clicks_7_days": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the active application sub view over the last 7 days"
+                    }
+                  },
+                  "clicks_30_days": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the active application sub view over the last 30 days"
+                    }
+                  },
+                  "clicks_90_days": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the active application sub view over the last 90 days"
+                    }
+                  },
+                  "minutes_on_screen_total": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application sub view is active and on-screen since we started counting them."
+                    }
+                  },
+                  "minutes_on_screen_7_days": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application is active and on-screen active application sub view over the last 7 days"
+                    }
+                  },
+                  "minutes_on_screen_30_days": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application is active and on-screen active application sub view over the last 30 days"
+                    }
+                  },
+                  "minutes_on_screen_90_days": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application is active and on-screen active application sub view over the last 90 days"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
         "security_account": {
           "properties": {
             "appId": {

diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -1560,6 +1560,8 @@
       "@kbn/shared-ux-storybook-mock/*": ["packages/shared-ux/storybook/mock/*"],
       "@kbn/shared-ux-utility": ["packages/kbn-shared-ux-utility"],
       "@kbn/shared-ux-utility/*": ["packages/kbn-shared-ux-utility/*"],
+      "@kbn/slo-plugin": ["x-pack/plugins/observability_solution/slo"],
+      "@kbn/slo-plugin/*": ["x-pack/plugins/observability_solution/slo/*"],
       "@kbn/slo-schema": ["x-pack/packages/kbn-slo-schema"],
       "@kbn/slo-schema/*": ["x-pack/packages/kbn-slo-schema/*"],
       "@kbn/snapshot-restore-plugin": ["x-pack/plugins/snapshot_restore"],

diff --git a/x-pack/.i18nrc.json b/x-pack/.i18nrc.json
@@ -115,6 +115,7 @@
     "xpack.securitySolutionEss": "plugins/security_solution_ess",
     "xpack.securitySolutionServerless": "plugins/security_solution_serverless",
     "xpack.sessionView": "plugins/session_view",
+    "xpack.slo": "plugins/observability_solution/slo",
     "xpack.snapshotRestore": "plugins/snapshot_restore",
     "xpack.spaces": "plugins/spaces",
     "xpack.savedObjectsTagging": [

diff --git a/x-pack/plugins/observability_solution/observability/common/constants.ts b/x-pack/plugins/observability_solution/observability/common/constants.ts
@@ -5,49 +5,14 @@
  * 2.0.
  */
 
-import { i18n } from '@kbn/i18n';
 import { AlertConsumers } from '@kbn/rule-data-utils';
 import type { ValidFeatureId } from '@kbn/rule-data-utils';
 import type { RuleCreationValidConsumer } from '@kbn/triggers-actions-ui-plugin/public';
 
-export const SLO_BURN_RATE_RULE_TYPE_ID = 'slo.rules.burnRate';
-
 export const INVALID_EQUATION_REGEX = /[^A-Z|+|\-|\s|\d+|\.|\(|\)|\/|\*|>|<|=|\?|\:|&|\!|\|]+/g;
 export const ALERT_STATUS_ALL = 'all';
 export const ALERTS_URL_STORAGE_KEY = '_a';
 
-export const ALERT_ACTION_ID = 'slo.burnRate.alert';
-export const ALERT_ACTION = {
-  id: ALERT_ACTION_ID,
-  name: i18n.translate('xpack.observability.slo.alerting.burnRate.alertAction', {
-    defaultMessage: 'Critical',
-  }),
-};
-
-export const HIGH_PRIORITY_ACTION_ID = 'slo.burnRate.high';
-export const HIGH_PRIORITY_ACTION = {
-  id: HIGH_PRIORITY_ACTION_ID,
-  name: i18n.translate('xpack.observability.slo.alerting.burnRate.highPriorityAction', {
-    defaultMessage: 'High',
-  }),
-};
-
-export const MEDIUM_PRIORITY_ACTION_ID = 'slo.burnRate.medium';
-export const MEDIUM_PRIORITY_ACTION = {
-  id: MEDIUM_PRIORITY_ACTION_ID,
-  name: i18n.translate('xpack.observability.slo.alerting.burnRate.mediumPriorityAction', {
-    defaultMessage: 'Medium',
-  }),
-};
-
-export const LOW_PRIORITY_ACTION_ID = 'slo.burnRate.low';
-export const LOW_PRIORITY_ACTION = {
-  id: LOW_PRIORITY_ACTION_ID,
-  name: i18n.translate('xpack.observability.slo.alerting.burnRate.lowPriorityAction', {
-    defaultMessage: 'Low',
-  }),
-};
-
 export const observabilityAlertFeatureIds: ValidFeatureId[] = [
   AlertConsumers.APM,
   AlertConsumers.INFRASTRUCTURE,

diff --git a/x-pack/plugins/observability_solution/observability/common/index.ts b/x-pack/plugins/observability_solution/observability/common/index.ts
@@ -60,9 +60,8 @@ export {
   getProbabilityFromProgressiveLoadingQuality,
 } from './progressive_loading';
 
-export const sloFeatureId = 'slo';
 export const casesFeatureId = 'observabilityCases';
-
+export const sloFeatureId = 'slo';
 // The ID of the observability app. Should more appropriately be called
 // 'observability' but it's used in telemetry by applicationUsage so we don't
 // want to change it.
@@ -87,3 +86,5 @@ export const sloListLocatorID = 'SLO_LIST_LOCATOR';
 import { paths } from './locators/paths';
 export const observabilityPaths = paths.observability;
 export type { AlertsLocatorParams } from './locators/alerts';
+export { AlertsLocatorDefinition } from './locators/alerts';
+export { observabilityAlertFeatureIds } from './constants';
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,3 +19,5 @@ export const APM_APP_ID = 'apm';
		export const SYNTHETICS_APP_ID = 'synthetics';

		export const OBSERVABILITY_ONBOARDING_APP_ID = 'observabilityOnboarding';

		export const SLO_APP_ID = 'slo';