[8.x] [Logs] Deprecate HTTP APIs used in LogStream app (elastic#201974)…

… (elastic#203748) # Backport This will backport the following commits from `main` to `8.x`: - [[Logs] Deprecate HTTP APIs used in LogStream app (elastic#201974)](elastic#201974)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Marco Antonio Ghiani <[email protected]>
kibanamachine · Dec 11, 2024 · 6354217 · 6354217
1 parent 390014a
commit 6354217
Show file tree

Hide file tree

Showing 6 changed files with 79 additions and 0 deletions.
diff --git a/x-pack/plugins/observability_solution/logs_shared/server/routes/log_entries/highlights.ts b/x-pack/plugins/observability_solution/logs_shared/server/routes/log_entries/highlights.ts
@@ -12,6 +12,7 @@ import { fold } from 'fp-ts/lib/Either';
 import { identity } from 'fp-ts/lib/function';
 import { schema } from '@kbn/config-schema';
 
+import { i18n } from '@kbn/i18n';
 import { logEntriesV1 } from '../../../common/http_api';
 import { throwErrors } from '../../../common/runtime_types';
 
@@ -33,6 +34,20 @@ export const initLogEntriesHighlightsRoute = ({ framework, logEntries }: LogsSha
       {
         version: '1',
         validate: { request: { body: escapeHatch } },
+        options: {
+          deprecated: {
+            documentationUrl: '',
+            severity: 'warning',
+            message: i18n.translate(
+              'xpack.logsShared.deprecations.postLogEntriesHighlightsRoute.message',
+              {
+                defaultMessage:
+                  'Given the deprecation of the LogStream feature, this API will not return reliable data in upcoming versions of Kibana.',
+              }
+            ),
+            reason: { type: 'deprecate' },
+          },
+        },
       },
       async (requestContext, request, response) => {
         const payload = pipe(

diff --git a/x-pack/plugins/observability_solution/logs_shared/server/routes/log_entries/summary.ts b/x-pack/plugins/observability_solution/logs_shared/server/routes/log_entries/summary.ts
@@ -12,6 +12,7 @@ import { fold } from 'fp-ts/lib/Either';
 import { identity } from 'fp-ts/lib/function';
 import { schema } from '@kbn/config-schema';
 
+import { i18n } from '@kbn/i18n';
 import { logEntriesV1 } from '../../../common/http_api';
 import { throwErrors } from '../../../common/runtime_types';
 
@@ -36,6 +37,20 @@ export const initLogEntriesSummaryRoute = ({
       {
         version: '1',
         validate: { request: { body: escapeHatch } },
+        options: {
+          deprecated: {
+            documentationUrl: '',
+            severity: 'warning',
+            message: i18n.translate(
+              'xpack.logsShared.deprecations.postLogEntriesSummaryRoute.message',
+              {
+                defaultMessage:
+                  'Given the deprecation of the LogStream feature, this API will not return reliable data in upcoming versions of Kibana.',
+              }
+            ),
+            reason: { type: 'deprecate' },
+          },
+        },
       },
       async (requestContext, request, response) => {
         const payload = pipe(

diff --git a/...lugins/observability_solution/logs_shared/server/routes/log_entries/summary_highlights.ts b/...lugins/observability_solution/logs_shared/server/routes/log_entries/summary_highlights.ts
@@ -12,6 +12,7 @@ import { fold } from 'fp-ts/lib/Either';
 import { identity } from 'fp-ts/lib/function';
 import { schema } from '@kbn/config-schema';
 
+import { i18n } from '@kbn/i18n';
 import { logEntriesV1 } from '../../../common/http_api';
 import { throwErrors } from '../../../common/runtime_types';
 
@@ -35,6 +36,20 @@ export const initLogEntriesSummaryHighlightsRoute = ({
       {
         version: '1',
         validate: { request: { body: escapeHatch } },
+        options: {
+          deprecated: {
+            documentationUrl: '',
+            severity: 'warning',
+            message: i18n.translate(
+              'xpack.logsShared.deprecations.postLogEntriesSummaryHighlightsRoute.message',
+              {
+                defaultMessage:
+                  'Given the deprecation of the LogStream feature, this API will not return reliable data in upcoming versions of Kibana.',
+              }
+            ),
+            reason: { type: 'deprecate' },
+          },
+        },
       },
       async (requestContext, request, response) => {
         const payload = pipe(

diff --git a/x-pack/plugins/observability_solution/logs_shared/server/routes/log_views/get_log_view.ts b/x-pack/plugins/observability_solution/logs_shared/server/routes/log_views/get_log_view.ts
@@ -5,6 +5,7 @@
  * 2.0.
  */
 
+import { i18n } from '@kbn/i18n';
 import { logViewsV1 } from '../../../common/http_api';
 import { LOG_VIEW_URL } from '../../../common/http_api/log_views';
 import { createValidationFunction } from '../../../common/runtime_types';
@@ -30,6 +31,17 @@ export const initGetLogViewRoute = ({
             params: createValidationFunction(logViewsV1.getLogViewRequestParamsRT),
           },
         },
+        options: {
+          deprecated: {
+            documentationUrl: '',
+            severity: 'warning',
+            message: i18n.translate('xpack.logsShared.deprecations.getLogViewRoute.message', {
+              defaultMessage:
+                'Given the deprecation of the LogStream feature, this API will not have any effect configuring upcoming versions of Kibana.',
+            }),
+            reason: { type: 'deprecate' },
+          },
+        },
       },
       async (_requestContext, request, response) => {
         const { logViewId } = request.params;

diff --git a/x-pack/plugins/observability_solution/logs_shared/server/routes/log_views/put_log_view.ts b/x-pack/plugins/observability_solution/logs_shared/server/routes/log_views/put_log_view.ts
@@ -5,6 +5,7 @@
  * 2.0.
  */
 
+import { i18n } from '@kbn/i18n';
 import { logViewsV1 } from '../../../common/http_api';
 import { LOG_VIEW_URL } from '../../../common/http_api/log_views';
 import { createValidationFunction } from '../../../common/runtime_types';
@@ -26,6 +27,17 @@ export const initPutLogViewRoute = ({ framework, getStartServices }: LogsSharedB
             body: createValidationFunction(logViewsV1.putLogViewRequestPayloadRT),
           },
         },
+        options: {
+          deprecated: {
+            documentationUrl: '',
+            severity: 'warning',
+            message: i18n.translate('xpack.logsShared.deprecations.putLogViewRoute.message', {
+              defaultMessage:
+                'Given the deprecation of the LogStream feature, this API will not have any effect configuring upcoming versions of Kibana.',
+            }),
+            reason: { type: 'deprecate' },
+          },
+        },
       },
       async (_requestContext, request, response) => {
         const { logViewId } = request.params;

diff --git a/...ins/observability_solution/logs_shared/server/services/log_entries/log_entries_service.ts b/...ins/observability_solution/logs_shared/server/services/log_entries/log_entries_service.ts
@@ -22,10 +22,20 @@ export class LogEntriesService {
     setupDeps: LogEntriesServiceSetupDeps
   ) {
     void core.getStartServices().then(([, startDeps, selfStartDeps]) => {
+      /**
+       * @deprecated
+       *
+       * Given the deprecation of the LogStream feature, this API will not return reliable data in upcoming versions of Kibana.
+       */
       setupDeps.data.search.registerSearchStrategy(
         LOG_ENTRIES_SEARCH_STRATEGY,
         logEntriesSearchStrategyProvider({ ...setupDeps, ...startDeps, ...selfStartDeps })
       );
+      /**
+       * @deprecated
+       *
+       * Given the deprecation of the LogStream feature, this API will not return reliable data in upcoming versions of Kibana.
+       */
       setupDeps.data.search.registerSearchStrategy(
         LOG_ENTRY_SEARCH_STRATEGY,
         logEntrySearchStrategyProvider({ ...setupDeps, ...startDeps, ...selfStartDeps })