[7.17] [TSVB] Fix shard failures are not reported (#123474)

src/plugins/data/public/index.ts

@@ -203,6 +203,7 @@ export {
   isEsError,
   SearchSessionState,
   SortDirection,
+  handleResponse,
 } from './search';
 
 export type {

src/plugins/data/public/search/index.ts

@@ -52,6 +52,7 @@ export {
   waitUntilNextSessionCompletes$,
 } from './session';
 export { getEsPreference } from './es_search';
+export { handleResponse } from './fetch';
 
 export type { SearchInterceptorDeps } from './search_interceptor';
 export { SearchInterceptor } from './search_interceptor';

src/plugins/inspector/common/adapters/request/request_responder.ts

@@ -51,7 +51,7 @@ export class RequestResponder {
   }
 
   public finish(status: RequestStatus, response: Response): void {
-    this.request.time = Date.now() - this.request.startTime;
+    this.request.time = response.time ?? Date.now() - this.request.startTime;
     this.request.status = status;
     this.request.response = response;
     this.onChange();

src/plugins/inspector/common/adapters/request/types.ts

@@ -53,4 +53,5 @@ export interface RequestStatistic {
 
 export interface Response {
   json?: object;
+  time?: number;
 }

src/plugins/kibana_usage_collection/server/collectors/management/schema.ts

@@ -288,6 +288,10 @@ export const stackManagementSchema: MakeSchemaFrom<UsageStats> = {
     type: 'long',
     _meta: { description: 'Non-default value of setting.' },
   },
+  'metrics:allowCheckingForFailedShards': {
+    type: 'boolean',
+    _meta: { description: 'Non-default value of setting.' },
+  },
   'query:allowLeadingWildcards': {
     type: 'boolean',
     _meta: { description: 'Non-default value of setting.' },

src/plugins/kibana_usage_collection/server/collectors/management/types.ts

@@ -95,6 +95,7 @@ export interface UsageStats {
   'savedObjects:listingLimit': number;
   'query:queryString:options': string;
   'metrics:max_buckets': number;
+  'metrics:allowCheckingForFailedShards': boolean;
   'query:allowLeadingWildcards': boolean;
   metaFields: string[];
   'indexPattern:placeholder': string;

src/plugins/telemetry/schema/oss_plugins.json

@@ -7577,6 +7577,12 @@
             "description": "Non-default value of setting."
           }
         },
+        "metrics:allowCheckingForFailedShards": {
+          "type": "boolean",
+          "_meta": {
+            "description": "Non-default value of setting."
+          }
+        },
         "query:allowLeadingWildcards": {
           "type": "boolean",
           "_meta": {

src/plugins/vis_types/timeseries/common/constants.ts

@@ -7,6 +7,7 @@
  */
 
 export const MAX_BUCKETS_SETTING = 'metrics:max_buckets';
+export const ALLOW_CHECKING_FOR_FAILED_SHARDS = 'metrics:allowCheckingForFailedShards';
 export const INDEXES_SEPARATOR = ',';
 export const AUTO_INTERVAL = 'auto';
 export const ROUTES = {

src/plugins/vis_types/timeseries/common/types/index.ts

@@ -10,7 +10,15 @@ import { Filter, IndexPattern, Query } from '../../../../data/common';
 import { Panel } from './panel_model';
 
 export type { Metric, Series, Panel, MetricType } from './panel_model';
-export type { TimeseriesVisData, PanelData, SeriesData, TableData } from './vis_data';
+export type {
+  TimeseriesVisData,
+  PanelData,
+  SeriesData,
+  TableData,
+  DataResponseMeta,
+  TrackedEsSearches,
+  PanelSeries,
+} from './vis_data';
 
 export interface FetchedIndexPattern {
   indexPattern: IndexPattern | undefined | null;

src/plugins/vis_types/timeseries/common/types/vis_data.ts

@@ -7,30 +7,38 @@
  */
 
 import { PANEL_TYPES } from '../enums';
-import { TimeseriesUIRestrictions } from '../ui_restrictions';
+import type { TimeseriesUIRestrictions } from '../ui_restrictions';
 
 export type TimeseriesVisData = SeriesData | TableData;
 
-export interface TableData {
-  type: PANEL_TYPES.TABLE;
+export type TrackedEsSearches = Record<
+  string,
+  {
+    body: Record<string, any>;
+    label?: string;
+    time: number;
+    response?: Record<string, any>;
+  }
+>;
+
+export interface DataResponseMeta {
+  type: PANEL_TYPES;
   uiRestrictions: TimeseriesUIRestrictions;
+  trackedEsSearches: TrackedEsSearches;
+}
+
+export interface TableData extends DataResponseMeta {
   series?: PanelData[];
   pivot_label?: string;
 }
 
 // series data is not fully typed yet
-export type SeriesData = {
-  type: Exclude<PANEL_TYPES, PANEL_TYPES.TABLE>;
-  uiRestrictions: TimeseriesUIRestrictions;
+export type SeriesData = DataResponseMeta & {
   error?: string;
-} & {
-  [key: string]: PanelSeries;
-};
+} & Record<string, PanelSeries>;
 
 export interface PanelSeries {
-  annotations: {
-    [key: string]: Annotation[];
-  };
+  annotations: Record<string, Annotation[]>;
   id: string;
   series: PanelData[];
   error?: string;

src/plugins/vis_types/timeseries/kibana.json

@@ -4,7 +4,7 @@
   "kibanaVersion": "kibana",
   "server": true,
   "ui": true,
-  "requiredPlugins": ["charts", "data", "expressions", "visualizations", "visualize"],
+  "requiredPlugins": ["charts", "data", "expressions", "visualizations", "visualize", "inspector"],
   "optionalPlugins": ["usageCollection"],
   "requiredBundles": ["kibanaUtils", "kibanaReact", "fieldFormats"],
   "owner": {

src/plugins/vis_types/timeseries/public/application/components/annotation_row.tsx

@@ -80,7 +80,9 @@ export const AnnotationRow = ({
 
       try {
         fetchedIndexPattern = index
-          ? await fetchIndexPattern(index, indexPatterns)
+          ? await fetchIndexPattern(index, indexPatterns, {
+              fetchKibanaIndexForStringIndexes: true,
+            })
           : {
               ...fetchedIndexPattern,
               defaultIndex: await indexPatterns.getDefault(),

src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/field_text_select.tsx

@@ -37,7 +37,7 @@ export const FieldTextSelect = ({
 
   useDebounce(
     () => {
-      if (inputValue !== indexPatternString) {
+      if ((inputValue ?? '') !== (indexPatternString ?? '')) {
         onIndexChange(inputValue);
       }
     },

src/plugins/vis_types/timeseries/public/application/components/lib/index_pattern_select/index_pattern_select.tsx

@@ -108,7 +108,7 @@ export const IndexPatternSelect = ({
         defaultIndexPatternHelpText + (!useKibanaIndices ? queryAllIndexesHelpText : '')
       }
       labelAppend={
-        fetchedIndex.indexPatternString && !fetchedIndex.indexPattern ? (
+        !useKibanaIndices && fetchedIndex.indexPatternString && !fetchedIndex.indexPattern ? (
           <EuiLink onClick={navigateToCreateIndexPatternPage}>
             <EuiText size="xs">
               <FormattedMessage

src/plugins/vis_types/timeseries/public/metrics_fn.ts

@@ -54,7 +54,11 @@ export const createMetricsFn = (): TimeseriesExpressionFunctionDefinition => ({
       help: '',
     },
   },
-  async fn(input, args, { getSearchSessionId, isSyncColorsEnabled, getExecutionContext }) {
+  async fn(
+    input,
+    args,
+    { getSearchSessionId, isSyncColorsEnabled, getExecutionContext, inspectorAdapters }
+  ) {
     const visParams: TimeseriesVisParams = JSON.parse(args.params);
     const uiState = JSON.parse(args.uiState);
     const syncColors = isSyncColorsEnabled?.() ?? false;
@@ -65,6 +69,7 @@ export const createMetricsFn = (): TimeseriesExpressionFunctionDefinition => ({
       uiState,
       searchSessionId: getSearchSessionId(),
       executionContext: getExecutionContext(),
+      inspectorAdapters,
     });
 
     return {

src/plugins/vis_types/timeseries/public/metrics_type.ts

@@ -22,6 +22,7 @@ import {
 } from '../../../visualizations/public';
 import { getDataStart } from './services';
 import type { TimeseriesVisDefaultParams, TimeseriesVisParams } from './types';
+import { RequestAdapter } from '../../../inspector/public';
 
 export const withReplacedIds = (
   vis: Vis<TimeseriesVisParams | TimeseriesVisDefaultParams>
@@ -118,7 +119,9 @@ export const metricsVisDefinition: VisTypeDefinition<
     }
     return [];
   },
-  inspectorAdapters: {},
+  inspectorAdapters: () => ({
+    requests: new RequestAdapter(),
+  }),
   requiresSearch: true,
   getUsedIndexPattern: async (params: VisParams) => {
     const { indexPatterns } = getDataStart();

src/plugins/vis_types/timeseries/public/request_handler.ts

@@ -6,20 +6,22 @@
  * Side Public License, v 1.
  */
 import type { KibanaExecutionContext } from 'src/core/public';
+import type { Adapters } from 'src/plugins/inspector';
 import { getTimezone } from './application/lib/get_timezone';
 import { getUISettings, getDataStart, getCoreStart } from './services';
-import { ROUTES } from '../common/constants';
+import { ROUTES, ALLOW_CHECKING_FOR_FAILED_SHARDS } from '../common/constants';
+import { KibanaContext, handleResponse } from '../../../data/public';
 
 import type { TimeseriesVisParams } from './types';
 import type { TimeseriesVisData } from '../common/types';
-import type { KibanaContext } from '../../../data/public';
 
 interface MetricsRequestHandlerParams {
   input: KibanaContext | null;
   uiState: Record<string, any>;
   visParams: TimeseriesVisParams;
   searchSessionId?: string;
   executionContext?: KibanaExecutionContext;
+  inspectorAdapters?: Adapters;
 }
 
 export const metricsRequestHandler = async ({
@@ -28,6 +30,7 @@ export const metricsRequestHandler = async ({
   visParams,
   searchSessionId,
   executionContext,
+  inspectorAdapters,
 }: MetricsRequestHandlerParams): Promise<TimeseriesVisData | {}> => {
   const config = getUISettings();
   const data = getDataStart();
@@ -48,7 +51,8 @@ export const metricsRequestHandler = async ({
 
     try {
       const searchSessionOptions = dataSearch.session.getSearchOptions(searchSessionId);
-      return await getCoreStart().http.post(ROUTES.VIS_DATA, {
+
+      const visData: TimeseriesVisData = await getCoreStart().http.post(ROUTES.VIS_DATA, {
         body: JSON.stringify({
           timerange: {
             timezone,
@@ -64,6 +68,21 @@ export const metricsRequestHandler = async ({
         }),
         context: executionContext,
       });
+
+      inspectorAdapters?.requests?.reset();
+
+      Object.entries(visData.trackedEsSearches || {}).forEach(([key, query]) => {
+        inspectorAdapters?.requests
+          ?.start(query.label ?? key, { searchSessionId })
+          .json(query.body)
+          .ok({ time: query.time });
+
+        if (query.response && config.get(ALLOW_CHECKING_FOR_FAILED_SHARDS)) {
+          handleResponse({ body: query.body }, { rawResponse: query.response });
+        }
+      });
+
+      return visData;
     } finally {
       if (untrackSearch && dataSearch.session.isCurrentSession(searchSessionId)) {
         // untrack if this search still belongs to current session

src/plugins/vis_types/timeseries/server/lib/search_strategies/index.ts

@@ -11,6 +11,7 @@ import { AbstractSearchStrategy } from './strategies';
 
 export { SearchStrategyRegistry } from './search_strategy_registry';
 export { AbstractSearchStrategy, RollupSearchStrategy, DefaultSearchStrategy } from './strategies';
+export type { EsSearchRequest } from './strategies/abstract_search_strategy';
 
 export type SearchCapabilities = DefaultSearchCapabilities;
 export type SearchStrategy = AbstractSearchStrategy;

src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts

@@ -9,7 +9,7 @@
 import { IndexPatternsService } from '../../../../../../data/common';
 
 import { from } from 'rxjs';
-import { AbstractSearchStrategy } from './abstract_search_strategy';
+import { AbstractSearchStrategy, EsSearchRequest } from './abstract_search_strategy';
 import type { FieldSpec } from '../../../../../../data/common';
 import type { CachedIndexPatternFetcher } from '../lib/cached_index_pattern_fetcher';
 import type {
@@ -64,7 +64,7 @@ describe('AbstractSearchStrategy', () => {
   });
 
   test('should return response', async () => {
-    const searches = [{ body: 'body', index: 'index' }];
+    const searches: EsSearchRequest[] = [{ body: {}, index: 'index' }];
 
     const responses = await abstractSearchStrategy.search(
       requestContext,
@@ -84,7 +84,7 @@ describe('AbstractSearchStrategy', () => {
     expect(requestContext.search.search).toHaveBeenCalledWith(
       {
         params: {
-          body: 'body',
+          body: {},
           index: 'index',
         },
         indexType: undefined,

src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts

@@ -6,40 +6,67 @@
  * Side Public License, v 1.
  */
 
+import { tap } from 'rxjs/operators';
+import { omit } from 'lodash';
 import { IndexPatternsService } from '../../../../../../data/server';
 import { toSanitizedFieldType } from '../../../../common/fields_utils';
 
-import type { FetchedIndexPattern } from '../../../../common/types';
+import type { FetchedIndexPattern, TrackedEsSearches } from '../../../../common/types';
 import type {
   VisTypeTimeseriesRequest,
   VisTypeTimeseriesRequestHandlerContext,
   VisTypeTimeseriesVisDataRequest,
 } from '../../../types';
 
+export interface EsSearchRequest {
+  body: Record<string, any>;
+  index?: string;
+  trackingEsSearchMeta?: {
+    requestId: string;
+    requestLabel?: string;
+  };
+}
+
 export abstract class AbstractSearchStrategy {
   async search(
     requestContext: VisTypeTimeseriesRequestHandlerContext,
     req: VisTypeTimeseriesVisDataRequest,
-    bodies: any[],
+    esRequests: EsSearchRequest[],
+    trackedEsSearches?: TrackedEsSearches,
     indexType?: string
   ) {
     const requests: any[] = [];
 
-    bodies.forEach((body) => {
+    esRequests.forEach(({ body, index, trackingEsSearchMeta }) => {
+      const startTime = Date.now();
       requests.push(
         requestContext.search
           .search(
             {
               indexType,
               params: {
-                ...body,
+                body,
+                index,
               },
             },
             req.body.searchSession
           )
+          .pipe(
+            tap((data) => {
+              if (trackingEsSearchMeta?.requestId && trackedEsSearches) {
+                trackedEsSearches[trackingEsSearchMeta.requestId] = {
+                  body,
+                  time: Date.now() - startTime,
+                  label: trackingEsSearchMeta.requestLabel,
+                  response: omit(data.rawResponse, 'aggregations'),
+                };
+              }
+            })
+          )
           .toPromise()
       );
     });
+
     return Promise.all(requests);
   }