Skip to content

Commit 7047994

Browse files
committed
[DOCS] Copies x-pack folders to docs
1 parent 32639a9 commit 7047994

25 files changed

+687
-0
lines changed

docs/en/stack/InstallationFlow.jpg

52.5 KB
Loading

docs/en/stack/gs-index.asciidoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
= X-Pack for the Elastic Stack
2+
:doctype: book
3+
4+
:forum: https://discuss.elastic.co/c/x-pack
5+
:security-forum: https://discuss.elastic.co/c/shield
6+
:watcher-forum: https://discuss.elastic.co/c/watcher
7+
:monitoring-forum: https://discuss.elastic.co/c/marvel
8+
:graph-forum: https://discuss.elastic.co/c/graph
9+
10+
include::{asciidoc-dir}/../../shared/versions60.asciidoc[]
11+
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
12+
13+
:xkb-repo-dir: {docdir}/../../../kibana-extra/x-pack-kibana/docs/en
14+
:xes-repo-dir: {docdir}/../../../elasticsearch-extra/x-pack-elasticsearch/docs/en
15+
16+
:gs-mini: true
17+
18+
19+
include::xpack-introduction.asciidoc[]
20+
21+
include::xpack-installing.asciidoc[]
22+
23+
include::{xes-repo-dir}/security/gs-index.asciidoc[]
24+
25+
include::{xkb-repo-dir}/monitoring/gs-index.asciidoc[]
26+
27+
include::{xes-repo-dir}/watcher/gs-index.asciidoc[]
28+
29+
include::{xkb-repo-dir}/reporting/gs-index.asciidoc[]
30+
31+
include::{xkb-repo-dir}/graph/gs-index.asciidoc[]
32+
33+
include::{xkb-repo-dir}/searchprofiler/gs-index.asciidoc[]
52.5 KB
Loading

docs/en/stack/index.asciidoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
= Elastic Stack Overview
2+
3+
:doctype: book
4+
5+
:forum: https://discuss.elastic.co/c/x-pack
6+
:security-forum: https://discuss.elastic.co/c/shield
7+
:watcher-forum: https://discuss.elastic.co/c/watcher
8+
:monitoring-forum: https://discuss.elastic.co/c/marvel
9+
:graph-forum: https://discuss.elastic.co/c/graph
10+
11+
:blog-ref: https://www.elastic.co/blog/
12+
:wikipedia: https://en.wikipedia.org/wiki
13+
14+
:xkb-repo-dir: {docdir}/../../../../../kibana/x-pack/docs/en
15+
:kib-repo-dir: {docdir}/../../../../../kibana/docs
16+
:xes-repo-dir: {docdir}/../../../../../elasticsearch/x-pack/docs/en
17+
:es-repo-dir: {docdir}/../../../../../elasticsearch/docs
18+
19+
include::{asciidoc-dir}/../../shared/versions.asciidoc[]
20+
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
21+
22+
include::xpack-introduction.asciidoc[]
23+
24+
include::xpack-setup.asciidoc[]
25+
26+
include::xpack-breaking-changes.asciidoc[]
27+
28+
include::xpack-apis.asciidoc[]
29+
30+
include::xpack-features.asciidoc[]
31+
32+
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/index.asciidoc
33+
include::{xes-repo-dir}/security/index.asciidoc[]
34+
35+
:edit_url:
36+
include::monitoring/index.asciidoc[]
37+
38+
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/watcher/index.asciidoc
39+
include::{xes-repo-dir}/watcher/index.asciidoc[]
40+
41+
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/ml/index.asciidoc
42+
include::{xes-repo-dir}/ml/index.asciidoc[]
43+
44+
:edit_url:
45+
include::xpack-troubleshooting.asciidoc[]
46+
47+
:edit_url:
48+
include::xpack-limitations.asciidoc[]
49+
50+
:edit_url:
51+
include::xpack-license.asciidoc[]
52+
53+
include::xpack-release-notes.asciidoc[]
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[[how-monitoring-works]]
2+
== How monitoring works
3+
4+
Monitoring collects data from {es} nodes, Logstash nodes, and {kib} instances.
5+
The {es} cluster you are monitoring controls where the monitoring metrics for
6+
the entire stack are stored. By default, they are stored in local indices. In
7+
production, we strongly recommend using a separate monitoring cluster. Using a
8+
separate monitoring cluster prevents production cluster outages from impacting
9+
your ability to access your monitoring data. It also prevents monitoring
10+
activities from impacting the performance of your production cluster.
11+
12+
IMPORTANT: In general, the monitoring cluster and the clusters being monitored
13+
should be running the same version of the stack. A monitoring cluster cannot
14+
monitor production clusters running newer versions of the stack. If necessary,
15+
the monitoring cluster can monitor production clusters running older versions,
16+
but the versions cannot differ by more than one major version.
17+
18+
The following diagram illustrates a typical monitoring architecture with
19+
separate production and monitoring clusters:
20+
21+
image::monitoring/images/architecture1.jpg[A typical monitoring environment]
22+
23+
If you have at least a Gold license, you can route data from multiple production
24+
clusters to a single monitoring cluster:
25+
26+
image::monitoring/images/architecture2.jpg[A monitoring environment with multiple production clusters]
27+
28+
If {kib} is a regular part of your stack, you might want to create a dedicated
29+
{kib} instance for monitoring, rather than using a single {kib} instance to
30+
access both your production cluster and monitoring cluster:
31+
32+
image::monitoring/images/architecture3.jpg[A monitoring environment with separate {kib} instances]
Loading
Loading
Loading
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
include::intro.asciidoc[]
2+
include::how-monitoring-works.asciidoc[]
3+
include::production.asciidoc[]
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[[xpack-monitoring]]
2+
= Monitoring the {stack}
3+
4+
[partintro]
5+
--
6+
7+
{monitoring} gives you insight into the operation of {es}, Logstash, and {kib}.
8+
All of the monitoring metrics are stored in {es}, which enables you to easily
9+
visualize the data from {kib}. From the {kib} Monitoring UI, you can spot issues
10+
at a glance and delve into the system behavior over time to diagnose operational
11+
issues. In addition to the built-in status warnings, you can set up custom alerts
12+
based on the data in the monitoring indices.
13+
14+
For more information, see:
15+
16+
* <<how-monitoring-works>>
17+
* <<monitoring-production>>
18+
* {ref}/es-monitoring.html[Monitoring {es}]
19+
* {kibana-ref}/xpack-monitoring.html[Monitoring {kib}]
20+
* {logstash-ref}/monitoring-logstash.html[Monitoring Logstash]
21+
* Monitoring Beats:
22+
** {auditbeat-ref}/monitoring.html[Auditbeat]
23+
** {filebeat-ref}/monitoring.html[Filebeat]
24+
** {heartbeat-ref}/monitoring.html[Heartbeat]
25+
** {metricbeat-ref}/monitoring.html[Metricbeat]
26+
** {packetbeat-ref}/monitoring.html[Packetbeat]
27+
** {winlogbeat-ref}/monitoring.html[Winlogbeat]
28+
29+
30+
31+
--

0 commit comments

Comments
 (0)