Utilise index in log item flyout to prevent scanning of all available…

… indices on getLogItem which can bring down small clusters
elastic · Apr 6, 2020 · 284037b · 284037b
1 parent c19e0da
commit 284037b
Show file tree

Hide file tree

Showing 15 changed files with 81 additions and 26 deletions.
diff --git a/x-pack/plugins/infra/common/graphql/shared/fragments.gql_query.ts b/x-pack/plugins/infra/common/graphql/shared/fragments.gql_query.ts
@@ -24,6 +24,7 @@ export const sharedFragments = {
   InfraLogEntryFields: gql`
     fragment InfraLogEntryFields on InfraLogEntry {
       gid
+      index
       key {
         time
         tiebreaker

diff --git a/x-pack/plugins/infra/common/graphql/types.ts b/x-pack/plugins/infra/common/graphql/types.ts
@@ -159,6 +159,8 @@ export interface InfraLogEntry {
   key: InfraTimeKey;
   /** The log entry's id */
   gid: string;
+  /** The log entry's index */
+  index: string;
   /** The source id */
   source: string;
   /** The columns used for rendering the log entry */
@@ -993,6 +995,8 @@ export namespace InfraLogEntryFields {
 
     gid: string;
 
+    index: string;
+
     key: Key;
 
     columns: Columns[];
@@ -1062,6 +1066,8 @@ export namespace InfraLogEntryHighlightFields {
 
     gid: string;
 
+    index: string;
+
     key: Key;
 
     columns: Columns[];

diff --git a/x-pack/plugins/infra/common/http_api/log_entries/entries.ts b/x-pack/plugins/infra/common/http_api/log_entries/entries.ts
@@ -76,6 +76,7 @@ export const logColumnRT = rt.union([logTimestampColumnRT, logFieldColumnRT, log
 
 export const logEntryRT = rt.type({
   id: rt.string,
+  index: rt.string,
   cursor: logEntriesCursorRT,
   columns: rt.array(logColumnRT),
   context: rt.partial({

diff --git a/x-pack/plugins/infra/common/http_api/log_entries/item.ts b/x-pack/plugins/infra/common/http_api/log_entries/item.ts
@@ -12,6 +12,7 @@ export const LOG_ENTRIES_ITEM_PATH = '/api/log_entries/item';
 export const logEntriesItemRequestRT = rt.type({
   sourceId: rt.string,
   id: rt.string,
+  index: rt.string,
 });
 
 export type LogEntriesItemRequest = rt.TypeOf<typeof logEntriesItemRequestRT>;

diff --git a/x-pack/plugins/infra/public/components/logging/log_text_stream/log_entry_row.tsx b/x-pack/plugins/infra/public/components/logging/log_text_stream/log_entry_row.tsx
@@ -31,7 +31,7 @@ interface LogEntryRowProps {
   isActiveHighlight: boolean;
   isHighlighted: boolean;
   logEntry: LogEntry;
-  openFlyoutWithItem?: (id: string) => void;
+  openFlyoutWithItem?: (id: string, index: string) => void;
   scale: TextScale;
   wrap: boolean;
 }
@@ -58,9 +58,10 @@ export const LogEntryRow = memo(
     const setItemIsHovered = useCallback(() => setIsHovered(true), []);
     const setItemIsNotHovered = useCallback(() => setIsHovered(false), []);
 
-    const openFlyout = useCallback(() => openFlyoutWithItem?.(logEntry.id), [
+    const openFlyout = useCallback(() => openFlyoutWithItem?.(logEntry.id, logEntry.index), [
       openFlyoutWithItem,
       logEntry.id,
+      logEntry.index,
     ]);
 
     const logEntryColumnsById = useMemo(

diff --git a/...ugins/infra/public/components/logging/log_text_stream/scrollable_log_text_stream_view.tsx b/...ugins/infra/public/components/logging/log_text_stream/scrollable_log_text_stream_view.tsx
@@ -50,7 +50,7 @@ interface ScrollableLogTextStreamViewProps {
   }) => any;
   loadNewerItems: () => void;
   reloadItems: () => void;
-  setFlyoutItem: (id: string) => void;
+  setFlyoutRef: (ref: { id: string; index: string }) => void;
   setFlyoutVisibility: (visible: boolean) => void;
   highlightedItem: string | null;
   currentHighlightKey: UniqueTimeKey | null;
@@ -286,8 +286,8 @@ export class ScrollableLogTextStreamView extends React.PureComponent<
     );
   }
 
-  private handleOpenFlyout = (id: string) => {
-    this.props.setFlyoutItem(id);
+  private handleOpenFlyout = (id: string, index: string) => {
+    this.props.setFlyoutRef({ id, index });
     this.props.setFlyoutVisibility(true);
   };
 

diff --git a/x-pack/plugins/infra/public/containers/logs/log_entries/types.ts b/x-pack/plugins/infra/public/containers/logs/log_entries/types.ts
@@ -68,6 +68,8 @@ export interface InfraLogEntry {
   key: InfraTimeKey;
   /** The log entry's id */
   gid: string;
+  /** The log entry's index */
+  index: string;
   /** The source id */
   source: string;
   /** The columns used for rendering the log entry */

diff --git a/x-pack/plugins/infra/public/containers/logs/log_flyout.tsx b/x-pack/plugins/infra/public/containers/logs/log_flyout.tsx
@@ -21,25 +21,26 @@ export enum FlyoutVisibility {
 
 export interface FlyoutOptionsUrlState {
   flyoutId?: string | null;
+  flyoutIndex?: string | null;
   flyoutVisibility?: string | null;
   surroundingLogsId?: string | null;
 }
 
 export const useLogFlyout = () => {
   const { sourceId } = useContext(Source.Context);
   const [flyoutVisible, setFlyoutVisibility] = useState<boolean>(false);
-  const [flyoutId, setFlyoutId] = useState<string | null>(null);
+  const [flyoutRef, setFlyoutRef] = useState<{ id: string; index: string } | null>(null);
   const [flyoutItem, setFlyoutItem] = useState<LogEntriesItem | null>(null);
   const [surroundingLogsId, setSurroundingLogsId] = useState<string | null>(null);
 
   const [loadFlyoutItemRequest, loadFlyoutItem] = useTrackedPromise(
     {
       cancelPreviousOn: 'creation',
       createPromise: async () => {
-        if (!flyoutId) {
+        if (!flyoutRef) {
           return;
         }
-        return await fetchLogEntriesItem({ sourceId, id: flyoutId });
+        return await fetchLogEntriesItem({ sourceId, id: flyoutRef.id, index: flyoutRef.index });
       },
       onResolve: response => {
         if (response) {
@@ -48,24 +49,24 @@ export const useLogFlyout = () => {
         }
       },
     },
-    [sourceId, flyoutId]
+    [sourceId, flyoutRef]
   );
 
   const isLoading = useMemo(() => {
     return loadFlyoutItemRequest.state === 'pending';
   }, [loadFlyoutItemRequest.state]);
 
   useEffect(() => {
-    if (flyoutId) {
+    if (flyoutRef) {
       loadFlyoutItem();
     }
-  }, [loadFlyoutItem, flyoutId]);
+  }, [loadFlyoutItem, flyoutRef]);
 
   return {
     flyoutVisible,
     setFlyoutVisibility,
-    flyoutId,
-    setFlyoutId,
+    flyoutRef,
+    setFlyoutRef,
     surroundingLogsId,
     setSurroundingLogsId,
     isLoading,
@@ -79,8 +80,8 @@ export const WithFlyoutOptionsUrlState = () => {
   const {
     flyoutVisible,
     setFlyoutVisibility,
-    flyoutId,
-    setFlyoutId,
+    flyoutRef,
+    setFlyoutRef,
     surroundingLogsId,
     setSurroundingLogsId,
   } = useContext(LogFlyout.Context);
@@ -89,14 +90,15 @@ export const WithFlyoutOptionsUrlState = () => {
     <UrlStateContainer
       urlState={{
         flyoutVisibility: flyoutVisible ? FlyoutVisibility.visible : FlyoutVisibility.hidden,
-        flyoutId,
+        flyoutId: flyoutRef ? flyoutRef.id : null,
+        flyoutIndex: flyoutRef ? flyoutRef.index : null,
         surroundingLogsId,
       }}
       urlStateKey="flyoutOptions"
       mapToUrlState={mapToUrlState}
       onChange={newUrlState => {
-        if (newUrlState && newUrlState.flyoutId) {
-          setFlyoutId(newUrlState.flyoutId);
+        if (newUrlState && newUrlState.flyoutId && newUrlState.flyoutIndex) {
+          setFlyoutRef({ id: newUrlState.flyoutId, index: newUrlState.flyoutIndex });
         }
         if (newUrlState && newUrlState.surroundingLogsId) {
           setSurroundingLogsId(newUrlState.surroundingLogsId);
@@ -109,8 +111,8 @@ export const WithFlyoutOptionsUrlState = () => {
         }
       }}
       onInitialize={initialUrlState => {
-        if (initialUrlState && initialUrlState.flyoutId) {
-          setFlyoutId(initialUrlState.flyoutId);
+        if (initialUrlState && initialUrlState.flyoutId && initialUrlState.flyoutIndex) {
+          setFlyoutRef({ id: initialUrlState.flyoutId, index: initialUrlState.flyoutIndex });
         }
         if (initialUrlState && initialUrlState.surroundingLogsId) {
           setSurroundingLogsId(initialUrlState.surroundingLogsId);
@@ -130,6 +132,7 @@ const mapToUrlState = (value: any): FlyoutOptionsUrlState | undefined =>
   value
     ? {
         flyoutId: mapToFlyoutIdState(value.flyoutId),
+        flyoutIndex: mapToFlyoutIndexState(value.flyoutIndex),
         flyoutVisibility: mapToFlyoutVisibilityState(value.flyoutVisibility),
         surroundingLogsId: mapToSurroundingLogsIdState(value.surroundingLogsId),
       }
@@ -138,6 +141,9 @@ const mapToUrlState = (value: any): FlyoutOptionsUrlState | undefined =>
 const mapToFlyoutIdState = (subject: any) => {
   return subject && isString(subject) ? subject : undefined;
 };
+const mapToFlyoutIndexState = (subject: any) => {
+  return subject && isString(subject) ? subject : undefined;
+};
 const mapToSurroundingLogsIdState = (subject: any) => {
   return subject && isString(subject) ? subject : undefined;
 };

diff --git a/x-pack/plugins/infra/public/graphql/introspection.json b/x-pack/plugins/infra/public/graphql/introspection.json
@@ -1185,6 +1185,18 @@
             "isDeprecated": false,
             "deprecationReason": null
           },
+          {
+            "name": "index",
+            "description": "The log entry's index",
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": { "kind": "SCALAR", "name": "String", "ofType": null }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
           {
             "name": "source",
             "description": "The source id",

diff --git a/x-pack/plugins/infra/public/graphql/types.ts b/x-pack/plugins/infra/public/graphql/types.ts
@@ -161,6 +161,8 @@ export interface InfraLogEntry {
   key: InfraTimeKey;
   /** The log entry's id */
   gid: string;
+  /** The log entry's index */
+  index: string;
   /** The source id */
   source: string;
   /** The columns used for rendering the log entry */
@@ -995,6 +997,8 @@ export namespace InfraLogEntryFields {
 
     gid: string;
 
+    index: string;
+
     key: Key;
 
     columns: Columns[];
@@ -1064,6 +1068,8 @@ export namespace InfraLogEntryHighlightFields {
 
     gid: string;
 
+    index: string;
+
     key: Key;
 
     columns: Columns[];

diff --git a/x-pack/plugins/infra/public/pages/logs/stream/page_logs_content.tsx b/x-pack/plugins/infra/public/pages/logs/stream/page_logs_content.tsx
@@ -34,7 +34,7 @@ export const LogsPageLogsContent: React.FunctionComponent = () => {
   const {
     setFlyoutVisibility,
     flyoutVisible,
-    setFlyoutId,
+    setFlyoutRef,
     surroundingLogsId,
     setSurroundingLogsId,
     flyoutItem,
@@ -102,7 +102,7 @@ export const LogsPageLogsContent: React.FunctionComponent = () => {
               scale={textScale}
               target={targetPosition}
               wrap={textWrap}
-              setFlyoutItem={setFlyoutId}
+              setFlyoutRef={setFlyoutRef}
               setFlyoutVisibility={setFlyoutVisibility}
               highlightedItem={surroundingLogsId ? surroundingLogsId : null}
               currentHighlightKey={currentHighlightKey}

diff --git a/x-pack/plugins/infra/server/graphql/types.ts b/x-pack/plugins/infra/server/graphql/types.ts
@@ -187,6 +187,8 @@ export interface InfraLogEntry {
   key: InfraTimeKey;
   /** The log entry's id */
   gid: string;
+  /** The log entry's index */
+  index: string;
   /** The source id */
   source: string;
   /** The columns used for rendering the log entry */
@@ -1137,6 +1139,8 @@ export namespace InfraLogEntryResolvers {
     key?: KeyResolver<InfraTimeKey, TypeParent, Context>;
     /** The log entry's id */
     gid?: GidResolver<string, TypeParent, Context>;
+    /** The log entry's index */
+    index?: IndexResolver<string, TypeParent, Context>;
     /** The source id */
     source?: SourceResolver<string, TypeParent, Context>;
     /** The columns used for rendering the log entry */
@@ -1153,6 +1157,11 @@ export namespace InfraLogEntryResolvers {
     Parent,
     Context
   >;
+  export type IndexResolver<R = string, Parent = InfraLogEntry, Context = InfraContext> = Resolver<
+    R,
+    Parent,
+    Context
+  >;
   export type SourceResolver<R = string, Parent = InfraLogEntry, Context = InfraContext> = Resolver<
     R,
     Parent,

diff --git a/x-pack/plugins/infra/server/lib/adapters/log_entries/kibana_log_entries_adapter.ts b/x-pack/plugins/infra/server/lib/adapters/log_entries/kibana_log_entries_adapter.ts
@@ -195,13 +195,14 @@ export class InfraKibanaLogEntriesAdapter implements LogEntriesAdapter {
   public async getLogItem(
     requestContext: RequestHandlerContext,
     id: string,
+    index: string,
     sourceConfiguration: InfraSourceConfiguration
   ) {
     const search = (searchOptions: object) =>
       this.framework.callWithRequest<LogItemHit, {}>(requestContext, 'search', searchOptions);
 
     const params = {
-      index: sourceConfiguration.logAlias,
+      index,
       terminate_after: 1,
       body: {
         size: 1,
@@ -240,6 +241,7 @@ function mapHitsToLogEntryDocuments(hits: SortedSearchHit[], fields: string[]):
 
     return {
       id: hit._id,
+      index: hit._index,
       cursor: { time: hit.sort[0], tiebreaker: hit.sort[1] },
       fields: logFields,
       highlights: hit.highlight || {},

diff --git a/x-pack/plugins/infra/server/lib/domains/log_entries_domain/log_entries_domain.ts b/x-pack/plugins/infra/server/lib/domains/log_entries_domain/log_entries_domain.ts
@@ -242,9 +242,10 @@ export class InfraLogEntriesDomain {
   public async getLogItem(
     requestContext: RequestHandlerContext,
     id: string,
+    index: string,
     sourceConfiguration: InfraSourceConfiguration
   ): Promise<LogEntriesItem> {
-    const document = await this.adapter.getLogItem(requestContext, id, sourceConfiguration);
+    const document = await this.adapter.getLogItem(requestContext, id, index, sourceConfiguration);
     const defaultFields = [
       { field: '_index', value: document._index },
       { field: '_id', value: document._id },
@@ -292,6 +293,7 @@ export interface LogEntriesAdapter {
   getLogItem(
     requestContext: RequestHandlerContext,
     id: string,
+    index: string,
     source: InfraSourceConfiguration
   ): Promise<LogItemHit>;
 }
@@ -300,6 +302,7 @@ export type LogEntryQuery = JsonObject;
 
 export interface LogEntryDocument {
   id: string;
+  index: string;
   fields: Fields;
   highlights: Highlights;
   cursor: LogEntriesCursor;

diff --git a/x-pack/plugins/infra/server/routes/log_entries/item.ts b/x-pack/plugins/infra/server/routes/log_entries/item.ts
@@ -36,11 +36,16 @@ export const initLogEntriesItemRoute = ({ framework, sources, logEntries }: Infr
           fold(throwErrors(Boom.badRequest), identity)
         );
 
-        const { id, sourceId } = payload;
+        const { id, index, sourceId } = payload;
         const sourceConfiguration = (await sources.getSourceConfiguration(requestContext, sourceId))
           .configuration;
 
-        const logEntry = await logEntries.getLogItem(requestContext, id, sourceConfiguration);
+        const logEntry = await logEntries.getLogItem(
+          requestContext,
+          id,
+          index,
+          sourceConfiguration
+        );
 
         return response.ok({
           body: logEntriesItemResponseRT.encode({
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,6 +24,7 @@ export const sharedFragments = { @@
       InfraLogEntryFields: gql`
         fragment InfraLogEntryFields on InfraLogEntry {
           gid
+          index
           key {
             time
             tiebreaker
@@ Expand Down @@