[Logs UI] Versioning for Logs related APIs

x-pack/plugins/infra/common/http_api/index.ts

@@ -5,12 +5,9 @@
  * 2.0.
  */
 
-export * from './log_analysis';
 export * from './metadata_api';
-export * from './log_entries';
 export * from './metrics_explorer';
 export * from './metrics_api';
-export * from './log_alerts';
 export * from './snapshot_api';
 export * from './host_details';
 export * from './infra';
@@ -20,4 +17,9 @@ export * from './infra';
  */
 export * from './latest';
 export * as inventoryViewsV1 from './inventory_views/v1';
+export * as logAlertsV1 from './log_alerts/v1';
+export * as logAnalysisResultsV1 from './log_analysis/results/v1';
+export * as logAnalysisValidationV1 from './log_analysis/validation/v1';
+export * as logEntriesV1 from './log_entries/v1';
+export * as logViewsV1 from './log_views/v1';
 export * as metricsExplorerViewsV1 from './metrics_explorer_views/v1';

x-pack/plugins/infra/common/http_api/latest.ts

@@ -6,4 +6,9 @@
  */
 
 export * from './inventory_views/v1';
+export * from './log_alerts/v1';
+export * from './log_analysis/results/v1';
+export * from './log_analysis/validation/v1';
+export * from './log_entries/v1';
+export * from './log_views/v1';
 export * from './metrics_explorer_views/v1';

x-pack/plugins/infra/common/http_api/log_alerts/chart_preview_data.ts → x-pack/plugins/infra/common/http_api/log_alerts/v1/chart_preview_data.ts

@@ -12,8 +12,8 @@ import {
   timeUnitRT,
   timeSizeRT,
   groupByRT,
-} from '../../alerting/logs/log_threshold/types';
-import { persistedLogViewReferenceRT } from '../../log_views';
+} from '../../../alerting/logs/log_threshold/types';
+import { persistedLogViewReferenceRT } from '../../../log_views';
 
 export const LOG_ALERTS_CHART_PREVIEW_DATA_PATH = '/api/infra/log_alerts/chart_preview_data';
 

x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_anomalies.ts → x-pack/plugins/infra/common/http_api/log_analysis/results/v1/log_entry_anomalies.ts

@@ -7,15 +7,15 @@
 
 import * as rt from 'io-ts';
 
-import { persistedLogViewReferenceRT } from '../../../log_views';
-import { timeRangeRT, routeTimingMetadataRT } from '../../shared';
+import { persistedLogViewReferenceRT } from '../../../../log_views';
+import { timeRangeRT, routeTimingMetadataRT } from '../../../shared';
 import {
   logEntryAnomalyRT,
   logEntryAnomalyDatasetsRT,
   anomaliesSortRT,
   paginationRT,
   paginationCursorRT,
-} from '../../../log_analysis';
+} from '../../../../log_analysis';
 
 export const LOG_ANALYSIS_GET_LOG_ENTRY_ANOMALIES_PATH =
   '/api/infra/log_analysis/results/log_entry_anomalies';

x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_anomalies_datasets.ts → x-pack/plugins/infra/common/http_api/log_analysis/results/v1/log_entry_anomalies_datasets.ts

@@ -6,14 +6,14 @@
  */
 
 import * as rt from 'io-ts';
-import { persistedLogViewReferenceRT } from '../../../log_views';
+import { persistedLogViewReferenceRT } from '../../../../log_views';
 
 import {
   badRequestErrorRT,
   forbiddenErrorRT,
   timeRangeRT,
   routeTimingMetadataRT,
-} from '../../shared';
+} from '../../../shared';
 
 export const LOG_ANALYSIS_GET_LOG_ENTRY_ANOMALIES_DATASETS_PATH =
   '/api/infra/log_analysis/results/log_entry_anomalies_datasets';

x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_categories.ts → x-pack/plugins/infra/common/http_api/log_analysis/results/v1/log_entry_categories.ts

@@ -7,15 +7,15 @@
 
 import * as rt from 'io-ts';
 
-import { persistedLogViewReferenceRT } from '../../../log_views';
+import { persistedLogViewReferenceRT } from '../../../../log_views';
 import {
   badRequestErrorRT,
   forbiddenErrorRT,
   timeRangeRT,
   routeTimingMetadataRT,
-} from '../../shared';
+} from '../../../shared';
 
-import { logEntryCategoryRT, categoriesSortRT } from '../../../log_analysis';
+import { logEntryCategoryRT, categoriesSortRT } from '../../../../log_analysis';
 
 export const LOG_ANALYSIS_GET_LOG_ENTRY_CATEGORIES_PATH =
   '/api/infra/log_analysis/results/log_entry_categories';

x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_category_datasets.ts → x-pack/plugins/infra/common/http_api/log_analysis/results/v1/log_entry_category_datasets.ts

@@ -12,8 +12,8 @@ import {
   forbiddenErrorRT,
   timeRangeRT,
   routeTimingMetadataRT,
-} from '../../shared';
-import { persistedLogViewReferenceRT } from '../../../log_views';
+} from '../../../shared';
+import { persistedLogViewReferenceRT } from '../../../../log_views';
 export const LOG_ANALYSIS_GET_LOG_ENTRY_CATEGORY_DATASETS_PATH =
   '/api/infra/log_analysis/results/log_entry_category_datasets';
 

x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_category_datasets_stats.ts → x-pack/plugins/infra/common/http_api/log_analysis/results/v1/log_entry_category_datasets_stats.ts

@@ -7,7 +7,7 @@
 
 import * as rt from 'io-ts';
 
-import { timeRangeRT, routeTimingMetadataRT } from '../../shared';
+import { timeRangeRT, routeTimingMetadataRT } from '../../../shared';
 
 export const LOG_ANALYSIS_GET_LATEST_LOG_ENTRY_CATEGORY_DATASETS_STATS_PATH =
   '/api/infra/log_analysis/results/latest_log_entry_category_datasets_stats';

x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_category_examples.ts → x-pack/plugins/infra/common/http_api/log_analysis/results/v1/log_entry_category_examples.ts

@@ -7,14 +7,14 @@
 
 import * as rt from 'io-ts';
 
-import { persistedLogViewReferenceRT } from '../../../log_views';
+import { persistedLogViewReferenceRT } from '../../../../log_views';
 import {
   badRequestErrorRT,
   forbiddenErrorRT,
   timeRangeRT,
   routeTimingMetadataRT,
-} from '../../shared';
-import { logEntryContextRT } from '../../../log_entry';
+} from '../../../shared';
+import { logEntryContextRT } from '../../../../log_entry';
 
 export const LOG_ANALYSIS_GET_LOG_ENTRY_CATEGORY_EXAMPLES_PATH =
   '/api/infra/log_analysis/results/log_entry_category_examples';

x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_examples.ts → x-pack/plugins/infra/common/http_api/log_analysis/results/v1/log_entry_examples.ts

@@ -6,14 +6,14 @@
  */
 
 import * as rt from 'io-ts';
-import { persistedLogViewReferenceRT } from '../../../log_views';
-import { logEntryExampleRT } from '../../../log_analysis';
+import { persistedLogViewReferenceRT } from '../../../../log_views';
+import { logEntryExampleRT } from '../../../../log_analysis';
 import {
   badRequestErrorRT,
   forbiddenErrorRT,
   timeRangeRT,
   routeTimingMetadataRT,
-} from '../../shared';
+} from '../../../shared';
 
 export const LOG_ANALYSIS_GET_LOG_ENTRY_RATE_EXAMPLES_PATH =
   '/api/infra/log_analysis/results/log_entry_examples';
@@ -48,7 +48,7 @@ export type GetLogEntryExamplesRequestPayload = rt.TypeOf<
  * response
  */
 
-export const getLogEntryExamplesSuccessReponsePayloadRT = rt.intersection([
+export const getLogEntryExamplesSuccessResponsePayloadRT = rt.intersection([
   rt.type({
     data: rt.type({
       examples: rt.array(logEntryExampleRT),
@@ -60,11 +60,11 @@ export const getLogEntryExamplesSuccessReponsePayloadRT = rt.intersection([
 ]);
 
 export type GetLogEntryExamplesSuccessReponsePayload = rt.TypeOf<
-  typeof getLogEntryExamplesSuccessReponsePayloadRT
+  typeof getLogEntryExamplesSuccessResponsePayloadRT
 >;
 
 export const getLogEntryExamplesResponsePayloadRT = rt.union([
-  getLogEntryExamplesSuccessReponsePayloadRT,
+  getLogEntryExamplesSuccessResponsePayloadRT,
   badRequestErrorRT,
   forbiddenErrorRT,
 ]);

x-pack/plugins/infra/common/http_api/log_analysis/validation/log_entry_rate_indices.ts → x-pack/plugins/infra/common/http_api/log_analysis/validation/v1/log_entry_rate_indices.ts

@@ -6,7 +6,7 @@
  */
 
 import * as rt from 'io-ts';
-import { mappingRuntimeFieldRT } from '../../shared/es_request';
+import { mappingRuntimeFieldRT } from '../../../shared/es_request';
 
 export const LOG_ANALYSIS_VALIDATE_INDICES_PATH =
   '/api/infra/log_analysis/validation/log_entry_rate_indices';

x-pack/plugins/infra/common/http_api/log_entries/highlights.ts → x-pack/plugins/infra/common/http_api/log_entries/v1/highlights.ts

@@ -6,9 +6,9 @@
  */
 
 import * as rt from 'io-ts';
-import { logEntryCursorRT, logEntryRT } from '../../log_entry';
-import { logViewColumnConfigurationRT } from '../../log_views';
-import { logViewReferenceRT } from '../../log_views';
+import { logEntryCursorRT, logEntryRT } from '../../../log_entry';
+import { logViewColumnConfigurationRT } from '../../../log_views';
+import { logViewReferenceRT } from '../../../log_views';
 
 export const LOG_ENTRIES_HIGHLIGHTS_PATH = '/api/log_entries/highlights';
 

x-pack/plugins/infra/common/http_api/log_entries/summary.ts → x-pack/plugins/infra/common/http_api/log_entries/v1/summary.ts

@@ -6,7 +6,7 @@
  */
 
 import * as rt from 'io-ts';
-import { logViewReferenceRT } from '../../log_views';
+import { logViewReferenceRT } from '../../../log_views';
 
 export const LOG_ENTRIES_SUMMARY_PATH = '/api/log_entries/summary';
 

x-pack/plugins/infra/common/http_api/log_entries/summary_highlights.ts → x-pack/plugins/infra/common/http_api/log_entries/v1/summary_highlights.ts

@@ -6,7 +6,7 @@
  */
 
 import * as rt from 'io-ts';
-import { logEntryCursorRT } from '../../log_entry';
+import { logEntryCursorRT } from '../../../log_entry';
 import { logEntriesSummaryRequestRT, logEntriesSummaryBucketRT } from './summary';
 
 export const LOG_ENTRIES_SUMMARY_HIGHLIGHTS_PATH = '/api/log_entries/summary_highlights';

x-pack/plugins/infra/common/http_api/log_views/index.ts

@@ -6,5 +6,3 @@
  */
 
 export { getLogViewUrl, LOG_VIEW_URL } from './common';
-export * from './get_log_view';
-export * from './put_log_view';

x-pack/plugins/infra/common/http_api/log_views/get_log_view.ts → x-pack/plugins/infra/common/http_api/log_views/v1/get_log_view.ts

@@ -6,13 +6,15 @@
  */
 
 import * as rt from 'io-ts';
-import { logViewRT } from '../../log_views';
+import { logViewRT } from '../../../log_views';
 
 export const getLogViewRequestParamsRT = rt.type({
   // the id of the log view
   logViewId: rt.string,
 });
 
+export type GetLogViewRequestParams = rt.TypeOf<typeof getLogViewRequestParamsRT>;
+
 export const getLogViewResponsePayloadRT = rt.type({
   data: logViewRT,
 });

x-pack/plugins/infra/common/http_api/log_analysis/index.ts → x-pack/plugins/infra/common/http_api/log_views/v1/index.ts

@@ -5,5 +5,5 @@
  * 2.0.
  */
 
-export * from './results';
-export * from './validation';
+export * from './get_log_view';
+export * from './put_log_view';

x-pack/plugins/infra/common/http_api/log_views/put_log_view.ts → x-pack/plugins/infra/common/http_api/log_views/v1/put_log_view.ts

@@ -6,7 +6,7 @@
  */
 
 import * as rt from 'io-ts';
-import { logViewAttributesRT, logViewRT } from '../../log_views';
+import { logViewAttributesRT, logViewRT } from '../../../log_views';
 
 export const putLogViewRequestParamsRT = rt.type({
   logViewId: rt.string,
@@ -15,6 +15,7 @@ export const putLogViewRequestParamsRT = rt.type({
 export const putLogViewRequestPayloadRT = rt.type({
   attributes: rt.partial(logViewAttributesRT.type.props),
 });
+
 export type PutLogViewRequestPayload = rt.TypeOf<typeof putLogViewRequestPayloadRT>;
 
 export const putLogViewResponsePayloadRT = rt.type({

x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion_preview_chart.tsx

@@ -46,7 +46,7 @@ import { Color, colorTransformer } from '../../../../../common/color_palette';
 import {
   GetLogAlertsChartPreviewDataAlertParamsSubset,
   getLogAlertsChartPreviewDataAlertParamsSubsetRT,
-} from '../../../../../common/http_api/log_alerts';
+} from '../../../../../common/http_api';
 import { useChartPreviewData } from './hooks/use_chart_preview_data';
 import { decodeOrThrow } from '../../../../../common/runtime_types';
 import { useKibanaTimeZoneSetting } from '../../../../hooks/use_kibana_time_zone_setting';

x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/hooks/use_chart_preview_data.tsx

@@ -5,21 +5,21 @@
  * 2.0.
  */
 
-import { useState, useMemo } from 'react';
 import { HttpHandler } from '@kbn/core/public';
 import { useKibana } from '@kbn/kibana-react-plugin/public';
+import { useMemo, useState } from 'react';
 import { isRatioRule } from '../../../../../../common/alerting/logs/log_threshold';
-import { PersistedLogViewReference } from '../../../../../../common/log_views';
-import { ExecutionTimeRange } from '../../../../../types';
-import { useTrackedPromise } from '../../../../../utils/use_tracked_promise';
 import {
+  GetLogAlertsChartPreviewDataAlertParamsSubset,
+  getLogAlertsChartPreviewDataRequestPayloadRT,
   GetLogAlertsChartPreviewDataSuccessResponsePayload,
   getLogAlertsChartPreviewDataSuccessResponsePayloadRT,
-  getLogAlertsChartPreviewDataRequestPayloadRT,
   LOG_ALERTS_CHART_PREVIEW_DATA_PATH,
 } from '../../../../../../common/http_api';
+import { PersistedLogViewReference } from '../../../../../../common/log_views';
 import { decodeOrThrow } from '../../../../../../common/runtime_types';
-import { GetLogAlertsChartPreviewDataAlertParamsSubset } from '../../../../../../common/http_api/log_alerts';
+import { ExecutionTimeRange } from '../../../../../types';
+import { useTrackedPromise } from '../../../../../utils/use_tracked_promise';
 
 interface Options {
   logViewReference: PersistedLogViewReference;
@@ -147,6 +147,7 @@ export const callGetChartPreviewDataAPI = async (
         },
       })
     ),
+    version: '1',
   });
 
   return decodeOrThrow(getLogAlertsChartPreviewDataSuccessResponsePayloadRT)(response);

x-pack/plugins/infra/public/components/log_stream/log_stream.story_decorators.tsx

@@ -21,7 +21,7 @@ import {
   ISearchOptions,
 } from '@kbn/data-plugin/public';
 import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
-import { getLogViewResponsePayloadRT } from '../../../common/http_api/log_views';
+import { getLogViewResponsePayloadRT } from '../../../common/http_api';
 import { defaultLogViewAttributes } from '../../../common/log_views';
 import {
   LogEntriesSearchResponsePayload,

x-pack/plugins/infra/public/containers/logs/log_analysis/api/get_latest_categories_datasets_stats.ts

@@ -42,6 +42,7 @@ export const callGetLatestCategoriesDatasetsStatsAPI = async (
         },
       })
     ),
+    version: '1',
   });
 
   return decodeOrThrow(getLatestLogEntryCategoryDatasetsStatsSuccessResponsePayloadRT)(response);

x-pack/plugins/infra/public/containers/logs/log_analysis/api/validate_datasets.ts

@@ -37,6 +37,7 @@ export const callValidateDatasetsAPI = async (requestArgs: RequestArgs, fetch: H
         },
       })
     ),
+    version: '1',
   });
 
   return decodeOrThrow(validateLogEntryDatasetsResponsePayloadRT)(response);

x-pack/plugins/infra/public/containers/logs/log_analysis/api/validate_indices.ts

@@ -31,6 +31,7 @@ export const callValidateIndicesAPI = async (requestArgs: RequestArgs, fetch: Ht
       // @ts-expect-error TODO: fix after elasticsearch-js bump
       validationIndicesRequestPayloadRT.encode({ data: { indices, fields, runtimeMappings } })
     ),
+    version: '1',
   });
 
   return decodeOrThrow(validationIndicesResponsePayloadRT)(response);

x-pack/plugins/infra/public/containers/logs/log_analysis/log_analysis_module_types.ts

@@ -10,7 +10,7 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
 import {
   ValidateLogEntryDatasetsResponsePayload,
   ValidationIndicesResponsePayload,
-} from '../../../../common/http_api/log_analysis';
+} from '../../../../common/http_api';
 import { DatasetFilter } from '../../../../common/log_analysis';
 import { DeleteJobsResponsePayload } from './api/ml_cleanup';
 import { FetchJobStatusResponsePayload } from './api/ml_get_jobs_summary_api';

x-pack/plugins/infra/public/containers/logs/log_highlights/api/fetch_log_entries_highlights.ts

@@ -23,6 +23,7 @@ export const fetchLogEntriesHighlights = async (
   const response = await fetch(LOG_ENTRIES_HIGHLIGHTS_PATH, {
     method: 'POST',
     body: JSON.stringify(logEntriesHighlightsRequestRT.encode(requestArgs)),
+    version: '1',
   });
 
   return decodeOrThrow(logEntriesHighlightsResponseRT)(response);

x-pack/plugins/infra/public/containers/logs/log_highlights/api/fetch_log_summary_highlights.ts

@@ -22,6 +22,7 @@ export const fetchLogSummaryHighlights = async (
   const response = await fetch(LOG_ENTRIES_SUMMARY_HIGHLIGHTS_PATH, {
     method: 'POST',
     body: JSON.stringify(logEntriesSummaryHighlightsRequestRT.encode(requestArgs)),
+    version: '1',
   });
 
   return decodeOrThrow(logEntriesSummaryHighlightsResponseRT)(response);

x-pack/plugins/infra/public/containers/logs/log_summary/api/fetch_log_summary.ts

@@ -22,6 +22,7 @@ export const fetchLogSummary = async (
   const response = await fetch(LOG_ENTRIES_SUMMARY_PATH, {
     method: 'POST',
     body: JSON.stringify(logEntriesSummaryRequestRT.encode(requestArgs)),
+    version: '1',
   });
 
   return decodeOrThrow(logEntriesSummaryResponseRT)(response);

x-pack/plugins/infra/public/containers/ml/infra_ml_module_types.ts

@@ -9,7 +9,7 @@ import { HttpHandler } from '@kbn/core/public';
 import {
   ValidateLogEntryDatasetsResponsePayload,
   ValidationIndicesResponsePayload,
-} from '../../../common/http_api/log_analysis';
+} from '../../../common/http_api';
 import { DeleteJobsResponsePayload } from './api/ml_cleanup';
 import { FetchJobStatusResponsePayload } from './api/ml_get_jobs_summary_api';
 import { GetMlModuleResponsePayload } from './api/ml_get_module';