[Logs UI] Fetch single log entries via a search strategy

x-pack/plugins/infra/common/http_api/log_entries/entries.ts

@@ -5,8 +5,8 @@
  */
 
 import * as rt from 'io-ts';
+import { logEntryCursorRT } from '../../log_entry';
 import { jsonArrayRT } from '../../typed_json';
-import { logEntriesCursorRT } from './common';
 import { logSourceColumnConfigurationRT } from '../log_sources';
 
 export const LOG_ENTRIES_PATH = '/api/log_entries/entries';
@@ -26,17 +26,17 @@ export const logEntriesBaseRequestRT = rt.intersection([
 
 export const logEntriesBeforeRequestRT = rt.intersection([
   logEntriesBaseRequestRT,
-  rt.type({ before: rt.union([logEntriesCursorRT, rt.literal('last')]) }),
+  rt.type({ before: rt.union([logEntryCursorRT, rt.literal('last')]) }),
 ]);
 
 export const logEntriesAfterRequestRT = rt.intersection([
   logEntriesBaseRequestRT,
-  rt.type({ after: rt.union([logEntriesCursorRT, rt.literal('first')]) }),
+  rt.type({ after: rt.union([logEntryCursorRT, rt.literal('first')]) }),
 ]);
 
 export const logEntriesCenteredRequestRT = rt.intersection([
   logEntriesBaseRequestRT,
-  rt.type({ center: logEntriesCursorRT }),
+  rt.type({ center: logEntryCursorRT }),
 ]);
 
 export const logEntriesRequestRT = rt.union([
@@ -85,7 +85,7 @@ export const logEntryContextRT = rt.union([
 
 export const logEntryRT = rt.type({
   id: rt.string,
-  cursor: logEntriesCursorRT,
+  cursor: logEntryCursorRT,
   columns: rt.array(logColumnRT),
   context: logEntryContextRT,
 });
@@ -104,8 +104,8 @@ export const logEntriesResponseRT = rt.type({
   data: rt.intersection([
     rt.type({
       entries: rt.array(logEntryRT),
-      topCursor: rt.union([logEntriesCursorRT, rt.null]),
-      bottomCursor: rt.union([logEntriesCursorRT, rt.null]),
+      topCursor: rt.union([logEntryCursorRT, rt.null]),
+      bottomCursor: rt.union([logEntryCursorRT, rt.null]),
     }),
     rt.partial({
       hasMoreBefore: rt.boolean,

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

@@ -5,14 +5,14 @@
  */
 
 import * as rt from 'io-ts';
+import { logEntryCursorRT } from '../../log_entry';
 import {
   logEntriesBaseRequestRT,
   logEntriesBeforeRequestRT,
   logEntriesAfterRequestRT,
   logEntriesCenteredRequestRT,
   logEntryRT,
 } from './entries';
-import { logEntriesCursorRT } from './common';
 
 export const LOG_ENTRIES_HIGHLIGHTS_PATH = '/api/log_entries/highlights';
 
@@ -58,8 +58,8 @@ export const logEntriesHighlightsResponseRT = rt.type({
         entries: rt.array(logEntryRT),
       }),
       rt.type({
-        topCursor: logEntriesCursorRT,
-        bottomCursor: logEntriesCursorRT,
+        topCursor: logEntryCursorRT,
+        bottomCursor: logEntryCursorRT,
         entries: rt.array(logEntryRT),
       }),
     ])

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

@@ -4,9 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-export * from './common';
 export * from './entries';
 export * from './highlights';
-export * from './item';
 export * from './summary';
 export * from './summary_highlights';

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

@@ -5,8 +5,8 @@
  */
 
 import * as rt from 'io-ts';
+import { logEntryCursorRT } from '../../log_entry';
 import { logEntriesSummaryRequestRT, logEntriesSummaryBucketRT } from './summary';
-import { logEntriesCursorRT } from './common';
 
 export const LOG_ENTRIES_SUMMARY_HIGHLIGHTS_PATH = '/api/log_entries/summary_highlights';
 
@@ -24,7 +24,7 @@ export type LogEntriesSummaryHighlightsRequest = rt.TypeOf<
 export const logEntriesSummaryHighlightsBucketRT = rt.intersection([
   logEntriesSummaryBucketRT,
   rt.type({
-    representativeKey: logEntriesCursorRT,
+    representativeKey: logEntryCursorRT,
   }),
 ]);
 

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

@@ -5,3 +5,4 @@
  */
 
 export * from './log_entry';
+export * from './log_entry_cursor';

x-pack/plugins/infra/common/log_entry/log_entry_cursor.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import * as rt from 'io-ts';
+import { decodeOrThrow } from '../runtime_types';
+
+export const logEntryCursorRT = rt.type({
+  time: rt.number,
+  tiebreaker: rt.number,
+});
+
+export type LogEntryCursor = rt.TypeOf<typeof logEntryCursorRT>;
+
+export const getLogEntryCursorFromHit = (hit: { sort: [number, number] }) =>
+  decodeOrThrow(logEntryCursorRT)({
+    time: hit.sort[0],
+    tiebreaker: hit.sort[1],
+  });

x-pack/plugins/infra/common/runtime_types.ts

@@ -7,16 +7,41 @@
 import { fold } from 'fp-ts/lib/Either';
 import { identity } from 'fp-ts/lib/function';
 import { pipe } from 'fp-ts/lib/pipeable';
-import { Errors, Type } from 'io-ts';
-import { failure } from 'io-ts/lib/PathReporter';
-import { RouteValidationFunction } from 'kibana/server';
+import { Context, Errors, IntersectionType, Type, UnionType, ValidationError } from 'io-ts';
+import type { RouteValidationFunction } from 'kibana/server';
 
 type ErrorFactory = (message: string) => Error;
 
+const getErrorPath = ([first, ...rest]: Context): string[] => {
+  if (typeof first === 'undefined') {
+    return [];
+  } else if (first.type instanceof IntersectionType) {
+    const [, ...next] = rest;
+    return getErrorPath(next);
+  } else if (first.type instanceof UnionType) {
+    const [, ...next] = rest;
+    return [first.key, ...getErrorPath(next)];
+  }
+
+  return [first.key, ...getErrorPath(rest)];
+};
+
+const getErrorType = ({ context }: ValidationError) =>
+  context[context.length - 1]?.type?.name ?? 'unknown';
+
+const formatError = (error: ValidationError) =>
+  error.message ??
+  `in ${getErrorPath(error.context).join('/')}: ${JSON.stringify(
+    error.value
+  )} does not match expected type ${getErrorType(error)}`;
+
+const formatErrors = (errors: ValidationError[]) =>
+  `Failed to validate: \n${errors.map((error) => `  ${formatError(error)}`).join('\n')}`;
+
 export const createPlainError = (message: string) => new Error(message);
 
 export const throwErrors = (createError: ErrorFactory) => (errors: Errors) => {
-  throw createError(failure(errors).join('\n'));
+  throw createError(formatErrors(errors));
 };
 
 export const decodeOrThrow = <DecodedValue, EncodedValue, InputValue>(
@@ -33,7 +58,7 @@ export const createValidationFunction = <DecodedValue, EncodedValue, InputValue>
   pipe(
     runtimeType.decode(inputValue),
     fold<Errors, DecodedValue, ValdidationResult<DecodedValue>>(
-      (errors: Errors) => badRequest(failure(errors).join('\n')),
+      (errors: Errors) => badRequest(formatErrors(errors)),
       (result: DecodedValue) => ok(result)
     )
   );

x-pack/plugins/infra/common/search_strategies/common/errors.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import * as rt from 'io-ts';
+
+const genericErrorRT = rt.type({
+  type: rt.literal('generic'),
+  message: rt.string,
+});
+
+const shardFailureErrorRT = rt.type({
+  type: rt.literal('shardFailure'),
+  shardInfo: rt.type({
+    shard: rt.number,
+    index: rt.string,
+    node: rt.string,
+  }),
+  message: rt.string,
+});
+
+export const searchStrategyErrorRT = rt.union([genericErrorRT, shardFailureErrorRT]);
+
+export type SearchStrategyError = rt.TypeOf<typeof searchStrategyErrorRT>;

x-pack/plugins/infra/common/search_strategies/log_entries/log_entry.ts

@@ -0,0 +1,46 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import * as rt from 'io-ts';
+import { logEntryCursorRT } from '../../log_entry';
+import { jsonArrayRT } from '../../typed_json';
+import { searchStrategyErrorRT } from '../common/errors';
+
+export const LOG_ENTRY_SEARCH_STRATEGY = 'infra-log-entry';
+
+export const logEntrySearchRequestParamsRT = rt.type({
+  sourceId: rt.string,
+  logEntryId: rt.string,
+});
+
+export type LogEntrySearchRequestParams = rt.TypeOf<typeof logEntrySearchRequestParamsRT>;
+
+const logEntryFieldRT = rt.type({
+  field: rt.string,
+  value: jsonArrayRT,
+});
+
+export type LogEntryField = rt.TypeOf<typeof logEntryFieldRT>;
+
+export const logEntryRT = rt.type({
+  id: rt.string,
+  index: rt.string,
+  fields: rt.array(logEntryFieldRT),
+  key: logEntryCursorRT,
+});
+
+export type LogEntry = rt.TypeOf<typeof logEntryRT>;
+
+export const logEntrySearchResponsePayloadRT = rt.intersection([
+  rt.type({
+    data: rt.union([logEntryRT, rt.null]),
+  }),
+  rt.partial({
+    errors: rt.array(searchStrategyErrorRT),
+  }),
+]);
+
+export type LogEntrySearchResponsePayload = rt.TypeOf<typeof logEntrySearchResponsePayloadRT>;

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

@@ -8,7 +8,7 @@ import React, { useMemo, useCallback, useEffect } from 'react';
 import { noop } from 'lodash';
 import { euiStyled } from '../../../../observability/public';
 
-import { LogEntriesCursor } from '../../../common/http_api';
+import { LogEntryCursor } from '../../../common/log_entry';
 
 import { useKibana } from '../../../../../../src/plugins/kibana_react/public';
 import { LogSourceConfigurationProperties, useLogSource } from '../../containers/logs/log_source';
@@ -28,7 +28,7 @@ export interface LogStreamProps {
   startTimestamp: number;
   endTimestamp: number;
   query?: string;
-  center?: LogEntriesCursor;
+  center?: LogEntryCursor;
   highlight?: string;
   height?: string | number;
   columns?: LogColumnDefinition[];

x-pack/plugins/infra/public/components/logging/log_entry_flyout/log_entry_actions_menu.test.tsx

@@ -28,7 +28,7 @@ describe('LogEntryActionsMenu component', () => {
       const elementWrapper = mount(
         <ProviderWrapper>
           <LogEntryActionsMenu
-            logItem={{
+            logEntry={{
               fields: [{ field: 'host.ip', value: ['HOST_IP'] }],
               id: 'ITEM_ID',
               index: 'INDEX',
@@ -58,7 +58,7 @@ describe('LogEntryActionsMenu component', () => {
       const elementWrapper = mount(
         <ProviderWrapper>
           <LogEntryActionsMenu
-            logItem={{
+            logEntry={{
               fields: [{ field: 'container.id', value: ['CONTAINER_ID'] }],
               id: 'ITEM_ID',
               index: 'INDEX',
@@ -88,7 +88,7 @@ describe('LogEntryActionsMenu component', () => {
       const elementWrapper = mount(
         <ProviderWrapper>
           <LogEntryActionsMenu
-            logItem={{
+            logEntry={{
               fields: [{ field: 'kubernetes.pod.uid', value: ['POD_UID'] }],
               id: 'ITEM_ID',
               index: 'INDEX',
@@ -118,7 +118,7 @@ describe('LogEntryActionsMenu component', () => {
       const elementWrapper = mount(
         <ProviderWrapper>
           <LogEntryActionsMenu
-            logItem={{
+            logEntry={{
               fields: [
                 { field: 'container.id', value: ['CONTAINER_ID'] },
                 { field: 'host.ip', value: ['HOST_IP'] },
@@ -154,7 +154,7 @@ describe('LogEntryActionsMenu component', () => {
       const elementWrapper = mount(
         <ProviderWrapper>
           <LogEntryActionsMenu
-            logItem={{
+            logEntry={{
               fields: [],
               id: 'ITEM_ID',
               index: 'INDEX',
@@ -188,7 +188,7 @@ describe('LogEntryActionsMenu component', () => {
       const elementWrapper = mount(
         <ProviderWrapper>
           <LogEntryActionsMenu
-            logItem={{
+            logEntry={{
               fields: [{ field: 'trace.id', value: ['1234567'] }],
               id: 'ITEM_ID',
               index: 'INDEX',
@@ -219,7 +219,7 @@ describe('LogEntryActionsMenu component', () => {
       const elementWrapper = mount(
         <ProviderWrapper>
           <LogEntryActionsMenu
-            logItem={{
+            logEntry={{
               fields: [
                 { field: 'trace.id', value: ['1234567'] },
                 { field: '@timestamp', value: [timestamp] },
@@ -252,7 +252,7 @@ describe('LogEntryActionsMenu component', () => {
       const elementWrapper = mount(
         <ProviderWrapper>
           <LogEntryActionsMenu
-            logItem={{
+            logEntry={{
               fields: [],
               id: 'ITEM_ID',
               index: 'INDEX',