Support Histogram Data Type

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.es_field_types.md

@@ -30,6 +30,7 @@ export declare enum ES_FIELD_TYPES
 |  GEO\_POINT | <code>&quot;geo_point&quot;</code> |  |
 |  GEO\_SHAPE | <code>&quot;geo_shape&quot;</code> |  |
 |  HALF\_FLOAT | <code>&quot;half_float&quot;</code> |  |
+|  HISTOGRAM | <code>&quot;histogram&quot;</code> |  |
 |  INTEGER | <code>&quot;integer&quot;</code> |  |
 |  IP | <code>&quot;ip&quot;</code> |  |
 |  KEYWORD | <code>&quot;keyword&quot;</code> |  |

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldtype.filterabletype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) &gt; [filterableType](./kibana-plugin-plugins-data-public.ifieldtype.filterabletype.md)
+
+## IFieldType.filterableType property
+
+<b>Signature:</b>
+
+```typescript
+filterableType?: KBN_FILTERABLE_TYPE;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldtype.md

@@ -19,6 +19,7 @@ export interface IFieldType
 |  [displayName](./kibana-plugin-plugins-data-public.ifieldtype.displayname.md) | <code>string</code> |  |
 |  [esTypes](./kibana-plugin-plugins-data-public.ifieldtype.estypes.md) | <code>string[]</code> |  |
 |  [filterable](./kibana-plugin-plugins-data-public.ifieldtype.filterable.md) | <code>boolean</code> |  |
+|  [filterableType](./kibana-plugin-plugins-data-public.ifieldtype.filterabletype.md) | <code>KBN_FILTERABLE_TYPE</code> |  |
 |  [format](./kibana-plugin-plugins-data-public.ifieldtype.format.md) | <code>any</code> |  |
 |  [lang](./kibana-plugin-plugins-data-public.ifieldtype.lang.md) | <code>string</code> |  |
 |  [name](./kibana-plugin-plugins-data-public.ifieldtype.name.md) | <code>string</code> |  |

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.filterabletype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPatternField](./kibana-plugin-plugins-data-public.indexpatternfield.md) &gt; [filterableType](./kibana-plugin-plugins-data-public.indexpatternfield.filterabletype.md)
+
+## IndexPatternField.filterableType property
+
+<b>Signature:</b>
+
+```typescript
+filterableType?: KBN_FILTERABLE_TYPE;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md

@@ -26,6 +26,7 @@ export declare class Field implements IFieldType
 |  [displayName](./kibana-plugin-plugins-data-public.indexpatternfield.displayname.md) |  | <code>string</code> |  |
 |  [esTypes](./kibana-plugin-plugins-data-public.indexpatternfield.estypes.md) |  | <code>string[]</code> |  |
 |  [filterable](./kibana-plugin-plugins-data-public.indexpatternfield.filterable.md) |  | <code>boolean</code> |  |
+|  [filterableType](./kibana-plugin-plugins-data-public.indexpatternfield.filterabletype.md) |  | <code>KBN_FILTERABLE_TYPE</code> |  |
 |  [format](./kibana-plugin-plugins-data-public.indexpatternfield.format.md) |  | <code>any</code> |  |
 |  [lang](./kibana-plugin-plugins-data-public.indexpatternfield.lang.md) |  | <code>string</code> |  |
 |  [name](./kibana-plugin-plugins-data-public.indexpatternfield.name.md) |  | <code>string</code> |  |

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.kbn_field_types.md

@@ -23,6 +23,7 @@ export declare enum KBN_FIELD_TYPES
 |  DATE | <code>&quot;date&quot;</code> |  |
 |  GEO\_POINT | <code>&quot;geo_point&quot;</code> |  |
 |  GEO\_SHAPE | <code>&quot;geo_shape&quot;</code> |  |
+|  HISTOGRAM | <code>&quot;histogram&quot;</code> |  |
 |  IP | <code>&quot;ip&quot;</code> |  |
 |  MURMUR3 | <code>&quot;murmur3&quot;</code> |  |
 |  NESTED | <code>&quot;nested&quot;</code> |  |

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.es_field_types.md

@@ -30,6 +30,7 @@ export declare enum ES_FIELD_TYPES
 |  GEO\_POINT | <code>&quot;geo_point&quot;</code> |  |
 |  GEO\_SHAPE | <code>&quot;geo_shape&quot;</code> |  |
 |  HALF\_FLOAT | <code>&quot;half_float&quot;</code> |  |
+|  HISTOGRAM | <code>&quot;histogram&quot;</code> |  |
 |  INTEGER | <code>&quot;integer&quot;</code> |  |
 |  IP | <code>&quot;ip&quot;</code> |  |
 |  KEYWORD | <code>&quot;keyword&quot;</code> |  |

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldtype.filterabletype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IFieldType](./kibana-plugin-plugins-data-server.ifieldtype.md) &gt; [filterableType](./kibana-plugin-plugins-data-server.ifieldtype.filterabletype.md)
+
+## IFieldType.filterableType property
+
+<b>Signature:</b>
+
+```typescript
+filterableType?: KBN_FILTERABLE_TYPE;
+```

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldtype.md

@@ -19,6 +19,7 @@ export interface IFieldType
 |  [displayName](./kibana-plugin-plugins-data-server.ifieldtype.displayname.md) | <code>string</code> |  |
 |  [esTypes](./kibana-plugin-plugins-data-server.ifieldtype.estypes.md) | <code>string[]</code> |  |
 |  [filterable](./kibana-plugin-plugins-data-server.ifieldtype.filterable.md) | <code>boolean</code> |  |
+|  [filterableType](./kibana-plugin-plugins-data-server.ifieldtype.filterabletype.md) | <code>KBN_FILTERABLE_TYPE</code> |  |
 |  [format](./kibana-plugin-plugins-data-server.ifieldtype.format.md) | <code>any</code> |  |
 |  [lang](./kibana-plugin-plugins-data-server.ifieldtype.lang.md) | <code>string</code> |  |
 |  [name](./kibana-plugin-plugins-data-server.ifieldtype.name.md) | <code>string</code> |  |

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kbn_field_types.md

@@ -23,6 +23,7 @@ export declare enum KBN_FIELD_TYPES
 |  DATE | <code>&quot;date&quot;</code> |  |
 |  GEO\_POINT | <code>&quot;geo_point&quot;</code> |  |
 |  GEO\_SHAPE | <code>&quot;geo_shape&quot;</code> |  |
+|  HISTOGRAM | <code>&quot;histogram&quot;</code> |  |
 |  IP | <code>&quot;ip&quot;</code> |  |
 |  MURMUR3 | <code>&quot;murmur3&quot;</code> |  |
 |  NESTED | <code>&quot;nested&quot;</code> |  |

src/plugins/data/common/index_patterns/fields/types.ts

@@ -17,6 +17,8 @@
  * under the License.
  */
 
+import { KBN_FILTERABLE_TYPE } from '../../kbn_field_types/types';
+
 export interface IFieldSubType {
   multi?: { parent: string };
   nested?: { path: string };
@@ -33,6 +35,7 @@ export interface IFieldType {
   esTypes?: string[];
   aggregatable?: boolean;
   filterable?: boolean;
+  filterableType?: KBN_FILTERABLE_TYPE;
   searchable?: boolean;
   sortable?: boolean;
   visualizable?: boolean;

src/plugins/data/common/index_patterns/fields/utils.ts

@@ -19,14 +19,18 @@
 
 import { getFilterableKbnTypeNames } from '../../kbn_field_types';
 import { IFieldType } from './types';
+import { KBN_FILTERABLE_TYPE } from '../..';
 
 const filterableTypes = getFilterableKbnTypeNames();
 
 export function isFilterable(field: IFieldType): boolean {
   return (
     field.name === '_id' ||
     field.scripted ||
-    Boolean(field.searchable && filterableTypes.includes(field.type))
+    Boolean(
+      (field.searchable && filterableTypes[field.type] === KBN_FILTERABLE_TYPE.ALL) ||
+        filterableTypes[field.type] === KBN_FILTERABLE_TYPE.EXISTSONLY
+    )
   );
 }
 

src/plugins/data/common/kbn_field_types/kbn_field_type.ts

@@ -17,18 +17,20 @@
  * under the License.
  */
 
-import { KbnFieldTypeOptions, ES_FIELD_TYPES, KBN_FIELD_TYPES } from './types';
+import { KbnFieldTypeOptions, ES_FIELD_TYPES, KBN_FIELD_TYPES, KBN_FILTERABLE_TYPE } from './types';
 
 export class KbnFieldType {
   public readonly name: string;
   public readonly sortable: boolean;
   public readonly filterable: boolean;
+  public readonly filterableType: KBN_FILTERABLE_TYPE;
   public readonly esTypes: readonly ES_FIELD_TYPES[];
 
   constructor(options: Partial<KbnFieldTypeOptions> = {}) {
     this.name = options.name || KBN_FIELD_TYPES.UNKNOWN;
     this.sortable = options.sortable || false;
     this.filterable = options.filterable || false;
+    this.filterableType = options.filterableType || KBN_FILTERABLE_TYPE.NONE;
     this.esTypes = Object.freeze((options.esTypes || []).slice());
   }
 }

src/plugins/data/common/kbn_field_types/kbn_field_types.test.ts

@@ -87,6 +87,7 @@ describe('utils/kbn_field_types', () => {
         KBN_FIELD_TYPES.DATE,
         KBN_FIELD_TYPES.GEO_POINT,
         KBN_FIELD_TYPES.GEO_SHAPE,
+        KBN_FIELD_TYPES.HISTOGRAM,
         KBN_FIELD_TYPES.IP,
         KBN_FIELD_TYPES.MURMUR3,
         KBN_FIELD_TYPES.NESTED,

src/plugins/data/common/kbn_field_types/kbn_field_types.ts

@@ -19,7 +19,7 @@
 
 import { createKbnFieldTypes } from './kbn_field_types_factory';
 import { KbnFieldType } from './kbn_field_type';
-import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from './types';
+import { ES_FIELD_TYPES, KBN_FIELD_TYPES, KBN_FILTERABLE_TYPE } from './types';
 
 /** @private */
 const registeredKbnTypes = createKbnFieldTypes();
@@ -58,5 +58,8 @@ export const castEsToKbnFieldTypeName = (esType: ES_FIELD_TYPES | string): KBN_F
  *
  *  @return {Array<string>}
  */
-export const getFilterableKbnTypeNames = (): string[] =>
-  registeredKbnTypes.filter(type => type.filterable).map(type => type.name);
+export const getFilterableKbnTypeNames = (): { [key: string]: KBN_FILTERABLE_TYPE } =>
+  registeredKbnTypes.reduce((map: { [key: string]: KBN_FILTERABLE_TYPE }, type: KbnFieldType) => {
+    map[type.name] = type.filterableType;
+    return map;
+  }, {});

src/plugins/data/common/kbn_field_types/kbn_field_types_factory.ts

@@ -18,13 +18,14 @@
  */
 
 import { KbnFieldType } from './kbn_field_type';
-import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from './types';
+import { ES_FIELD_TYPES, KBN_FIELD_TYPES, KBN_FILTERABLE_TYPE } from './types';
 
 export const createKbnFieldTypes = (): KbnFieldType[] => [
   new KbnFieldType({
     name: KBN_FIELD_TYPES.STRING,
     sortable: true,
     filterable: true,
+    filterableType: KBN_FILTERABLE_TYPE.ALL,
     esTypes: [
       ES_FIELD_TYPES.STRING,
       ES_FIELD_TYPES.TEXT,
@@ -37,6 +38,7 @@ export const createKbnFieldTypes = (): KbnFieldType[] => [
     name: KBN_FIELD_TYPES.NUMBER,
     sortable: true,
     filterable: true,
+    filterableType: KBN_FILTERABLE_TYPE.ALL,
     esTypes: [
       ES_FIELD_TYPES.FLOAT,
       ES_FIELD_TYPES.HALF_FLOAT,
@@ -53,18 +55,21 @@ export const createKbnFieldTypes = (): KbnFieldType[] => [
     name: KBN_FIELD_TYPES.DATE,
     sortable: true,
     filterable: true,
+    filterableType: KBN_FILTERABLE_TYPE.ALL,
     esTypes: [ES_FIELD_TYPES.DATE, ES_FIELD_TYPES.DATE_NANOS],
   }),
   new KbnFieldType({
     name: KBN_FIELD_TYPES.IP,
     sortable: true,
     filterable: true,
+    filterableType: KBN_FILTERABLE_TYPE.ALL,
     esTypes: [ES_FIELD_TYPES.IP],
   }),
   new KbnFieldType({
     name: KBN_FIELD_TYPES.BOOLEAN,
     sortable: true,
     filterable: true,
+    filterableType: KBN_FILTERABLE_TYPE.ALL,
     esTypes: [ES_FIELD_TYPES.BOOLEAN],
   }),
   new KbnFieldType({
@@ -95,6 +100,12 @@ export const createKbnFieldTypes = (): KbnFieldType[] => [
     name: KBN_FIELD_TYPES._SOURCE,
     esTypes: [ES_FIELD_TYPES._SOURCE],
   }),
+  new KbnFieldType({
+    name: KBN_FIELD_TYPES.HISTOGRAM,
+    filterable: true,
+    filterableType: KBN_FILTERABLE_TYPE.EXISTSONLY,
+    esTypes: [ES_FIELD_TYPES.HISTOGRAM],
+  }),
   new KbnFieldType({
     name: KBN_FIELD_TYPES.CONFLICT,
   }),

src/plugins/data/common/kbn_field_types/types.ts

@@ -21,10 +21,17 @@
 export interface KbnFieldTypeOptions {
   sortable: boolean;
   filterable: boolean;
+  filterableType: KBN_FILTERABLE_TYPE;
   name: string;
   esTypes: ES_FIELD_TYPES[];
 }
 
+export enum KBN_FILTERABLE_TYPE {
+  ALL = 'all',
+  NONE = 'none',
+  EXISTSONLY = 'existsOnly',
+}
+
 /** @public **/
 export enum ES_FIELD_TYPES {
   _ID = '_id',
@@ -59,6 +66,8 @@ export enum ES_FIELD_TYPES {
   ATTACHMENT = 'attachment',
   TOKEN_COUNT = 'token_count',
   MURMUR3 = 'murmur3',
+
+  HISTOGRAM = 'histogram',
 }
 
 /** @public **/
@@ -77,4 +86,5 @@ export enum KBN_FIELD_TYPES {
   CONFLICT = 'conflict',
   OBJECT = 'object',
   NESTED = 'nested',
+  HISTOGRAM = 'histogram',
 }

src/plugins/data/public/index_patterns/fields/field.ts

@@ -22,7 +22,13 @@ import { i18n } from '@kbn/i18n';
 import { ObjDefine } from './obj_define';
 import { IndexPattern } from '../index_patterns';
 import { getNotifications, getFieldFormats } from '../../services';
-import { IFieldType, getKbnFieldType, IFieldSubType, FieldFormat } from '../../../common';
+import {
+  IFieldType,
+  getKbnFieldType,
+  IFieldSubType,
+  FieldFormat,
+  KBN_FILTERABLE_TYPE,
+} from '../../../common';
 import { shortenDottedString } from '../../../common/utils';
 
 export type FieldSpec = Record<string, any>;
@@ -38,6 +44,7 @@ export class Field implements IFieldType {
   esTypes?: string[];
   aggregatable?: boolean;
   filterable?: boolean;
+  filterableType?: KBN_FILTERABLE_TYPE;
   searchable?: boolean;
   sortable?: boolean;
   visualizable?: boolean;
@@ -106,6 +113,7 @@ export class Field implements IFieldType {
     const sortable = spec.name === '_score' || ((indexed || aggregatable) && type && type.sortable);
     const filterable =
       spec.name === '_id' || scripted || ((indexed || searchable) && type && type.filterable);
+    const filterableType = type?.filterableType;
     const visualizable = aggregatable;
 
     this.name = '';
@@ -129,6 +137,7 @@ export class Field implements IFieldType {
     obj.comp('format', format);
     obj.comp('sortable', sortable);
     obj.comp('filterable', filterable);
+    obj.comp('filterableType', filterableType);
     obj.comp('visualizable', visualizable);
 
     // computed values

src/plugins/data/public/public.api.md

@@ -284,6 +284,8 @@ export enum ES_FIELD_TYPES {
     // (undocumented)
     HALF_FLOAT = "half_float",
     // (undocumented)
+    HISTOGRAM = "histogram",
+    // (undocumented)
     _ID = "_id",
     // (undocumented)
     _INDEX = "_index",
@@ -689,6 +691,10 @@ export interface IFieldType {
     esTypes?: string[];
     // (undocumented)
     filterable?: boolean;
+    // Warning: (ae-forgotten-export) The symbol "KBN_FILTERABLE_TYPE" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    filterableType?: KBN_FILTERABLE_TYPE;
     // (undocumented)
     format?: any;
     // (undocumented)
@@ -915,6 +921,8 @@ export class IndexPatternField implements IFieldType {
     // (undocumented)
     filterable?: boolean;
     // (undocumented)
+    filterableType?: KBN_FILTERABLE_TYPE;
+    // (undocumented)
     format: any;
     // (undocumented)
     lang?: string;
@@ -1126,6 +1134,8 @@ export enum KBN_FIELD_TYPES {
     // (undocumented)
     GEO_SHAPE = "geo_shape",
     // (undocumented)
+    HISTOGRAM = "histogram",
+    // (undocumented)
     IP = "ip",
     // (undocumented)
     MURMUR3 = "murmur3",

src/plugins/data/public/search/aggs/metrics/percentile_ranks.ts

@@ -59,7 +59,7 @@ export const percentileRanksMetricAgg = new MetricAggType<IPercentileRanksAggCon
     {
       name: 'field',
       type: 'field',
-      filterFieldTypes: KBN_FIELD_TYPES.NUMBER,
+      filterFieldTypes: [KBN_FIELD_TYPES.NUMBER, KBN_FIELD_TYPES.HISTOGRAM],
     },
     {
       name: 'values',

src/plugins/data/public/search/aggs/metrics/percentiles.ts

@@ -54,7 +54,7 @@ export const percentilesMetricAgg = new MetricAggType<IPercentileAggConfig>({
     {
       name: 'field',
       type: 'field',
-      filterFieldTypes: [KBN_FIELD_TYPES.NUMBER, KBN_FIELD_TYPES.DATE],
+      filterFieldTypes: [KBN_FIELD_TYPES.NUMBER, KBN_FIELD_TYPES.DATE, KBN_FIELD_TYPES.HISTOGRAM],
     },
     {
       name: 'percents',