{ "id": "@kbn/aiops-utils", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.getSnappedWindowParameters", "type": "Function", "tags": [], "label": "getSnappedWindowParameters", "description": [ "\n\nConverts window paramaters from the brushes to “snap” the brushes to the chart histogram bar width and ensure timestamps\ncorrespond to bucket timestamps\n" ], "signature": [ "(windowParameters: ", { "pluginId": "@kbn/aiops-utils", "scope": "common", "docId": "kibKbnAiopsUtilsPluginApi", "section": "def-common.WindowParameters", "text": "WindowParameters" }, ", snapTimestamps: number[]) => ", { "pluginId": "@kbn/aiops-utils", "scope": "common", "docId": "kibKbnAiopsUtilsPluginApi", "section": "def-common.WindowParameters", "text": "WindowParameters" } ], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.getSnappedWindowParameters.$1", "type": "Object", "tags": [], "label": "windowParameters", "description": [ "time range definition for baseline and deviation to be used by spike log analysis" ], "signature": [ { "pluginId": "@kbn/aiops-utils", "scope": "common", "docId": "kibKbnAiopsUtilsPluginApi", "section": "def-common.WindowParameters", "text": "WindowParameters" } ], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.getSnappedWindowParameters.$2", "type": "Array", "tags": [], "label": "snapTimestamps", "description": [ "time range definition that always corresponds to histogram bucket timestamps" ], "signature": [ "number[]" ], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "WindowParameters" ], "initialIsOpen": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.getWindowParameters", "type": "Function", "tags": [], "label": "getWindowParameters", "description": [ "\nGiven a point in time (e.g. where a user clicks), use simple heuristics to compute:\n\n1. The time window around the click to evaluate for changes\n2. The historical time window prior to the click to use as a baseline.\n\nThe philosophy here is that charts are displayed with different granularities according to their\noverall time window. We select the change point and historical time windows inline with the\noverall time window.\n\nThe algorithm for doing this is based on the typical granularities that exist in machine data.\n" ], "signature": [ "(clickTime: number, minTime: number, maxTime: number) => ", { "pluginId": "@kbn/aiops-utils", "scope": "common", "docId": "kibKbnAiopsUtilsPluginApi", "section": "def-common.WindowParameters", "text": "WindowParameters" } ], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.getWindowParameters.$1", "type": "number", "tags": [], "label": "clickTime", "description": [ "timestamp of the clicked log rate spike." ], "signature": [ "number" ], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.getWindowParameters.$2", "type": "number", "tags": [], "label": "minTime", "description": [ "minimum timestamp of the time window to be analysed" ], "signature": [ "number" ], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.getWindowParameters.$3", "type": "number", "tags": [], "label": "maxTime", "description": [ "maximum timestamp of the time window to be analysed" ], "signature": [ "number" ], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "WindowParameters" ], "initialIsOpen": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory", "type": "Function", "tags": [], "label": "streamFactory", "description": [ "\nOverload to set up a string based response stream with support\nfor gzip compression depending on provided request headers.\n" ], "signature": [ "(headers: ", { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.Headers", "text": "Headers" }, ", logger: ", { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, ", compressOverride: boolean | undefined, flushFix: boolean | undefined) => StreamFactoryReturnType" ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$1", "type": "CompoundType", "tags": [], "label": "headers", "description": [ "- Request headers." ], "signature": [ { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.Headers", "text": "Headers" } ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$2", "type": "Object", "tags": [], "label": "logger", "description": [ "- Kibana logger." ], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" } ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$3", "type": "CompoundType", "tags": [], "label": "compressOverride", "description": [ "- Optional flag to override header based compression setting." ], "signature": [ "boolean | undefined" ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$4", "type": "CompoundType", "tags": [], "label": "flushFix", "description": [ "- Adds an attribute with a random string payload to overcome buffer flushing with certain proxy configurations." ], "signature": [ "boolean | undefined" ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [ "An object with stream attributes and methods." ], "initialIsOpen": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory", "type": "Function", "tags": [], "label": "streamFactory", "description": [ "\nSets up a response stream with support for gzip compression depending on provided\nrequest headers. Any non-string data pushed to the stream will be stream as NDJSON.\n" ], "signature": [ "(headers: ", { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.Headers", "text": "Headers" }, ", logger: ", { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, ", compressOverride: boolean, flushFix: boolean) => StreamFactoryReturnType" ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$1", "type": "CompoundType", "tags": [], "label": "headers", "description": [ "- Request headers." ], "signature": [ { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.Headers", "text": "Headers" } ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$2", "type": "Object", "tags": [], "label": "logger", "description": [ "- Kibana logger." ], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" } ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$3", "type": "boolean", "tags": [], "label": "compressOverride", "description": [ "- Optional flag to override header based compression setting." ], "signature": [ "boolean" ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$4", "type": "boolean", "tags": [], "label": "flushFix", "description": [ "- Adds an attribute with a random string payload to overcome buffer flushing with certain proxy configurations." ], "signature": [ "boolean" ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "An object with stream attributes and methods." ], "initialIsOpen": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream", "type": "Function", "tags": [], "label": "useFetchStream", "description": [], "signature": [ "(endpoint: `${BasePath}${I[\"endpoint\"]}`, body: I[\"body\"]) => UseFetchStreamReturnType>" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$1", "type": "Uncategorized", "tags": [], "label": "endpoint", "description": [], "signature": [ "`${BasePath}${I[\"endpoint\"]}`" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$2", "type": "Uncategorized", "tags": [], "label": "body", "description": [], "signature": [ "I[\"body\"]" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream", "type": "Function", "tags": [], "label": "useFetchStream", "description": [], "signature": [ "(endpoint: `${BasePath}${I[\"endpoint\"]}`, body: I[\"body\"], options: { reducer: I[\"reducer\"]; initialState: React.ReducerState; }) => UseFetchStreamReturnType, React.ReducerAction>" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$1", "type": "Uncategorized", "tags": [], "label": "endpoint", "description": [], "signature": [ "`${BasePath}${I[\"endpoint\"]}`" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$2", "type": "Uncategorized", "tags": [], "label": "body", "description": [], "signature": [ "I[\"body\"]" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3.reducer", "type": "Function", "tags": [], "label": "reducer", "description": [], "signature": [ "I[\"reducer\"]" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3.reducer.$1", "type": "Uncategorized", "tags": [], "label": "prevState", "description": [], "signature": [ "S" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3.reducer.$2", "type": "Uncategorized", "tags": [], "label": "action", "description": [], "signature": [ "A" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3.initialState", "type": "Uncategorized", "tags": [], "label": "initialState", "description": [], "signature": [ "I[\"reducer\"] extends React.Reducer ? S : never" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream", "type": "Function", "tags": [], "label": "useFetchStream", "description": [ "\nCustom hook to receive streaming data.\n" ], "signature": [ "(endpoint: `${BasePath}${I[\"endpoint\"]}`, body: I[\"body\"], options: { reducer: I[\"reducer\"]; initialState: React.ReducerState; } | undefined) => UseFetchStreamReturnType, React.ReducerAction>" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$1", "type": "Uncategorized", "tags": [], "label": "endpoint", "description": [ "- API endpoint including Kibana base path." ], "signature": [ "`${BasePath}${I[\"endpoint\"]}`" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$2", "type": "Uncategorized", "tags": [], "label": "body", "description": [ "- API request body." ], "signature": [ "I[\"body\"]" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3.reducer", "type": "Function", "tags": [], "label": "reducer", "description": [], "signature": [ "I[\"reducer\"]" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3.reducer.$1", "type": "Uncategorized", "tags": [], "label": "prevState", "description": [], "signature": [ "S" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3.reducer.$2", "type": "Uncategorized", "tags": [], "label": "action", "description": [], "signature": [ "A" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.useFetchStream.$3.initialState", "type": "Uncategorized", "tags": [], "label": "initialState", "description": [], "signature": [ "I[\"reducer\"] extends React.Reducer ? S : never" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [ "An object with streaming data and methods act on the stream." ], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamCustomReducerParams", "type": "Interface", "tags": [], "label": "UseFetchStreamCustomReducerParams", "description": [ "\nCustom hook type definition of the base params for an NDJSON stream with custom reducer." ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamCustomReducerParams.endpoint", "type": "string", "tags": [], "label": "endpoint", "description": [], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamCustomReducerParams.body", "type": "Uncategorized", "tags": [], "label": "body", "description": [], "signature": [ "object" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamCustomReducerParams.reducer", "type": "Function", "tags": [], "label": "reducer", "description": [], "signature": [ "(prevState: any, action: any) => any" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamCustomReducerParams.reducer.$1", "type": "Uncategorized", "tags": [], "label": "prevState", "description": [], "signature": [ "S" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamCustomReducerParams.reducer.$2", "type": "Uncategorized", "tags": [], "label": "action", "description": [], "signature": [ "A" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamParamsDefault", "type": "Interface", "tags": [], "label": "UseFetchStreamParamsDefault", "description": [ "\nCustom hook type definition of the base params for a string base stream without a custom reducer." ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamParamsDefault.endpoint", "type": "string", "tags": [], "label": "endpoint", "description": [], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamParamsDefault.body", "type": "Uncategorized", "tags": [], "label": "body", "description": [], "signature": [ "object" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamParamsDefault.reducer", "type": "Function", "tags": [], "label": "reducer", "description": [], "signature": [ "(prevState: string, action: StringReducerPayload) => string" ], "path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamParamsDefault.reducer.$1", "type": "Uncategorized", "tags": [], "label": "prevState", "description": [], "signature": [ "S" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.UseFetchStreamParamsDefault.reducer.$2", "type": "Uncategorized", "tags": [], "label": "action", "description": [], "signature": [ "A" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.WindowParameters", "type": "Interface", "tags": [], "label": "WindowParameters", "description": [ "\nTime range definition for baseline and deviation to be used by spike log analysis." ], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.WindowParameters.baselineMin", "type": "number", "tags": [], "label": "baselineMin", "description": [], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.WindowParameters.baselineMax", "type": "number", "tags": [], "label": "baselineMax", "description": [], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.WindowParameters.deviationMin", "type": "number", "tags": [], "label": "deviationMin", "description": [], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.WindowParameters.deviationMax", "type": "number", "tags": [], "label": "deviationMax", "description": [], "path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [] } }