Skip to content

Commit

Permalink
Merge branch 'master' into uptime_edit-alerts-ahead
Browse files Browse the repository at this point in the history
  • Loading branch information
shahzad31 committed Jun 5, 2020
2 parents 4af3d19 + 99a6435 commit a372640
Show file tree
Hide file tree
Showing 555 changed files with 11,729 additions and 3,837 deletions.
2 changes: 1 addition & 1 deletion .node-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
10.19.0
10.21.0
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
10.19.0
10.21.0
2 changes: 1 addition & 1 deletion .sass-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ files:
- 'src/legacy/core_plugins/timelion/**/*.s+(a|c)ss'
- 'src/plugins/vis_type_vislib/**/*.s+(a|c)ss'
- 'src/plugins/vis_type_xy/**/*.s+(a|c)ss'
- 'x-pack/legacy/plugins/security/**/*.s+(a|c)ss'
- 'x-pack/plugins/canvas/**/*.s+(a|c)ss'
- 'x-pack/plugins/triggers_actions_ui/**/*.s+(a|c)ss'
- 'x-pack/plugins/lens/**/*.s+(a|c)ss'
- 'x-pack/plugins/cross_cluster_replication/**/*.s+(a|c)ss'
- 'x-pack/legacy/plugins/maps/**/*.s+(a|c)ss'
- 'x-pack/plugins/maps/**/*.s+(a|c)ss'
- 'x-pack/plugins/spaces/**/*.s+(a|c)ss'
- 'x-pack/plugins/security/**/*.s+(a|c)ss'
ignore:
- 'x-pack/plugins/canvas/shareable_runtime/**/*.s+(a|c)ss'
rules:
Expand Down
2 changes: 1 addition & 1 deletion docs/apm/advanced-queries.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ or, to only show transactions that are slower than a specified time threshold.
==== Example APM app queries

* Exclude response times slower than 2000 ms: `transaction.duration.us > 2000000`
* Filter by response status code: `context.response.status_code >= 400`
* Filter by response status code: `context.response.status_code 400`
* Filter by single user ID: `context.user.id : 12`

When querying in the APM app, you're merely searching and selecting data from fields in Elasticsearch documents.
Expand Down
18 changes: 9 additions & 9 deletions docs/apm/service-maps.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ Machine learning jobs can be created to calculate anomaly scores on APM transact
When these jobs are active, service maps will display a color-coded anomaly indicator based on the detected anomaly score:

[horizontal]
image:apm/images/green-service.png[APM green service]:: Max anomaly score **<=25**. Service is healthy.
image:apm/images/green-service.png[APM green service]:: Max anomaly score **25**. Service is healthy.
image:apm/images/yellow-service.png[APM yellow service]:: Max anomaly score **26-74**. Anomalous activity detected. Service may be degraded.
image:apm/images/red-service.png[APM red service]:: Max anomaly score **>=75**. Anomalous activity detected. Service is unhealthy.
image:apm/images/red-service.png[APM red service]:: Max anomaly score **75**. Anomalous activity detected. Service is unhealthy.

[role="screenshot"]
image::apm/images/apm-service-map-anomaly.png[Example view of anomaly scores on service maps in the APM app]
Expand Down Expand Up @@ -92,10 +92,10 @@ Type and subtype are based on `span.type`, and `span.subtype`.
Service maps are supported for the following Agent versions:

[horizontal]
Go Agent:: >= v1.7.0
Java Agent:: >= v1.13.0
.NET Agent:: >= v1.3.0
Node.js Agent:: >= v3.6.0
Python Agent:: >= v5.5.0
Ruby Agent:: >= v3.6.0
Real User Monitoring (RUM) Agent:: >= v4.7.0
Go Agent:: v1.7.0
Java Agent:: v1.13.0
.NET Agent:: v1.3.0
Node.js Agent:: v3.6.0
Python Agent:: v5.5.0
Ruby Agent:: v3.6.0
Real User Monitoring (RUM) Agent:: v4.7.0
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@
| [SearchBar](./kibana-plugin-plugins-data-public.searchbar.md) | |
| [SYNC\_SEARCH\_STRATEGY](./kibana-plugin-plugins-data-public.sync_search_strategy.md) | |
| [syncQueryStateWithUrl](./kibana-plugin-plugins-data-public.syncquerystatewithurl.md) | Helper to setup syncing of global data with the URL |
| [UI\_SETTINGS](./kibana-plugin-plugins-data-public.ui_settings.md) | |

## Type Aliases

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [UI\_SETTINGS](./kibana-plugin-plugins-data-public.ui_settings.md)

## UI\_SETTINGS variable

<b>Signature:</b>

```typescript
UI_SETTINGS: {
META_FIELDS: string;
DOC_HIGHLIGHT: string;
QUERY_STRING_OPTIONS: string;
QUERY_ALLOW_LEADING_WILDCARDS: string;
SEARCH_QUERY_LANGUAGE: string;
SORT_OPTIONS: string;
COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: string;
COURIER_SET_REQUEST_PREFERENCE: string;
COURIER_CUSTOM_REQUEST_PREFERENCE: string;
COURIER_MAX_CONCURRENT_SHARD_REQUESTS: string;
COURIER_BATCH_SEARCHES: string;
SEARCH_INCLUDE_FROZEN: string;
HISTOGRAM_BAR_TARGET: string;
HISTOGRAM_MAX_BARS: string;
HISTORY_LIMIT: string;
SHORT_DOTS_ENABLE: string;
FORMAT_DEFAULT_TYPE_MAP: string;
FORMAT_NUMBER_DEFAULT_PATTERN: string;
FORMAT_PERCENT_DEFAULT_PATTERN: string;
FORMAT_BYTES_DEFAULT_PATTERN: string;
FORMAT_CURRENCY_DEFAULT_PATTERN: string;
FORMAT_NUMBER_DEFAULT_LOCALE: string;
TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: string;
TIMEPICKER_QUICK_RANGES: string;
INDEXPATTERN_PLACEHOLDER: string;
FILTERS_PINNED_BY_DEFAULT: string;
FILTERS_EDITOR_SUGGEST_VALUES: string;
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
| [fieldFormats](./kibana-plugin-plugins-data-server.fieldformats.md) | |
| [indexPatterns](./kibana-plugin-plugins-data-server.indexpatterns.md) | |
| [search](./kibana-plugin-plugins-data-server.search.md) | |
| [UI\_SETTINGS](./kibana-plugin-plugins-data-server.ui_settings.md) | |

## Type Aliases

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [UI\_SETTINGS](./kibana-plugin-plugins-data-server.ui_settings.md)

## UI\_SETTINGS variable

<b>Signature:</b>

```typescript
UI_SETTINGS: {
META_FIELDS: string;
DOC_HIGHLIGHT: string;
QUERY_STRING_OPTIONS: string;
QUERY_ALLOW_LEADING_WILDCARDS: string;
SEARCH_QUERY_LANGUAGE: string;
SORT_OPTIONS: string;
COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: string;
COURIER_SET_REQUEST_PREFERENCE: string;
COURIER_CUSTOM_REQUEST_PREFERENCE: string;
COURIER_MAX_CONCURRENT_SHARD_REQUESTS: string;
COURIER_BATCH_SEARCHES: string;
SEARCH_INCLUDE_FROZEN: string;
HISTOGRAM_BAR_TARGET: string;
HISTOGRAM_MAX_BARS: string;
HISTORY_LIMIT: string;
SHORT_DOTS_ENABLE: string;
FORMAT_DEFAULT_TYPE_MAP: string;
FORMAT_NUMBER_DEFAULT_PATTERN: string;
FORMAT_PERCENT_DEFAULT_PATTERN: string;
FORMAT_BYTES_DEFAULT_PATTERN: string;
FORMAT_CURRENCY_DEFAULT_PATTERN: string;
FORMAT_NUMBER_DEFAULT_LOCALE: string;
TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: string;
TIMEPICKER_QUICK_RANGES: string;
INDEXPATTERN_PLACEHOLDER: string;
FILTERS_PINNED_BY_DEFAULT: string;
FILTERS_EDITOR_SUGGEST_VALUES: string;
}
```
2 changes: 1 addition & 1 deletion docs/infrastructure/infra-ui.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,5 +109,5 @@ Depending on the features you have installed and configured, you may also be abl

* Select *View APM* to <<traces, view APM traces>> in the *APM* app.

* Select *View Uptime* to <<uptime-overview, view uptime information>> in the *Uptime* app.
* Select *View Uptime* to {uptime-guide}/uptime-app-overview.html[view uptime information] in the *Uptime* app.

2 changes: 1 addition & 1 deletion docs/logs/using.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,5 @@ When the machine learning anomaly detection features are enabled, click *Log rat
To see other actions related to the event, click *Actions* in the log event details.
Depending on the event and the features you have configured, you may also be able to:

* Select *View status in Uptime* to <<uptime-overview, view related uptime information>> in the *Uptime* app.
* Select *View status in Uptime* to {uptime-guide}/uptime-app-overview.html[view related uptime information] in the *Uptime* app.
* Select *View in APM* to <<traces, view related APM traces>> in the *APM* app.
Original file line number Diff line number Diff line change
@@ -1,30 +1,33 @@
[role="xpack"]
[[uptime-alerting]]

== Uptime alerting
=== Uptime alerting

The Uptime app integrates with Kibana's {kibana-ref}/alerting-getting-started.html[alerting and actions]
feature. It provides a set of built-in actions and Uptime specific threshold alerts for you to use
and enables central management of all alerts from <<management, Kibana Management>>.
and enables central management of all alerts from {kibana-ref}/management.html[Kibana Management].

[role="screenshot"]
image::images/create-alert.png[Create alert]

[float]
=== Monitor status alerts
==== Monitor status alerts

To receive alerts when a monitor goes down, use the alerting menu at the top of the
overview page. Use a query in the alert flyout to determine which monitors to check
with your alert. If you already have a query in the overview page search bar it will
be carried over into this box.

[role="screenshot"]
image::uptime/images/monitor-status-alert-flyout.png[Create monitor status alert flyout]
image::images/monitor-status-alert.png[Create monitor status alert flyout]

[float]
=== TLS alerts
==== TLS alerts

Uptime also provides the ability to create an alert that will notify you when one or
more of your monitors have a TLS certificate that will expire within some threshold,
or when its age exceeds a limit. The values for these thresholds are configurable on
the <<uptime-settings, Settings page>>.

[role="screenshot"]
image::uptime/images/tls-alert-flyout.png[Create TLS alert flyout]
image::images/tls-alert.png[Create TLS alert flyout]
70 changes: 70 additions & 0 deletions docs/uptime-guide/app-overview.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
[role="xpack"]
[[uptime-app]]
== Uptime app

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]

[role="xpack"]
[[uptime-app-overview]]
=== Overview

The Uptime overview helps you quickly identify and diagnose outages and
other connectivity issues within your network or environment. You can use the date range
selection that is global to the Uptime app, to highlight
an absolute date range, or a relative one, similar to other areas of {kib}.

[float]
=== Filter bar

The Filter bar enables you to quickly view specific groups of monitors, or even
an individual monitor if you have defined many.

This control allows you to use automated filter options, as well as input custom filter
text to select specific monitors by field, URL, ID, and other attributes.

[role="screenshot"]
image::images/filter-bar.png[Filter bar]

[float]
=== Snapshot panel

The Snapshot panel displays the overall
status of the environment you're monitoring or a subset of those monitors.
You can see the total number of detected monitors within the selected
Uptime date range, along with the number of monitors
in an `up` or `down` state, which is based on the last check reported by Heartbeat
for each monitor.

Next to the counts, there is a histogram displaying the change over time throughout the
selected date range.

[role="screenshot"]
image::images/snapshot-view.png[Snapshot view]

[float]
=== Monitor list

Information about individual monitors is displayed in the monitor list and provides a quick
way to navigate to a more in-depth visualization for interesting hosts or endpoints.

The information displayed includes the recent status of a host or endpoint, when the monitor was last checked, its
ID and URL, and its IP address. There is also sparkline showing its check status over time.

[role="screenshot"]
image::images/monitor-list.png[Monitor list]

[float]
=== Observability integrations

The Monitor list also contains a menu of available integrations. When Uptime detects Kubernetes or
Docker related host information, it provides links to open the Metrics app or Logs app pre-filtered
for this host. Additionally, to help you quickly determine if these solutions contain data relevant to you,
this feature contains links to filter the other views on the host's IP address.

[role="screenshot"]
image::images/observability_integrations.png[Observability integrations]
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[role="xpack"]
[[uptime-certificates]]

== Certificates
=== Certificates

[role="screenshot"]
image::uptime/images/certificates-page.png[Certificates]

The certificates page allows you to visualize TLS certificate data in your indices. In addition to the
The certificates page enables you to visualize TLS certificate data in your indices. In addition to the
common name, associated monitors, issuer information, and SHA fingerprints, Uptime also assigns a status
derived from the threshold values in the <<uptime-settings, Settings page>>.

Several of the columns on this page are sortable. You can use the search bar at the top of the view
to find values in most of the TLS-related fields in your Uptime indices. Additionally, you can
create a TLS alert using the `Alerts` dropdown at the top of the page.
to find values in most of the TLS-related fields in your Uptime indices. Additionally, using the `Alerts`
dropdown at the top of the page you can create a TLS alert.

[role="screenshot"]
image::images/certificates-page.png[Certificates]
18 changes: 10 additions & 8 deletions docs/uptime-guide/deployment-arch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,24 @@

There are multiple ways to deploy Uptime and Heartbeat.
Use the information in this section to determine the best deployment for you.
A guiding principle is that an outage that takes down the service being monitored should not also take down Heartbeat.
You want Heartbeat to be functioning even when your service is not, so the guidelines here help you maximise this possibility.
A guiding principle is that when an outage takes down the service being monitored it should not also take down Heartbeat.
You want Heartbeat to be functioning even when your service is not, so the guidelines here help you maximize this possibility.

Heartbeat is generally run as a centralized service within a data center.
Heartbeat is commonly run as a centralized service within a data center.
While it is possible to run it as a separate "sidecar" process paired with each process/container, we recommend against it.
Running Heartbeat centrally ensures you will still be able to see monitoring data in the event of an overloaded, disconnected, or otherwise malfunctioning server.

For further redundancy, you may want to deploy multiple Heartbeats across geographic and/or network boundaries to provide more data.
Specify Heartbeat's observer {heartbeat-ref}/configuration-observer-options.html[geo options] to do so. Some examples might be:
For further redundancy, you may want to deploy multiple Heartbeats across geographic and network boundaries to provide more data.
To do so, specify Heartbeat's observer {heartbeat-ref}/configuration-observer-options.html[geo options].

Some examples might be:

* **A site served from a content delivery network (CDN) with points of presence (POPs) around the globe:**
In this case you may want to have multiple Heartbeat instances at different data centers around the world checking to see if your site is reachable via local CDN POPs.
To check if your site is reachable via CDN POPS, you may want to have multiple Heartbeat instances at different data centers around the world.
* **A service within a single data center that is accessed across multiple VPNs:**
Set up one Heartbeat instance within the VPN the service operates from, and another within an additional VPN that users access the service from.
Having both instances will help pinpoint network errors in the event of an outage.
Having both instances helps pinpoint network errors in the event of an outage.
* **A single service running primarily in a US east coast data center, with a hot failover located in a US west coast data center:**
In each data center, run a Heartbeat instance that checks both the local copy of the service and its counterpart across the country.
Set up two monitors in each region, one for the local service and one for the remote service.
In the event of a data center failure it will be immediately obvious if the service had a connectivity issue to the outside world or if the failure was only internal.
In the event of a data center failure it will be immediately apparent if the service had a connectivity issue to the outside world or if the failure was only internal.
Binary file added docs/uptime-guide/images/cert-exp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Binary file added docs/uptime-guide/images/create-alert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Binary file added docs/uptime-guide/images/indices.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/uptime-guide/images/tls-alert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/uptime-guide/images/uptime-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 10 additions & 2 deletions docs/uptime-guide/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
// short-version can be: 8, 7, 6, etc.
:short-version: 8

include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
Expand All @@ -12,3 +10,13 @@ include::install.asciidoc[]

include::deployment-arch.asciidoc[]

include::app-overview.asciidoc[]

include::monitor.asciidoc[]

include::settings.asciidoc[]

include::certificates.asciidoc[]

include::alerting.asciidoc[]

Loading

0 comments on commit a372640

Please sign in to comment.