Skip to content

Commit

Permalink
[DOCS] Adds Metrics AD configurations to OOTB jobs (#1366)
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve authored Oct 8, 2020
1 parent 473cafd commit 2bae700
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/en/stack/ml/anomaly-detection/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ include::ootb-ml-jobs-logs-ui.asciidoc[leveloffset=+2]

include::ootb-ml-jobs-metricbeat.asciidoc[leveloffset=+2]

include::ootb-ml-jobs-metrics-ui.asciidoc[leveloffset=+2]

include::ootb-ml-jobs-nginx.asciidoc[leveloffset=+2]

include::ootb-ml-jobs-siem.asciidoc[leveloffset=+2]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
[role="xpack"]
[[ootb-ml-jobs-metrics-ui]]
= Metrics {anomaly-detect} configurations
++++
<titleabbrev>Metrics</titleabbrev>
++++

// tag::metrics-jobs[]
These {anomaly-jobs} can be created in the
{observability-guide}/analyze-metrics.html[Metrics app] in {kib}.

The jobs below detect anomalous memory and network behavior on hosts and
Kubernetes pods. For more details, see the {dfeed} and job definitions in the
`metrics_ui_*` folders in
https://github.com/elastic/kibana/tree/{branch}/x-pack/plugins/ml/server/models/data_recognizer/modules[GitHub].


hosts_memory_usage::

* For memory usage data about hosts in the {metrics-app}.
* Models system memory usage.
* Detects unusual increases in memory usage across hosts.


hosts_network_in::

* For network traffic across hosts in the {metrics-app}.
* Models inbound network traffic.
* Detects unusually high inbound traffic across hosts.


hosts_network_out::

* For network traffic across hosts in the {metrics-app}.
* Models outbound network traffic.
* Detects unusually high outbound traffic across hosts.


k8s_memory_usage::

* For memory usage data about Kubernetes pods in the {metrics-app}.
* Models system memory usage.
* Detects unusual increases in memory usage across Kubernetes pods.


k8s_network_in::

* For network traffic accross Kubernetes pods in the {metrics-app}.
* Models inbound network traffic.
* Detects unusually high inbound traffic across Kubernetes pods.


k8s_network_out::

* For network traffic across Kubernetes pods in the {metrics-app}.
* Models outbound network traffic.
* Detects unusually high outbound traffic across Kubernetes pods.


// end::metrics-jobs[]
1 change: 1 addition & 0 deletions docs/en/stack/ml/anomaly-detection/ootb-ml-jobs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ the {anomaly-jobs} that are ready to use via {kib}.
* <<ootb-ml-jobs-auditbeat>>
* <<ootb-ml-jobs-logs-ui>>
* <<ootb-ml-jobs-metricbeat>>
* <<ootb-ml-jobs-metrics-ui>>
* <<ootb-ml-jobs-nginx>>
* <<ootb-ml-jobs-siem>>
* <<ootb-ml-jobs-uptime>>

0 comments on commit 2bae700

Please sign in to comment.