Add search result statistics on the main search screen

changelog/unreleased/issue-7386.toml

@@ -0,0 +1,5 @@
+type = "a"
+message = "Add search result statistics on the main search screen and execution info popover to each dashboard widget"
+
+pulls = ["16130"]
+issues=["7386"]

graylog2-web-interface/src/views/components/sidebar/Sidebar.test.tsx

@@ -70,7 +70,7 @@ describe('<Sidebar />', () => {
   };
   const errors = [];
   const executionStats = { effective_timerange: effectiveTimerange, duration, timestamp };
-  const searchTypes = {};
+  const searchTypes = { 'search-type-id': { total: 12345, type: 'generic' } };
   const queryResult = new QueryResult({ execution_stats: executionStats, query, errors, search_types: searchTypes });
 
   const openDescriptionSection = async () => fireEvent.click(await screen.findByRole('button', { name: /description/i }));
@@ -171,15 +171,17 @@ describe('<Sidebar />', () => {
 
     await screen.findByText('2018-08-28 16:34:26.192');
     await screen.findByText('2018-08-28 16:39:26.192');
+    await screen.findByText(/total results *12,345/i);
   });
 
-  it('should not render the effective search execution time range for dashboards without global override', async () => {
+  it('should not render the effective search execution time range and total result for dashboards without global override', async () => {
     asMock(useViewType).mockReturnValue(View.Type.Dashboard);
     renderSidebar();
 
     fireEvent.click(await screen.findByRole('button', { name: /description/i }));
 
-    await screen.findByText('Varies per widget');
+    await screen.findByText((_content, node) => (node.textContent === 'Effective time rangeVaries per widget'));
+    await screen.findByText((_content, node) => (node.textContent === 'Total resultsVaries per widget'));
   });
 
   it('should render the effective search execution time range for dashboards with global override', async () => {

graylog2-web-interface/src/views/components/sidebar/description/SearchResultOverview.tsx

@@ -21,10 +21,10 @@ import isEmpty from 'lodash/isEmpty';
 import styled from 'styled-components';
 
 import { Timestamp } from 'components/common';
-import type { AbsoluteTimeRange } from 'views/logic/queries/Query';
 import useGlobalOverride from 'views/hooks/useGlobalOverride';
 import useViewType from 'views/hooks/useViewType';
 import View from 'views/logic/views/View';
+import type QueryResult from 'views/logic/QueryResult';
 
 const EffectiveTimeRange = styled.div`
   margin-bottom: 10px;
@@ -39,11 +39,7 @@ const EffectiveTimeRangeTable = styled.table`
 `;
 
 type Props = {
-  results: {
-    timestamp?: string,
-    duration?: number,
-    effectiveTimerange: AbsoluteTimeRange
-  },
+  results: QueryResult,
 };
 
 const SearchResultOverview = ({ results }: Props) => {
@@ -54,7 +50,9 @@ const SearchResultOverview = ({ results }: Props) => {
     return <i>No query executed yet.</i>;
   }
 
-  const { timestamp, duration, effectiveTimerange } = results;
+  const { timestamp, duration, effectiveTimerange, searchTypes } = results;
+  const total = searchTypes && Object.values(searchTypes)?.[0]?.total;
+  const isVariesPerWidget = (viewType === View.Type.Dashboard && !globalOverrideTimeRange);
 
   return (
     <>
@@ -64,22 +62,26 @@ const SearchResultOverview = ({ results }: Props) => {
       </p>
       <EffectiveTimeRange>
         Effective time range<br />
-        {(viewType === View.Type.Dashboard && !globalOverrideTimeRange) ? <i>Varies per widget</i>
+        {isVariesPerWidget ? <i>Varies per widget</i>
           : (
             <EffectiveTimeRangeTable>
               <tbody>
                 <tr>
                   <td>From</td>
-                  <td><Timestamp dateTime={effectiveTimerange.from} format="complete" /></td>
+                  <td aria-label="Effective time range from"><Timestamp dateTime={effectiveTimerange.from} format="complete" /></td>
                 </tr>
                 <tr>
                   <td>To</td>
-                  <td><Timestamp dateTime={effectiveTimerange.to} format="complete" /></td>
+                  <td aria-label="Effective time range to"><Timestamp dateTime={effectiveTimerange.to} format="complete" /></td>
                 </tr>
               </tbody>
             </EffectiveTimeRangeTable>
           )}
       </EffectiveTimeRange>
+      <p>
+        Total results<br />
+        {isVariesPerWidget ? <i>Varies per widget</i> : numeral(total).format('0,0')}
+      </p>
     </>
   );
 };

graylog2-web-interface/src/views/components/views/ExecutionInfo.tsx

@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2020 Graylog, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Server Side Public License, version 1,
+ * as published by MongoDB, Inc.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Server Side Public License for more details.
+ *
+ * You should have received a copy of the Server Side Public License
+ * along with this program. If not, see
+ * <http://www.mongodb.com/licensing/server-side-public-license>.
+ */
+import React from 'react';
+import numeral from 'numeral';
+import isEmpty from 'lodash/isEmpty';
+
+import useAppSelector from 'stores/useAppSelector';
+import { selectCurrentQueryResults } from 'views/logic/slices/viewSelectors';
+import { Timestamp } from 'components/common';
+
+const ExecutionInfo = () => {
+  const result = useAppSelector(selectCurrentQueryResults);
+  const total = result?.searchTypes && Object.values(result?.searchTypes)?.[0]?.total;
+
+  if (isEmpty(result)) {
+    return <i>No query executed yet.</i>;
+  }
+
+  return (
+    <i>
+      Query executed in{' '}
+      {numeral(result?.duration).format('0,0')}ms at <Timestamp dateTime={result?.timestamp} />
+      {' '}Total results: {numeral(total).format('0,0')}
+    </i>
+  );
+};
+
+export default ExecutionInfo;

graylog2-web-interface/src/views/components/views/ViewHeader.tsx

@@ -33,6 +33,7 @@ import useAlertAndEventDefinitionData from 'hooks/useAlertAndEventDefinitionData
 import { updateView } from 'views/logic/slices/viewSlice';
 import useIsNew from 'views/hooks/useIsNew';
 import { createGRN } from 'logic/permissions/GRN';
+import ExecutionInfo from 'views/components/views/ExecutionInfo';
 
 const links = {
   [View.Type.Dashboard]: ({ id, title }) => [{
@@ -84,6 +85,10 @@ const Content = styled.div(({ theme }) => css`
   gap: 4px;
 `);
 
+const ExecutionInfoContainer = styled.div`
+  margin-left: auto;
+`;
+
 const EditButton = styled.div(({ theme }) => css`
   color: ${theme.colors.gray[60]};
   font-size: ${theme.fonts.size.tiny};
@@ -141,6 +146,8 @@ const ViewHeader = () => {
     return links[view.type]({ id: view.id, title });
   }, [alertId, definitionId, definitionTitle, isAlert, isEvent, isEventDefinition, view, title]);
 
+  const showExecutionInfo = view.type === 'SEARCH';
+
   return (
     <Row>
       <Content>
@@ -175,6 +182,7 @@ const ViewHeader = () => {
                              onSave={_onSaveView}
                              submitButtonText={`Save ${typeText}`} />
         )}
+        {showExecutionInfo && <ExecutionInfoContainer><ExecutionInfo /></ExecutionInfoContainer>}
       </Content>
     </Row>
   );

graylog2-web-interface/src/views/components/widgets/SearchQueryExecutionInfoHelper.tsx

@@ -0,0 +1,118 @@
+/*
+ * Copyright (C) 2020 Graylog, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Server Side Public License, version 1,
+ * as published by MongoDB, Inc.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Server Side Public License for more details.
+ *
+ * You should have received a copy of the Server Side Public License
+ * along with this program. If not, see
+ * <http://www.mongodb.com/licensing/server-side-public-license>.
+ */
+import * as React from 'react';
+import styled from 'styled-components';
+import type { PropsWithChildren } from 'react';
+import { useCallback, useMemo, useState } from 'react';
+import numeral from 'numeral';
+import isEmpty from 'lodash/isEmpty';
+
+import { Timestamp } from 'components/common';
+import { Table } from 'components/bootstrap';
+import useAppSelector from 'stores/useAppSelector';
+import { selectCurrentQueryResults } from 'views/logic/slices/viewSelectors';
+import type { MessageResult, SearchTypeResult, SearchTypeResultTypes } from 'views/types';
+import type { SearchTypeIds } from 'views/logic/views/types';
+import Popover from 'components/common/Popover';
+
+type Props = PropsWithChildren & {
+  currentWidgetMapping: SearchTypeIds,
+};
+
+const TargetContainer = styled.div`
+  cursor: pointer;
+`;
+
+const StyledTable = styled(Table)`
+  margin-bottom: 0
+`;
+
+type WidgetExecutionData = {
+  total: number,
+  duration: number,
+  timestamp: string,
+  effectiveTimerange: SearchTypeResult['effective_timerange'] | MessageResult['effectiveTimerange']
+}
+
+const HelpPopover = ({ widgetExecutionData }: { widgetExecutionData: WidgetExecutionData}) => (
+  <StyledTable condensed>
+    <tbody>
+      <tr>
+        <td><i>Executed at:</i></td>
+        <td aria-label="Executed at"><Timestamp dateTime={widgetExecutionData?.timestamp} /></td>
+      </tr>
+      <tr>
+        <td><i>Executed in:</i> </td>
+        <td>{numeral(widgetExecutionData?.duration).format('0,0')}ms</td>
+      </tr>
+      <tr>
+        <td colSpan={2}><i>Effective time range:</i></td>
+      </tr>
+      <tr>
+        <td>From</td>
+        <td aria-label="Effective time range from"><Timestamp dateTime={widgetExecutionData?.effectiveTimerange?.from} format="complete" /></td>
+      </tr>
+      <tr>
+        <td>To</td>
+        <td aria-label="Effective time range to"><Timestamp dateTime={widgetExecutionData?.effectiveTimerange?.to} format="complete" /></td>
+      </tr>
+      <tr>
+        <td><i>Total results:</i></td>
+        <td>{numeral(widgetExecutionData?.total).format('0,0')}</td>
+      </tr>
+    </tbody>
+  </StyledTable>
+);
+
+const SearchQueryExecutionInfoHelper = ({ currentWidgetMapping, children }: Props) => {
+  const [open, setOpen] = useState(false);
+  const result = useAppSelector(selectCurrentQueryResults);
+  const currentWidgetSearchType = useMemo<SearchTypeResultTypes[keyof SearchTypeResultTypes]>(() => {
+    const searchTypeId = currentWidgetMapping?.toJS()?.[0];
+
+    return result?.searchTypes?.[searchTypeId];
+  }, [currentWidgetMapping, result?.searchTypes]);
+
+  const widgetExecutionData = useMemo<WidgetExecutionData>(() => ({
+    effectiveTimerange: (currentWidgetSearchType as MessageResult)?.effectiveTimerange || (currentWidgetSearchType as SearchTypeResult)?.effective_timerange,
+    total: currentWidgetSearchType?.total,
+    duration: result?.duration,
+    timestamp: result?.timestamp,
+
+  }), [currentWidgetSearchType, result?.duration, result?.timestamp]);
+
+  const onClose = useCallback(() => {
+    setOpen(false);
+  }, []);
+
+  const onToggle = useCallback(() => {
+    setOpen((cur) => !cur);
+  }, []);
+
+  return (
+    <Popover position="bottom" opened={open} onClose={onClose} closeOnClickOutside>
+      <Popover.Target>
+        <TargetContainer role="presentation" onClick={onToggle}>{children}</TargetContainer>
+      </Popover.Target>
+      <Popover.Dropdown title="Execution Info">
+        {isEmpty(result) ? <i>No query executed yet.</i> : <HelpPopover widgetExecutionData={widgetExecutionData} />}
+      </Popover.Dropdown>
+    </Popover>
+  );
+};
+
+export default SearchQueryExecutionInfoHelper;

graylog2-web-interface/src/views/components/widgets/TimerangeInfo.tsx

@@ -17,14 +17,15 @@
 import * as React from 'react';
 import styled, { css } from 'styled-components';
 
-import { TextOverflowEllipsis } from 'components/common';
+import { Icon, TextOverflowEllipsis } from 'components/common';
 import type Widget from 'views/logic/widgets/Widget';
 import timerangeToString from 'views/logic/queries/TimeRangeToString';
 import { DEFAULT_TIMERANGE } from 'views/Constants';
 import useUserDateTime from 'hooks/useUserDateTime';
 import type { DateTime } from 'util/DateTime';
 import useGlobalOverride from 'views/hooks/useGlobalOverride';
 import useSearchResult from 'views/hooks/useSearchResult';
+import SearchQueryExecutionInfoHelper from 'views/components/widgets/SearchQueryExecutionInfoHelper';
 
 type Props = {
   className?: string,
@@ -37,6 +38,9 @@ const Wrapper = styled.div(({ theme }) => css`
   font-size: ${theme.fonts.size.tiny};
   color: ${theme.colors.gray[30]};
   width: max-content;
+  display: flex;
+  gap: 5px;
+  align-items: center;
 `);
 
 const getEffectiveWidgetTimerange = (result, activeQuery, searchTypeId) => result?.results?.[activeQuery]?.searchTypes[searchTypeId]?.effective_timerange;
@@ -58,12 +62,17 @@ const TimerangeInfo = ({ className, widget, activeQuery, widgetId }: Props) => {
   const effectiveTimerange = (activeQuery && searchTypeId) ? getEffectiveWidgetTimerange(result, activeQuery, searchTypeId) : undefined;
   const effectiveTimerangeString = effectiveTimerange ? timerangeToString(effectiveTimerange, toInternalTime) : 'Effective widget time range is currently not available.';
 
+  const currentWidgetMapping = widgetMapping?.get(widgetId);
+
   return (
-    <Wrapper className={className}>
-      <TextOverflowEllipsis titleOverride={effectiveTimerangeString}>
-        {globalTimerangeString || configuredTimerange}
-      </TextOverflowEllipsis>
-    </Wrapper>
+    <SearchQueryExecutionInfoHelper currentWidgetMapping={currentWidgetMapping}>
+      <Wrapper className={className}>
+        <TextOverflowEllipsis titleOverride={effectiveTimerangeString}>
+          {globalTimerangeString || configuredTimerange}
+        </TextOverflowEllipsis>
+        <Icon name="question-circle" />
+      </Wrapper>
+    </SearchQueryExecutionInfoHelper>
   );
 };
 

graylog2-web-interface/src/views/types.ts

@@ -202,7 +202,8 @@ export interface SystemConfiguration {
 
 export type SearchTypeResult = {
   type: string,
-  effective_timerange: TimeRange,
+  effective_timerange: AbsoluteTimeRange,
+  total: number,
 };
 
 export type MessageResult = {