Backport to 6.4: mutliple doc changes (elastic#7967 elastic#8226 elas…

…tic#8290 elastic#8395 elastic#8446 elastic#8478) (elastic#8528) * Clarify support for ssl options for modules (elastic#7967) * Clarify support for ssl options for modules * Change example to show http module * Update Elasticsearch module examples to show http in the URL (elastic#8226) * Improve reference docs that describe how to set options dynamically (elastic#8290) * Improve Elasticsearch output docs about indices, pipelines, and keys settings * Updates from review * Change setting name from mapping to mappings * Remove note to reviewer * Fix conditional coding (elastic#8446) * Suppress dashboard info when dashboards aren't available (elastic#8395) * Clarify add_docker_metadata docs (elastic#8478)
jsoriano · Oct 19, 2018 · c3de428 · c3de428
1 parent 623ae53
commit c3de428
Show file tree

Hide file tree

Showing 45 changed files with 505 additions and 93 deletions.
diff --git a/filebeat/docs/include/setup-command.asciidoc b/filebeat/docs/include/setup-command.asciidoc
@@ -21,8 +21,8 @@ PS > .{backslash}{beatname_lc}.exe setup -e
 ----
 
 The <<setup-command,`setup`>> command loads the recommended index template for
-writing to {es} and deploys the sample dashboards for visualizing the
-data in {kib}. This is a one-time setup step. 
+writing to {es} and deploys the sample dashboards (if available) for visualizing
+the data in {kib}. This is a one-time setup step. 
 
 The `-e` flag is optional and sends output to standard error instead of syslog.
 --
diff --git a/filebeat/docs/include/visualize-data.asciidoc b/filebeat/docs/include/visualize-data.asciidoc
@@ -1,3 +1,4 @@
+ifeval::["{has-dashboards}"=="true"]
 . Explore your data in {kib}:
 +
 .. Open your browser and navigate to the *Dashboard* overview in {kib}:
@@ -11,3 +12,4 @@ the visualizations for your parsed logs.
 +
 TIP: If you don’t see data in {kib}, try changing the date range to a larger
 range. By default, {kib} shows the last 15 minutes.
+endif::[]
diff --git a/filebeat/docs/include/what-happens.asciidoc b/filebeat/docs/include/what-happens.asciidoc
@@ -8,5 +8,6 @@ defaults)
 * Uses ingest node to parse and process the log lines, shaping the data into a structure suitable
 for visualizing in Kibana
 
+ifeval::["{has-dashboards}"=="true"]
 * Deploys dashboards for visualizing the log data
-  
+endif::[]
diff --git a/filebeat/docs/modules-getting-started.asciidoc b/filebeat/docs/modules-getting-started.asciidoc
@@ -6,9 +6,9 @@
 
 {beatname_uc} provides a set of pre-built modules that you can use to rapidly
 implement and deploy a log monitoring solution, complete with sample dashboards
-and data visualizations, in about 5 minutes. These modules support common log
-formats, such as Nginx, Apache2, and MySQL, and can be run by issuing a simple
-command.
+and data visualizations (when available), in about 5 minutes. These modules
+support common log formats, such as Nginx, Apache2, and MySQL, and can be run by
+issuing a simple command.
 
 This topic shows you how to run the basic modules with minimal extra
 configuration. For detailed documentation and the full list of available

diff --git a/filebeat/docs/modules-overview.asciidoc b/filebeat/docs/modules-overview.asciidoc
@@ -20,7 +20,8 @@ the following:
   correct types for each field. They also contain short descriptions for each
   of the fields.
 
-* Sample Kibana dashboards, which can be used to visualize the log files.
+* Sample Kibana dashboards, when available, that can be used to visualize the
+log files.
 
 {beatname_uc} automatically adjusts these configurations based on your environment
 and loads them to the respective Elastic stack components.

diff --git a/filebeat/docs/modules/apache2.asciidoc b/filebeat/docs/modules/apache2.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-apache2]]
 :modulename: apache2
+:has-dashboards: true
 
 == Apache2 module
 
@@ -75,6 +76,12 @@ include::../include/var-paths.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/auditd.asciidoc b/filebeat/docs/modules/auditd.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-auditd]]
 :modulename: auditd
+:has-dashboards: true
 
 == Auditd module
 
@@ -66,6 +67,12 @@ include::../include/config-option-intro.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/elasticsearch.asciidoc b/filebeat/docs/modules/elasticsearch.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-elasticsearch]]
 :modulename: elasticsearch
+:has-dashboards: false
 
 == Elasticsearch module
 
@@ -33,6 +34,12 @@ include::../include/config-option-intro.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/icinga.asciidoc b/filebeat/docs/modules/icinga.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-icinga]]
 :modulename: icinga
+:has-dashboards: true
 
 == Icinga module
 
@@ -80,6 +81,12 @@ include::../include/var-paths.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/iis.asciidoc b/filebeat/docs/modules/iis.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-iis]]
 :modulename: iis
+:has-dashboards: true
 
 == IIS module
 
@@ -70,6 +71,12 @@ include::../include/var-paths.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/kafka.asciidoc b/filebeat/docs/modules/kafka.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-kafka]]
 :modulename: kafka
+:has-dashboards: true
 
 == Kafka module
 
@@ -65,6 +66,12 @@ include::../include/var-paths.asciidoc[]
 
 include::../include/var-convert-timezone.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/kibana.asciidoc b/filebeat/docs/modules/kibana.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-kibana]]
 :modulename: kibana
+:has-dashboards: false
 
 == Kibana module
 
@@ -33,8 +34,12 @@ include::../include/config-option-intro.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
 :fileset_ex!:
 
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/logstash.asciidoc b/filebeat/docs/modules/logstash.asciidoc
@@ -4,6 +4,8 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-logstash]]
 :modulename: logstash
+:has-dashboards: true
+
 == Logstash module
 
 The +{modulename}+ module parse logstash regular logs and the slow log, it will support the plain text format
@@ -92,6 +94,12 @@ include::../include/var-paths.asciidoc[]
 The configured Logstash log format. Possible values are: `json` or `plain`. The
 default is `plain`.
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/mongodb.asciidoc b/filebeat/docs/modules/mongodb.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-mongodb]]
 :modulename: mongodb
+:has-dashboards: true
 
 == MongoDB module
 
@@ -60,6 +61,12 @@ include::../include/config-option-intro.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/mysql.asciidoc b/filebeat/docs/modules/mysql.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-mysql]]
 :modulename: mysql
+:has-dashboards: true
 
 == MySQL module
 
@@ -71,6 +72,12 @@ include::../include/var-paths.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/nginx.asciidoc b/filebeat/docs/modules/nginx.asciidoc
@@ -4,6 +4,8 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-nginx]]
 :modulename: nginx
+:has-dashboards: true
+
 
 == Nginx module
 
@@ -76,6 +78,12 @@ include::../include/var-paths.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/osquery.asciidoc b/filebeat/docs/modules/osquery.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-osquery]]
 :modulename: osquery
+:has-dashboards: true
 
 == Osquery module
 
@@ -71,6 +72,12 @@ setting also disables the renaming of some fields (e.g. `hostIdentifier` to
 `host_identifier`).  Note that if you set this to false, the sample dashboards
 coming with this module won't work correctly. The default is true.
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/postgresql.asciidoc b/filebeat/docs/modules/postgresql.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-postgresql]]
 :modulename: postgresql
+:has-dashboards: true
 
 == PostgreSQL module
 
@@ -69,6 +70,12 @@ include::../include/config-option-intro.asciidoc[]
 include::../include/var-paths.asciidoc[]
 
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
+
 
 [float]
 === Fields

diff --git a/filebeat/docs/modules/redis.asciidoc b/filebeat/docs/modules/redis.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-redis]]
 :modulename: redis
+:has-dashboards: true
 
 == Redis module
 
@@ -97,6 +98,11 @@ left empty, `localhost:6379` is assumed.
 The password to use to connect to Redis, in case Redis authentication is enabled
 (the `requirepass` option in the Redis configuration).
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
 
 
 [float]

diff --git a/filebeat/docs/modules/system.asciidoc b/filebeat/docs/modules/system.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-system]]
 :modulename: system
+:has-dashboards: true
 
 == System module
 
@@ -81,7 +82,11 @@ include::../include/var-paths.asciidoc[]
 
 include::../include/var-convert-timezone.asciidoc[]
 
+:has-dashboards!:
 
+:fileset_ex!:
+
+:modulename!:
 
 
 [float]

diff --git a/filebeat/docs/modules/traefik.asciidoc b/filebeat/docs/modules/traefik.asciidoc
@@ -4,6 +4,7 @@ This file is generated! See scripts/docs_collector.py
 
 [[filebeat-module-traefik]]
 :modulename: traefik
+:has-dashboards: true
 
 == Traefik module
 
@@ -61,6 +62,11 @@ include::../include/config-option-intro.asciidoc[]
 
 include::../include/var-paths.asciidoc[]
 
+:has-dashboards!:
+
+:fileset_ex!:
+
+:modulename!:
 
 
 [float]