Move observability content (#79978)

This commit is contained in:
EamonnTP 2020-10-13 16:08:48 +01:00 committed by GitHub
parent 4f4abf2286
commit af6d287653
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 69 additions and 90 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 295 KiB

View file

@ -1,32 +0,0 @@
[chapter]
[role="xpack"]
[[xpack-infra]]
= Metrics
The {metrics-app} in {kib} enables you to monitor your infrastructure metrics and identify problems in real time.
You start with a visual summary of your infrastructure where you can view basic metrics for common servers, containers, and services.
Then you can drill down to view more detailed metrics or other information for that component.
You can:
* View your infrastructure metrics by hosts, Kubernetes pods, or Docker containers.
You can group and filter the data in various ways to help you identify the items that interest you.
* View current and historic values for metrics such as CPU usage, memory usage, and network traffic for each component.
The available metrics depend on the kind of component being inspected.
* Use *Metrics Explorer* to group and visualize multiple customizable metrics for one or more components in a graphical format.
You can optionally save these views and add them to {kibana-ref}/dashboard.html[dashboards].
* Seamlessly switch to view the corresponding logs, application traces or uptime information for a component.
* Create alerts based on metric thresholds for one or more components.
[role="screenshot"]
image::infrastructure/images/infra-sysmon.png[Infrastructure Overview in Kibana]
[float]
=== Get started
To get started with Metrics, refer to {metrics-guide}/install-metrics-monitoring.html[Install Metrics].

Binary file not shown.

Before

Width:  |  Height:  |  Size: 499 KiB

View file

@ -1,21 +0,0 @@
[chapter]
[role="xpack"]
[[xpack-logs]]
= Logs
The Logs app in Kibana enables you to explore logs for common servers, containers, and services.
The Logs app has a compact, console-like display that you can customize.
You can filter the logs by various fields, start and stop live streaming, and highlight text of interest.
You can open the Logs app from the *Logs* tab in Kibana.
You can also open the Logs app directly from a component in the Metrics app.
In this case, you will only see the logs for the selected component.
[role="screenshot"]
image::logs/images/logs-console.png[Logs Console in Kibana]
[float]
=== Get started
To get started with Elastic Logs, refer to {logs-guide}/install-logs-monitoring.html[Install Logs].

View file

@ -4,7 +4,7 @@
beta[]
The *Alerts* tab provides a cross-app view of alerting. Different {kib} apps like <<xpack-infra, Metrics>>, <<xpack-apm, APM>>, <<xpack-uptime, Uptime>>, and <<xpack-siem, SIEM>> can offer their own alerts, and the *Alerts* tab provides a central place to:
The *Alerts* tab provides a cross-app view of alerting. Different {kib} apps like <<metrics-app,Metrics>>, <<xpack-apm,APM>>, <<uptime-app,Uptime>>, and <<xpack-siem,SIEM>> can offer their own alerts, and the *Alerts* tab provides a central place to:
* <<create-edit-alerts, Create and edit>> alerts
* <<controlling-alerts, Control alerts>> including enabling/disabling, muting/unmuting, and deleting
@ -39,7 +39,7 @@ image::images/alerts-filter-by-action-type.png[Filtering the alert list by type
[[create-edit-alerts]]
==== Creating and editing alerts
Many alerts must be created within the context of a {kib} app like <<xpack-infra, Metrics>>, <<xpack-apm, APM>>, or <<xpack-uptime, Uptime>>, but others are generic. Generic alert types can be created in the *Alerts* management UI by clicking the *Create* button. This will launch a flyout that guides you through selecting an alert type and configuring it's properties. Refer to <<alert-types>> for details on what types of alerts are available and how to configure them.
Many alerts must be created within the context of a {kib} app like <<metrics-app, Metrics>>, <<xpack-apm, APM>>, or <<uptime-app, Uptime>>, but others are generic. Generic alert types can be created in the *Alerts* management UI by clicking the *Create* button. This will launch a flyout that guides you through selecting an alert type and configuring it's properties. Refer to <<alert-types>> for details on what types of alerts are available and how to configure them.
After an alert is created, you can re-open the flyout and change an alerts properties by clicking the *Edit* button shown on each row of the alert listing.

Binary file not shown.

After

Width:  |  Height:  |  Size: 455 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 321 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 480 KiB

View file

@ -13,12 +13,69 @@ With *Observability*, you have:
* *View in app* options to drill down and analyze data in the Logs, Metrics, Uptime, and APM apps.
* An alerts chart to keep you informed of any issues that you may need to resolve quickly.
{kib} provides step-by-step instructions to help you add and configure your data
sources. The {observability-guide}/index.html[Observability Guide] is a good source for more detailed information
and instructions.
[role="screenshot"]
image::observability/images/observability-overview.png[Observability Overview in {kib}]
[float]
== Get started
[[logs-app]]
== Logs
{kib} provides step-by-step instructions to help you add and configure your data
sources. The {observability-guide}/index.html[Observability Guide] is a good source for more detailed information
and instructions.
The {logs-app} in {kib} enables you to search, filter, and tail all your logs
ingested into {es}. Instead of having to log into different servers, change
directories, and tail individual files, all your logs are available in the {logs-app}.
There is live streaming of logs, filtering using auto-complete, and a logs histogram
for quick navigation. You can also use machine learning to detect specific log
anomalies automatically and categorize log messages to quickly identify patterns in your
log events.
To get started with the {logs-app}, see {observability-guide}/ingest-logs.html[Ingest logs].
[role="screenshot"]
image::observability/images/logs-app.png[Logs app in {kib}]
[float]
[[metrics-app]]
== Metrics
The {metrics-app} in {kib} enables you to visualize infrastructure metrics
to help diagnose problematic spikes, identify high resource utilization,
automatically discover and track pods, and unify your metrics
with logs and APM data in {es}.
To get started with the {metrics-app}, see {observability-guide}/ingest-metrics.html[Ingest metrics].
[role="screenshot"]
image::observability/images/metrics-app.png[Metrics app in {kib}]
[float]
[[uptime-app]]
== Uptime
The {uptime-app} in {kib} enables you to monitor the availability and response times
of applications and services in real time, and detect problems before they affect users.
You can monitor the status of network endpoints via HTTP/S, TCP, and ICMP, explore
endpoint status over time, drill down into specific monitors, and view a high-level
snapshot of your environment at any point in time.
To get started with the {uptime-app}, see {observability-guide}/ingest-uptime.html[Ingest uptime data].
[role="screenshot"]
image::observability/images/uptime-app.png[Uptime app in {kib}]
[float]
[[apm-app]]
== APM
The APM app in {kib} enables you to monitors software services and applications in real time,
collect unhandled errors and exceptions, and automatically pick up basic host-level metrics
and agent specific metrics.
To get started with the APM app, see <<apm-ui,Set up the APM app>>.
[role="screenshot"]
image::observability/images/apm-app.png[APM app in {kib}]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 315 KiB

View file

@ -1,19 +0,0 @@
[chapter]
[role="xpack"]
[[xpack-uptime]]
= Uptime
The Uptime app in {kib} enables you to monitor the status of network endpoints via HTTP/S, TCP, and ICMP.
You can explore endpoint status over time, drill down into specific monitors,
and view a high-level snapshot of your environment at any point in time.
[role="screenshot"]
image::images/uptime-overview.png[Uptime app overview]
[float]
=== Get started
To get started with Elastic Uptime, refer to {uptime-guide}/install-uptime.html[Install Uptime].

View file

@ -2,7 +2,7 @@
[[alert-types]]
== Alert types
{kib} supplies alerts types in two ways: some are built into {kib}, while domain-specific alert types are registered by {kib} apps such as <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, and <<xpack-uptime,*Uptime*>>.
{kib} supplies alerts types in two ways: some are built into {kib}, while domain-specific alert types are registered by {kib} apps such as <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, and <<uptime-app,*Uptime*>>.
This section covers built-in alert types. For domain-specific alert types, refer to the documentation for that app.

View file

@ -6,7 +6,7 @@ beta[]
--
Alerting allows you to detect complex conditions within different {kib} apps and trigger actions when those conditions are met. Alerting is integrated with <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*Security*>>, <<xpack-uptime,*Uptime*>>, can be centrally managed from the <<management,*Management*>> UI, and provides a set of built-in <<action-types, actions>> and <<alert-types, alerts>> for you to use.
Alerting allows you to detect complex conditions within different {kib} apps and trigger actions when those conditions are met. Alerting is integrated with <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, <<xpack-siem,*Security*>>, <<uptime-app,*Uptime*>>, can be centrally managed from the <<management,*Management*>> UI, and provides a set of built-in <<action-types, actions>> and <<alert-types, alerts>> for you to use.
image::images/alerting-overview.png[Alerts and actions UI]
@ -148,7 +148,7 @@ Functionally, {kib} alerting differs in that:
* {kib} alerts tracks and persists the state of each detected condition through *alert instances*. This makes it possible to mute and throttle individual instances, and detect changes in state such as resolution.
* Actions are linked to *alert instances* in {kib} alerting. Actions are fired for each occurrence of a detected condition, rather than for the entire alert.
At a higher level, {kib} alerts allow rich integrations across use cases like <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*Security*>>, and <<xpack-uptime,*Uptime*>>.
At a higher level, {kib} alerts allow rich integrations across use cases like <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, <<xpack-siem,*Security*>>, and <<uptime-app,*Uptime*>>.
Pre-packaged *alert types* simplify setup, hide the details complex domain-specific detections, while providing a consistent interface across {kib}.
[float]
@ -170,9 +170,9 @@ If you are using an *on-premises* Elastic Stack deployment with <<using-kibana-w
To access alerting in a space, a user must have access to one of the following features:
* <<xpack-apm,*APM*>>
* <<xpack-infra,*Metrics*>>
* <<metrics-app,*Metrics*>>
* <<xpack-siem,*Security*>>
* <<xpack-uptime,*Uptime*>>
* <<uptime-app,*Uptime*>>
See <<kibana-feature-privileges, feature privileges>> for more information on configuring roles that provide access to these features.

View file

@ -2,7 +2,7 @@
[[defining-alerts]]
== Defining alerts
{kib} alerts can be created in a variety of apps including <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*Security*>>, <<xpack-uptime,*Uptime*>> and from <<management,*Management*>> UI. While alerting details may differ from app to app, they share a common interface for defining and configuring alerts that this section describes in more detail.
{kib} alerts can be created in a variety of apps including <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, <<xpack-siem,*Security*>>, <<uptime-app,*Uptime*>> and from <<management,*Management*>> UI. While alerting details may differ from app to app, they share a common interface for defining and configuring alerts that this section describes in more detail.
[float]
=== Alert flyout

View file

@ -27,14 +27,8 @@ include::graph/index.asciidoc[]
include::{kib-repo-dir}/observability/index.asciidoc[]
include::{kib-repo-dir}/logs/index.asciidoc[]
include::{kib-repo-dir}/infrastructure/index.asciidoc[]
include::{kib-repo-dir}/apm/index.asciidoc[]
include::{kib-repo-dir}/uptime/index.asciidoc[]
include::{kib-repo-dir}/siem/index.asciidoc[]
include::dev-tools.asciidoc[]