[Logs UI] Support inline Log Views in routes (elastic#151760)

## Summary Closes elastic#151489 This is the server side portion of support for transient / inline Log Views. Alerting and ML based functionality is scoped to the persisted type only, as we won't be supporting inline Log Views in those contexts. In terms of UI, changes have been made as close to the edge / boundary to the server (e.g. where we actually make network requests) as possible. This is because the bulk of the UI changes will come in elastic#142840. ## Testing This is predominantly a type-driven refactoring (the best kind), so we should be relatively safe here (especially since inline views aren't in the UI yet). But, a quick test of each page and a high level functional test would still be good.
bmorelli25 · Mar 10, 2023 · 5180ec7 · 5180ec7
1 parent 1a91f30
commit 5180ec7
Show file tree

Hide file tree

Showing 54 changed files with 167 additions and 121 deletions.
diff --git a/x-pack/plugins/infra/common/alerting/logs/log_threshold/types.ts b/x-pack/plugins/infra/common/alerting/logs/log_threshold/types.ts
@@ -7,7 +7,7 @@
 
 import { i18n } from '@kbn/i18n';
 import * as rt from 'io-ts';
-import { logViewReferenceRT } from '../../../log_views';
+import { persistedLogViewReferenceRT } from '../../../log_views';
 import { commonSearchSuccessResponseFieldsRT } from '../../../utils/elasticsearch_runtime_types';
 
 export const LOG_DOCUMENT_COUNT_RULE_TYPE_ID = 'logs.alert.document.count';
@@ -181,7 +181,7 @@ const RequiredRuleParamsRT = rt.type({
   count: ThresholdRT,
   timeUnit: timeUnitRT,
   timeSize: timeSizeRT,
-  logView: logViewReferenceRT, // In future, this should be a union of logViewReferenceRT and inlineLogViewRT
+  logView: persistedLogViewReferenceRT, // Alerts are only compatible with persisted Log Views
 });
 
 const partialRequiredRuleParamsRT = rt.partial(RequiredRuleParamsRT.props);

diff --git a/x-pack/plugins/infra/common/http_api/log_alerts/chart_preview_data.ts b/x-pack/plugins/infra/common/http_api/log_alerts/chart_preview_data.ts
@@ -13,6 +13,7 @@ import {
   timeSizeRT,
   groupByRT,
 } 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';
 
@@ -81,7 +82,7 @@ export type GetLogAlertsChartPreviewDataAlertParamsSubset = rt.TypeOf<
 
 export const getLogAlertsChartPreviewDataRequestPayloadRT = rt.type({
   data: rt.type({
-    sourceId: rt.string,
+    logView: persistedLogViewReferenceRT,
     alertParams: getLogAlertsChartPreviewDataAlertParamsSubsetRT,
     buckets: rt.number,
   }),

diff --git a/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_anomalies.ts b/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_anomalies.ts
@@ -7,6 +7,7 @@
 
 import * as rt from 'io-ts';
 
+import { persistedLogViewReferenceRT } from '../../../log_views';
 import { timeRangeRT, routeTimingMetadataRT } from '../../shared';
 import {
   logEntryAnomalyRT,
@@ -51,8 +52,8 @@ export type GetLogEntryAnomaliesSuccessResponsePayload = rt.TypeOf<
 export const getLogEntryAnomaliesRequestPayloadRT = rt.type({
   data: rt.intersection([
     rt.type({
-      // the ID of the source configuration
-      sourceId: rt.string,
+      // log view
+      logView: persistedLogViewReferenceRT,
       // the time range to fetch the log entry anomalies from
       timeRange: timeRangeRT,
     }),

diff --git a/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_anomalies_datasets.ts b/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_anomalies_datasets.ts
@@ -6,6 +6,7 @@
  */
 
 import * as rt from 'io-ts';
+import { persistedLogViewReferenceRT } from '../../../log_views';
 
 import {
   badRequestErrorRT,
@@ -23,8 +24,8 @@ export const LOG_ANALYSIS_GET_LOG_ENTRY_ANOMALIES_DATASETS_PATH =
 
 export const getLogEntryAnomaliesDatasetsRequestPayloadRT = rt.type({
   data: rt.type({
-    // the id of the source configuration
-    sourceId: rt.string,
+    // log view
+    logView: persistedLogViewReferenceRT,
     // the time range to fetch the anomalies datasets from
     timeRange: timeRangeRT,
   }),

diff --git a/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_categories.ts b/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_categories.ts
@@ -7,6 +7,7 @@
 
 import * as rt from 'io-ts';
 
+import { persistedLogViewReferenceRT } from '../../../log_views';
 import {
   badRequestErrorRT,
   forbiddenErrorRT,
@@ -38,8 +39,8 @@ export const getLogEntryCategoriesRequestPayloadRT = rt.type({
     rt.type({
       // the number of categories to fetch
       categoryCount: rt.number,
-      // the id of the source configuration
-      sourceId: rt.string,
+      // log view
+      logView: persistedLogViewReferenceRT,
       // the time range to fetch the categories from
       timeRange: timeRangeRT,
       // a list of histograms to create

diff --git a/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_category_datasets.ts b/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_category_datasets.ts
@@ -13,7 +13,7 @@ import {
   timeRangeRT,
   routeTimingMetadataRT,
 } 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';
 
@@ -23,8 +23,8 @@ export const LOG_ANALYSIS_GET_LOG_ENTRY_CATEGORY_DATASETS_PATH =
 
 export const getLogEntryCategoryDatasetsRequestPayloadRT = rt.type({
   data: rt.type({
-    // the id of the source configuration
-    sourceId: rt.string,
+    // log view
+    logView: persistedLogViewReferenceRT,
     // the time range to fetch the category datasets from
     timeRange: timeRangeRT,
   }),

diff --git a/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_category_examples.ts b/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_category_examples.ts
@@ -7,6 +7,7 @@
 
 import * as rt from 'io-ts';
 
+import { persistedLogViewReferenceRT } from '../../../log_views';
 import {
   badRequestErrorRT,
   forbiddenErrorRT,
@@ -28,8 +29,8 @@ export const getLogEntryCategoryExamplesRequestPayloadRT = rt.type({
     categoryId: rt.number,
     // the number of examples to fetch
     exampleCount: rt.number,
-    // the id of the source configuration
-    sourceId: rt.string,
+    // log view
+    logView: persistedLogViewReferenceRT,
     // the time range to fetch the category examples from
     timeRange: timeRangeRT,
   }),

diff --git a/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_examples.ts b/x-pack/plugins/infra/common/http_api/log_analysis/results/log_entry_examples.ts
@@ -6,6 +6,7 @@
  */
 
 import * as rt from 'io-ts';
+import { persistedLogViewReferenceRT } from '../../../log_views';
 import { logEntryExampleRT } from '../../../log_analysis';
 import {
   badRequestErrorRT,
@@ -28,8 +29,8 @@ export const getLogEntryExamplesRequestPayloadRT = rt.type({
       dataset: rt.string,
       // the number of examples to fetch
       exampleCount: rt.number,
-      // the id of the source configuration
-      sourceId: rt.string,
+      // logView
+      logView: persistedLogViewReferenceRT,
       // the time range to fetch the log rate examples from
       timeRange: timeRangeRT,
     }),

diff --git a/x-pack/plugins/infra/common/http_api/log_entries/highlights.ts b/x-pack/plugins/infra/common/http_api/log_entries/highlights.ts
@@ -8,12 +8,13 @@
 import * as rt from 'io-ts';
 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';
 
 export const logEntriesHighlightsBaseRequestRT = rt.intersection([
   rt.type({
-    sourceId: rt.string,
+    logView: logViewReferenceRT,
     startTimestamp: rt.number,
     endTimestamp: rt.number,
     highlightTerms: rt.array(rt.string),

diff --git a/x-pack/plugins/infra/common/http_api/log_entries/summary.ts b/x-pack/plugins/infra/common/http_api/log_entries/summary.ts
@@ -6,11 +6,12 @@
  */
 
 import * as rt from 'io-ts';
+import { logViewReferenceRT } from '../../log_views';
 
 export const LOG_ENTRIES_SUMMARY_PATH = '/api/log_entries/summary';
 
 export const logEntriesSummaryRequestRT = rt.type({
-  sourceId: rt.string,
+  logView: logViewReferenceRT,
   startTimestamp: rt.number,
   endTimestamp: rt.number,
   bucketSize: rt.number,

diff --git a/x-pack/plugins/infra/common/log_views/types.ts b/x-pack/plugins/infra/common/log_views/types.ts
@@ -103,9 +103,19 @@ export const logViewStatusRT = rt.strict({
 });
 export type LogViewStatus = rt.TypeOf<typeof logViewStatusRT>;
 
-export const logViewReferenceRT = rt.type({
+export const persistedLogViewReferenceRT = rt.type({
   logViewId: rt.string,
   type: rt.literal('log-view-reference'),
 });
 
+export type PersistedLogViewReference = rt.TypeOf<typeof persistedLogViewReferenceRT>;
+
+export const inlineLogViewReferenceRT = rt.type({
+  type: rt.literal('log-view-inline'),
+  id: rt.string,
+  attributes: logViewAttributesRT,
+});
+
+export const logViewReferenceRT = rt.union([persistedLogViewReferenceRT, inlineLogViewReferenceRT]);
+
 export type LogViewReference = rt.TypeOf<typeof logViewReferenceRT>;
diff --git a/x-pack/plugins/infra/common/search_strategies/log_entries/log_entries.ts b/x-pack/plugins/infra/common/search_strategies/log_entries/log_entries.ts
@@ -13,15 +13,15 @@ import {
   logEntryCursorRT,
   logEntryRT,
 } from '../../log_entry';
-import { logViewColumnConfigurationRT } from '../../log_views';
+import { logViewColumnConfigurationRT, logViewReferenceRT } from '../../log_views';
 import { jsonObjectRT } from '../../typed_json';
 import { searchStrategyErrorRT } from '../common/errors';
 
 export const LOG_ENTRIES_SEARCH_STRATEGY = 'infra-log-entries';
 
 const logEntriesBaseSearchRequestParamsRT = rt.intersection([
   rt.type({
-    sourceId: rt.string,
+    logView: logViewReferenceRT,
     startTimestamp: rt.number,
     endTimestamp: rt.number,
     size: rt.number,

diff --git a/x-pack/plugins/infra/common/search_strategies/log_entries/log_entry.ts b/x-pack/plugins/infra/common/search_strategies/log_entries/log_entry.ts
@@ -7,12 +7,13 @@
 
 import * as rt from 'io-ts';
 import { logEntryCursorRT, logEntryFieldRT } from '../../log_entry';
+import { logViewReferenceRT } from '../../log_views';
 import { searchStrategyErrorRT } from '../common/errors';
 
 export const LOG_ENTRY_SEARCH_STRATEGY = 'infra-log-entry';
 
 export const logEntrySearchRequestParamsRT = rt.type({
-  sourceId: rt.string,
+  logView: logViewReferenceRT,
   logEntryId: rt.string,
 });
 

diff --git a/x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/editor.tsx b/x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/editor.tsx
@@ -13,7 +13,7 @@ import {
   ForLastExpression,
   RuleTypeParamsExpressionProps,
 } from '@kbn/triggers-actions-ui-plugin/public';
-import { LogViewReference, ResolvedLogViewField } from '../../../../../common/log_views';
+import { PersistedLogViewReference, ResolvedLogViewField } from '../../../../../common/log_views';
 import {
   Comparator,
   isOptimizableGroupedThreshold,
@@ -54,7 +54,7 @@ const DEFAULT_BASE_EXPRESSION = {
 
 const DEFAULT_FIELD = 'log.level';
 
-const createLogViewReference = (logViewId: string): LogViewReference => ({
+const createLogViewReference = (logViewId: string): PersistedLogViewReference => ({
   logViewId,
   type: 'log-view-reference',
 });
@@ -69,7 +69,7 @@ const createDefaultCriterion = (
 
 const createDefaultCountRuleParams = (
   availableFields: ResolvedLogViewField[],
-  logView: LogViewReference
+  logView: PersistedLogViewReference
 ): PartialCountRuleParams => ({
   ...DEFAULT_BASE_EXPRESSION,
   logView,
@@ -82,7 +82,7 @@ const createDefaultCountRuleParams = (
 
 const createDefaultRatioRuleParams = (
   availableFields: ResolvedLogViewField[],
-  logView: LogViewReference
+  logView: PersistedLogViewReference
 ): PartialRatioRuleParams => ({
   ...DEFAULT_BASE_EXPRESSION,
   logView,
@@ -226,24 +226,24 @@ export const Editor: React.FC<RuleTypeParamsExpressionProps<PartialRuleParams, L
     [setRuleParams]
   );
 
-  const logViewReferemnce = useMemo(() => createLogViewReference(logViewId), [logViewId]);
+  const logViewReference = useMemo(() => createLogViewReference(logViewId), [logViewId]);
 
   const defaultCountAlertParams = useMemo(
-    () => createDefaultCountRuleParams(supportedFields, logViewReferemnce),
-    [supportedFields, logViewReferemnce]
+    () => createDefaultCountRuleParams(supportedFields, logViewReference),
+    [supportedFields, logViewReference]
   );
 
   const updateType = useCallback(
     (type: ThresholdType) => {
       const defaults =
         type === 'count'
           ? defaultCountAlertParams
-          : createDefaultRatioRuleParams(supportedFields, logViewReferemnce);
+          : createDefaultRatioRuleParams(supportedFields, logViewReference);
       // Reset properties that don't make sense switching from one context to the other
       setRuleParams('count', defaults.count);
       setRuleParams('criteria', defaults.criteria);
     },
-    [defaultCountAlertParams, setRuleParams, supportedFields, logViewReferemnce]
+    [defaultCountAlertParams, setRuleParams, supportedFields, logViewReference]
   );
 
   useMount(() => {

diff --git a/...blic/alerting/log_threshold/components/expression_editor/hooks/use_chart_preview_data.tsx b/...blic/alerting/log_threshold/components/expression_editor/hooks/use_chart_preview_data.tsx
@@ -73,7 +73,7 @@ export const callGetChartPreviewDataAPI = async (
     body: JSON.stringify(
       getLogAlertsChartPreviewDataRequestPayloadRT.encode({
         data: {
-          sourceId,
+          logView: { type: 'log-view-reference', logViewId: sourceId },
           alertParams,
           buckets,
         },

diff --git a/x-pack/plugins/infra/public/containers/logs/log_entry.ts b/x-pack/plugins/infra/public/containers/logs/log_entry.ts
@@ -30,7 +30,10 @@ export const useLogEntry = ({
       return !!logEntryId && !!sourceId
         ? {
             request: {
-              params: logEntrySearchRequestParamsRT.encode({ sourceId, logEntryId }),
+              params: logEntrySearchRequestParamsRT.encode({
+                logView: { type: 'log-view-reference', logViewId: sourceId },
+                logEntryId,
+              }),
             },
             options: { strategy: LOG_ENTRY_SEARCH_STRATEGY },
           }

diff --git a/x-pack/plugins/infra/public/containers/logs/log_highlights/log_entry_highlights.tsx b/x-pack/plugins/infra/public/containers/logs/log_highlights/log_entry_highlights.tsx
@@ -37,7 +37,7 @@ export const useLogEntryHighlights = (
 
         return await fetchLogEntriesHighlights(
           {
-            sourceId,
+            logView: { type: 'log-view-reference', logViewId: sourceId },
             startTimestamp,
             endTimestamp,
             center: centerPoint,

diff --git a/x-pack/plugins/infra/public/containers/logs/log_highlights/log_summary_highlights.ts b/x-pack/plugins/infra/public/containers/logs/log_highlights/log_summary_highlights.ts
@@ -39,7 +39,7 @@ export const useLogSummaryHighlights = (
 
         return await fetchLogSummaryHighlights(
           {
-            sourceId,
+            logView: { type: 'log-view-reference', logViewId: sourceId },
             startTimestamp,
             endTimestamp,
             bucketSize,

diff --git a/x-pack/plugins/infra/public/containers/logs/log_stream/use_fetch_log_entries_after.ts b/x-pack/plugins/infra/public/containers/logs/log_stream/use_fetch_log_entries_after.ts
@@ -58,7 +58,7 @@ export const useLogEntriesAfterRequest = ({
                     highlightPhrase,
                     query: query as JsonObject,
                     size: params.size,
-                    sourceId,
+                    logView: { type: 'log-view-reference', logViewId: sourceId },
                     startTimestamp,
                   }),
                 },

diff --git a/x-pack/plugins/infra/public/containers/logs/log_stream/use_fetch_log_entries_before.ts b/x-pack/plugins/infra/public/containers/logs/log_stream/use_fetch_log_entries_before.ts
@@ -58,7 +58,7 @@ export const useLogEntriesBeforeRequest = ({
                     highlightPhrase,
                     query: query as JsonObject,
                     size: params.size,
-                    sourceId,
+                    logView: { type: 'log-view-reference', logViewId: sourceId },
                     startTimestamp: params.extendTo ?? startTimestamp,
                   }),
                 },

diff --git a/x-pack/plugins/infra/public/containers/logs/log_summary/log_summary.test.tsx b/x-pack/plugins/infra/public/containers/logs/log_summary/log_summary.test.tsx
@@ -62,7 +62,7 @@ describe('useLogSummary hook', () => {
     expect(fetchLogSummaryMock).toHaveBeenCalledTimes(1);
     expect(fetchLogSummaryMock).toHaveBeenLastCalledWith(
       expect.objectContaining({
-        sourceId: 'INITIAL_SOURCE_ID',
+        logView: { logViewId: 'INITIAL_SOURCE_ID', type: 'log-view-reference' },
       }),
       expect.anything()
     );
@@ -74,7 +74,7 @@ describe('useLogSummary hook', () => {
     expect(fetchLogSummaryMock).toHaveBeenCalledTimes(2);
     expect(fetchLogSummaryMock).toHaveBeenLastCalledWith(
       expect.objectContaining({
-        sourceId: 'CHANGED_SOURCE_ID',
+        logView: { logViewId: 'CHANGED_SOURCE_ID', type: 'log-view-reference' },
       }),
       expect.anything()
     );

diff --git a/x-pack/plugins/infra/public/containers/logs/log_summary/log_summary.tsx b/x-pack/plugins/infra/public/containers/logs/log_summary/log_summary.tsx
@@ -35,7 +35,7 @@ export const useLogSummary = (
 
     pushLogSummaryBucketsArgs([
       {
-        sourceId,
+        logView: { type: 'log-view-reference', logViewId: sourceId },
         startTimestamp,
         endTimestamp,
         bucketSize,

diff --git a/...a/public/pages/logs/log_entry_categories/service_calls/get_log_entry_category_datasets.ts b/...a/public/pages/logs/log_entry_categories/service_calls/get_log_entry_category_datasets.ts
@@ -31,7 +31,7 @@ export const callGetLogEntryCategoryDatasetsAPI = async (
     body: JSON.stringify(
       getLogEntryCategoryDatasetsRequestPayloadRT.encode({
         data: {
-          sourceId,
+          logView: { type: 'log-view-reference', logViewId: sourceId },
           timeRange: {
             startTime,
             endTime,