[DOCS] Model plot updates (elastic/x-pack-elasticsearch#1803)
* [DOCS] Model plot updates Add to job create. Remove terms from job resource. * [DOCS] Describing terms as experimental Original commit: elastic/x-pack-elasticsearch@815fa0ec37
This commit is contained in:
parent
edd5fa4ab4
commit
a9f86f6d1b
|
@ -287,16 +287,17 @@ For more information, see
|
||||||
==== Model Plot Config
|
==== Model Plot Config
|
||||||
|
|
||||||
This advanced configuration option stores model information along with the
|
This advanced configuration option stores model information along with the
|
||||||
results. It provides a more detailed view into anomaly detection. If you enable
|
results. It provides a more detailed view into anomaly detection.
|
||||||
this option, it can add considerable overhead to the performance of the system;
|
|
||||||
it is not feasible for jobs with many entities.
|
WARNING: If you enable model plot it can add considerable overhead to the performance
|
||||||
|
of the system; it is not feasible for jobs with many entities.
|
||||||
|
|
||||||
Model plot provides a simplified and indicative view of the model and its bounds.
|
Model plot provides a simplified and indicative view of the model and its bounds.
|
||||||
It does not display complex features such as multivariate correlations or multimodal data.
|
It does not display complex features such as multivariate correlations or multimodal data.
|
||||||
As such, anomalies may occasionally be reported which cannot be seen in the model plot.
|
As such, anomalies may occasionally be reported which cannot be seen in the model plot.
|
||||||
|
|
||||||
Model plot config can be configured when the job is created or updated later.
|
Model plot config can be configured when the job is created or updated later. It must be
|
||||||
It must be disabled if performance issues are experienced.
|
disabled if performance issues are experienced.
|
||||||
|
|
||||||
The `model_plot_config` object has the following properties:
|
The `model_plot_config` object has the following properties:
|
||||||
|
|
||||||
|
@ -305,6 +306,7 @@ The `model_plot_config` object has the following properties:
|
||||||
each entity that is being analyzed. By default, this is not enabled.
|
each entity that is being analyzed. By default, this is not enabled.
|
||||||
|
|
||||||
`terms`::
|
`terms`::
|
||||||
(string) Limits data collection to this comma separated list of _partition_
|
(string) Limits data collection to this comma separated list of partition or by field values.
|
||||||
or _by_ field values. If terms are not specified or it is an empty string,
|
If terms are not specified or it is an empty string, no filtering is applied.
|
||||||
no filtering is applied. For example, `"CPU,NetworkIn,DiskWrites"`
|
For example, "CPU,NetworkIn,DiskWrites". This is experimental. Only the specified `terms` can
|
||||||
|
be viewed when using the Single Metric Viewer.
|
||||||
|
|
|
@ -32,6 +32,11 @@ The create job API enables you to instantiate a job.
|
||||||
`description`::
|
`description`::
|
||||||
(string) An optional description of the job.
|
(string) An optional description of the job.
|
||||||
|
|
||||||
|
`model_plot`::
|
||||||
|
(object) This advanced configuration option stores model information along with the
|
||||||
|
results. This adds overhead to the performance of the system and
|
||||||
|
is not feasible for jobs with many entities, see <<ml-apimodelplotconfig>>.
|
||||||
|
|
||||||
`model_snapshot_retention_days`::
|
`model_snapshot_retention_days`::
|
||||||
(long) The time in days that model snapshots are retained for the job.
|
(long) The time in days that model snapshots are retained for the job.
|
||||||
Older snapshots are deleted. The default value is 1 day.
|
Older snapshots are deleted. The default value is 1 day.
|
||||||
|
|
Loading…
Reference in New Issue