[Upgrade Assistant] logsdb callout (#207196)

elastic · Feb 11, 2025 · e08508a · e08508a
1 parent 44ab3ac
commit e08508a
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 0 deletions.
diff --git a/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts b/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
@@ -370,6 +370,8 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
       remoteReindex: `${ELASTICSEARCH_DOCS}docs-reindex.html#reindex-from-remote`,
       unfreezeApi: `${ELASTICSEARCH_DOCS}unfreeze-index-api.html`,
       reindexWithPipeline: `${ELASTICSEARCH_DOCS}docs-reindex.html#reindex-with-an-ingest-pipeline`,
+      logsDatastream: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/logs-data-stream.html`,
+      usingLogsDbIndexModeWithESSecurity: `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/detections-logsdb-index-mode-impact.html`,
     },
     rollupJobs: `${KIBANA_DOCS}data-rollups.html`,
     elasticsearch: {

diff --git a/src/platform/packages/shared/kbn-doc-links/src/types.ts b/src/platform/packages/shared/kbn-doc-links/src/types.ts
@@ -327,6 +327,8 @@ export interface DocLinks {
     readonly remoteReindex: string;
     readonly unfreezeApi: string;
     readonly reindexWithPipeline: string;
+    readonly logsDatastream: string;
+    readonly usingLogsDbIndexModeWithESSecurity: string;
   };
   readonly rollupJobs: string;
   readonly elasticsearch: Record<string, string>;

diff --git a/...te/upgrade_assistant/public/application/components/overview/upgrade_step/upgrade_step.tsx b/...te/upgrade_assistant/public/application/components/overview/upgrade_step/upgrade_step.tsx
@@ -15,7 +15,10 @@ import {
   EuiButton,
   EuiButtonEmpty,
   EuiCallOut,
+  EuiLink,
+  EuiCode,
 } from '@elastic/eui';
+import { FormattedMessage } from '@kbn/i18n-react';
 import { i18n } from '@kbn/i18n';
 import type { EuiStepProps } from '@elastic/eui/src/components/steps/step';
 import { useAppContext } from '../../../app_context';
@@ -44,6 +47,13 @@ const i18nTexts = {
   upgradeGuideLink: i18n.translate('xpack.upgradeAssistant.overview.upgradeGuideLink', {
     defaultMessage: 'View upgrade guide',
   }),
+
+  securitySolnLogsDBCalloutTitle: i18n.translate(
+    'xpack.upgradeAssistant.overview.securitySolutionLogsDBCalloutTitle',
+    {
+      defaultMessage: 'Action needed: review new default setting - logsdb index mode',
+    }
+  ),
 };
 
 const UpgradeStep = () => {
@@ -145,6 +155,37 @@ const UpgradeStep = () => {
 
       <EuiSpacer size="m" />
 
+      <EuiCallOut title={i18nTexts.securitySolnLogsDBCalloutTitle}>
+        <FormattedMessage
+          id="xpack.upgradeAssistant.overview.securitySolutionLogsDBCalloutBody"
+          defaultMessage="Logsdb is a new index mode ({logsDataStreamDocs}) that is applied to {logsPattern} data streams by default in Elasticsearch 9.0. Logsdb index mode results in significant storage savings (up to 70%) however adds up to 25% CPU overhead during data ingestion. In 9.0, logsdb will be applied to newly ingested logs data. If your cluster's hot tier CPU utilization is high (more than Y% on average), it is recommended that you disable this default behavior prior to upgrading to avoid maxing out your hot tier CPU and the downstream issues it may cause. To disable, {indexModeWithSecuritySoln}. This setting can be changed after upgrade if desired."
+          values={{
+            logsPattern: <EuiCode>logs-*-*</EuiCode>,
+            logsDataStreamDocs: (
+              <EuiLink target="_blank" href={docLinks.links.upgradeAssistant.logsDatastream}>
+                {i18n.translate(
+                  'xpack.upgradeAssistant.overview.securitySolutionLogsDBCalloutBody.logsDataStreamLink',
+                  { defaultMessage: 'learn more' }
+                )}
+              </EuiLink>
+            ),
+            indexModeWithSecuritySoln: (
+              <EuiLink
+                target="_blank"
+                href={docLinks.links.upgradeAssistant.usingLogsDbIndexModeWithESSecurity}
+              >
+                {i18n.translate(
+                  'xpack.upgradeAssistant.overview.securitySolutionLogsDBCalloutBody.indexModeWithSecuritySolnLink',
+                  { defaultMessage: 'follow these steps' }
+                )}
+              </EuiLink>
+            ),
+          }}
+        />
+      </EuiCallOut>
+
+      <EuiSpacer size="m" />
+
       {callToAction}
     </>
   );