mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
439 lines
No EOL
14 KiB
JSON
439 lines
No EOL
14 KiB
JSON
{
|
|
"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.getLogRateAnalysisType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLogRateAnalysisType",
|
|
"description": [
|
|
"\nIdentify the log rate analysis type based on the baseline/deviation\ntime ranges on a given log rate histogram.\n"
|
|
],
|
|
"signature": [
|
|
"(logRateHistogram: ",
|
|
{
|
|
"pluginId": "@kbn/aiops-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAiopsUtilsPluginApi",
|
|
"section": "def-common.LogRateHistogramItem",
|
|
"text": "LogRateHistogramItem"
|
|
},
|
|
"[], windowParameters: ",
|
|
{
|
|
"pluginId": "@kbn/aiops-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAiopsUtilsPluginApi",
|
|
"section": "def-common.WindowParameters",
|
|
"text": "WindowParameters"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/aiops-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAiopsUtilsPluginApi",
|
|
"section": "def-common.LogRateAnalysisType",
|
|
"text": "LogRateAnalysisType"
|
|
}
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/get_log_rate_analysis_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.getLogRateAnalysisType.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "logRateHistogram",
|
|
"description": [
|
|
"The log rate histogram."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/aiops-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAiopsUtilsPluginApi",
|
|
"section": "def-common.LogRateHistogramItem",
|
|
"text": "LogRateHistogramItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/get_log_rate_analysis_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.getLogRateAnalysisType.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "windowParameters",
|
|
"description": [
|
|
"The window parameters with baseline and deviation time range."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/aiops-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAiopsUtilsPluginApi",
|
|
"section": "def-common.WindowParameters",
|
|
"text": "WindowParameters"
|
|
}
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/get_log_rate_analysis_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The log rate analysis type."
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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/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 log rate analysis"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/aiops-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnAiopsUtilsPluginApi",
|
|
"section": "def-common.WindowParameters",
|
|
"text": "WindowParameters"
|
|
}
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/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/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 log deviation 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/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 deviation."
|
|
],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/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/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/window_parameters.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"WindowParameters"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.LogRateHistogramItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LogRateHistogramItem",
|
|
"description": [
|
|
"\nLog rate histogram item"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/log_rate_histogram_item.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.LogRateHistogramItem.time",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "time",
|
|
"description": [
|
|
"\nTime of bucket"
|
|
],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/log_rate_histogram_item.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.LogRateHistogramItem.value",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [
|
|
"\nNumber of doc count for that time bucket"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/log_rate_histogram_item.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.WindowParameters",
|
|
"type": "Interface",
|
|
"tags": [
|
|
"export",
|
|
"interface",
|
|
"typedef"
|
|
],
|
|
"label": "WindowParameters",
|
|
"description": [
|
|
"\nTime range definition for baseline and deviation to be used by log rate analysis.\n"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.WindowParameters.baselineMin",
|
|
"type": "number",
|
|
"tags": [
|
|
"type"
|
|
],
|
|
"label": "baselineMin",
|
|
"description": [
|
|
"\nBaseline minimum value"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.WindowParameters.baselineMax",
|
|
"type": "number",
|
|
"tags": [
|
|
"type"
|
|
],
|
|
"label": "baselineMax",
|
|
"description": [
|
|
"\nBaseline maximum value"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.WindowParameters.deviationMin",
|
|
"type": "number",
|
|
"tags": [
|
|
"type"
|
|
],
|
|
"label": "deviationMin",
|
|
"description": [
|
|
"\nDeviation minimum value"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.WindowParameters.deviationMax",
|
|
"type": "number",
|
|
"tags": [
|
|
"type"
|
|
],
|
|
"label": "deviationMax",
|
|
"description": [
|
|
"\nDeviation maximum value"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/window_parameters.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.LogRateAnalysisType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LogRateAnalysisType",
|
|
"description": [
|
|
"\nUnion type of log rate analysis types."
|
|
],
|
|
"signature": [
|
|
"\"spike\" | \"dip\""
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/log_rate_analysis_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "@kbn/aiops-utils",
|
|
"id": "def-common.LOG_RATE_ANALYSIS_TYPE",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "LOG_RATE_ANALYSIS_TYPE",
|
|
"description": [
|
|
"\nThe type of log rate analysis (spike or dip) will affect how parameters are\npassed to the analysis API endpoint."
|
|
],
|
|
"signature": [
|
|
"{ readonly SPIKE: \"spike\"; readonly DIP: \"dip\"; }"
|
|
],
|
|
"path": "x-pack/packages/ml/aiops_utils/log_rate_analysis_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |