From 2460e276979f91f1ea22d421e66d0fa763fc7af2 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Thu, 21 Nov 2019 18:42:22 -0800 Subject: [PATCH] [DOCS] Include doc dir in libbeat path variable (#14630) (#14693) --- auditbeat/docs/auditbeat-filtering.asciidoc | 4 +-- .../docs/auditbeat-general-options.asciidoc | 2 +- auditbeat/docs/configuring-howto.asciidoc | 30 ++++++++-------- auditbeat/docs/faq.asciidoc | 4 +-- auditbeat/docs/getting-started.asciidoc | 26 +++++++------- auditbeat/docs/index.asciidoc | 14 ++++---- auditbeat/docs/overview.asciidoc | 2 +- auditbeat/docs/running-on-docker.asciidoc | 2 +- auditbeat/docs/setting-up-running.asciidoc | 10 +++--- auditbeat/docs/troubleshooting.asciidoc | 4 +-- docs/devguide/index.asciidoc | 8 ++--- filebeat/docs/configuring-howto.asciidoc | 30 ++++++++-------- filebeat/docs/faq.asciidoc | 4 +-- filebeat/docs/filebeat-filtering.asciidoc | 4 +-- .../docs/filebeat-general-options.asciidoc | 2 +- .../docs/filebeat-modules-options.asciidoc | 2 +- filebeat/docs/getting-started.asciidoc | 26 +++++++------- filebeat/docs/index.asciidoc | 16 ++++----- .../docs/modules-getting-started.asciidoc | 4 +-- filebeat/docs/overview.asciidoc | 2 +- filebeat/docs/reload-configuration.asciidoc | 4 +-- filebeat/docs/running-on-docker.asciidoc | 2 +- filebeat/docs/setting-up-running.asciidoc | 10 +++--- filebeat/docs/troubleshooting.asciidoc | 4 +-- heartbeat/docs/configuring-howto.asciidoc | 32 ++++++++--------- heartbeat/docs/faq.asciidoc | 4 +-- heartbeat/docs/getting-started.asciidoc | 24 ++++++------- heartbeat/docs/heartbeat-filtering.asciidoc | 4 +-- .../docs/heartbeat-general-options.asciidoc | 2 +- heartbeat/docs/index.asciidoc | 14 ++++---- heartbeat/docs/overview.asciidoc | 2 +- heartbeat/docs/running-on-docker.asciidoc | 2 +- heartbeat/docs/setting-up-running.asciidoc | 10 +++--- heartbeat/docs/troubleshooting.asciidoc | 4 +-- journalbeat/docs/configuring-howto.asciidoc | 32 ++++++++--------- journalbeat/docs/faq.asciidoc | 4 +-- journalbeat/docs/filtering.asciidoc | 4 +-- journalbeat/docs/general-options.asciidoc | 2 +- journalbeat/docs/getting-started.asciidoc | 18 +++++----- journalbeat/docs/index.asciidoc | 12 +++---- journalbeat/docs/overview.asciidoc | 2 +- journalbeat/docs/running-on-docker.asciidoc | 2 +- journalbeat/docs/setting-up-running.asciidoc | 10 +++--- journalbeat/docs/troubleshooting.asciidoc | 4 +-- libbeat/docs/index.asciidoc | 6 ++-- libbeat/docs/outputs/output-logstash.asciidoc | 2 +- metricbeat/docs/configuring-howto.asciidoc | 32 ++++++++--------- metricbeat/docs/faq.asciidoc | 4 +-- metricbeat/docs/gettingstarted.asciidoc | 26 +++++++------- metricbeat/docs/index.asciidoc | 16 ++++----- metricbeat/docs/metricbeat-filtering.asciidoc | 4 +-- .../docs/metricbeat-general-options.asciidoc | 2 +- metricbeat/docs/metricbeat-options.asciidoc | 2 +- metricbeat/docs/overview.asciidoc | 2 +- metricbeat/docs/reload-configuration.asciidoc | 4 +-- metricbeat/docs/running-on-docker.asciidoc | 2 +- metricbeat/docs/setting-up-running.asciidoc | 10 +++--- metricbeat/docs/troubleshooting.asciidoc | 4 +-- packetbeat/docs/configuring-howto.asciidoc | 28 +++++++-------- packetbeat/docs/faq.asciidoc | 6 ++-- packetbeat/docs/gettingstarted.asciidoc | 26 +++++++------- packetbeat/docs/index.asciidoc | 14 ++++---- packetbeat/docs/overview.asciidoc | 2 +- packetbeat/docs/packetbeat-filtering.asciidoc | 4 +-- .../docs/packetbeat-general-options.asciidoc | 2 +- packetbeat/docs/running-on-docker.asciidoc | 2 +- packetbeat/docs/setting-up-running.asciidoc | 10 +++--- packetbeat/docs/troubleshooting.asciidoc | 4 +-- winlogbeat/docs/configuring-howto.asciidoc | 28 +++++++-------- winlogbeat/docs/faq.asciidoc | 2 +- winlogbeat/docs/getting-started.asciidoc | 16 ++++----- winlogbeat/docs/index.asciidoc | 12 +++---- winlogbeat/docs/overview.asciidoc | 2 +- winlogbeat/docs/setting-up-running.asciidoc | 8 ++--- winlogbeat/docs/troubleshooting.asciidoc | 4 +-- winlogbeat/docs/winlogbeat-filtering.asciidoc | 4 +-- .../docs/winlogbeat-general-options.asciidoc | 2 +- .../docs/configuring-howto.asciidoc | 34 +++++++++---------- x-pack/functionbeat/docs/faq.asciidoc | 2 +- x-pack/functionbeat/docs/filtering.asciidoc | 4 +-- .../docs/general-options.asciidoc | 2 +- .../docs/getting-started.asciidoc | 12 +++---- x-pack/functionbeat/docs/index.asciidoc | 10 +++--- x-pack/functionbeat/docs/overview.asciidoc | 2 +- .../docs/setting-up-running.asciidoc | 6 ++-- .../docs/troubleshooting.asciidoc | 4 +-- 86 files changed, 386 insertions(+), 386 deletions(-) diff --git a/auditbeat/docs/auditbeat-filtering.asciidoc b/auditbeat/docs/auditbeat-filtering.asciidoc index 617660b6837d..c5dfdd554847 100644 --- a/auditbeat/docs/auditbeat-filtering.asciidoc +++ b/auditbeat/docs/auditbeat-filtering.asciidoc @@ -1,6 +1,6 @@ [[filtering-and-enhancing-data]] == Filter and enhance the exported data -include::{libbeat-dir}/docs/processors.asciidoc[] +include::{libbeat-dir}/processors.asciidoc[] -include::{libbeat-dir}/docs/processors-using.asciidoc[] +include::{libbeat-dir}/processors-using.asciidoc[] diff --git a/auditbeat/docs/auditbeat-general-options.asciidoc b/auditbeat/docs/auditbeat-general-options.asciidoc index df2e66555126..6fb7ba164e9b 100644 --- a/auditbeat/docs/auditbeat-general-options.asciidoc +++ b/auditbeat/docs/auditbeat-general-options.asciidoc @@ -4,4 +4,4 @@ You can specify settings in the +{beatname_lc}.yml+ config file to control the general behavior of {beatname_uc}. -include::{libbeat-dir}/docs/generalconfig.asciidoc[] +include::{libbeat-dir}/generalconfig.asciidoc[] diff --git a/auditbeat/docs/configuring-howto.asciidoc b/auditbeat/docs/configuring-howto.asciidoc index 0f6fd289c6f6..007a06704188 100644 --- a/auditbeat/docs/configuring-howto.asciidoc +++ b/auditbeat/docs/configuring-howto.asciidoc @@ -51,38 +51,38 @@ include::./auditbeat-general-options.asciidoc[] include::./reload-configuration.asciidoc[] -include::{libbeat-dir}/docs/queueconfig.asciidoc[] +include::{libbeat-dir}/queueconfig.asciidoc[] -include::{libbeat-dir}/docs/outputconfig.asciidoc[] +include::{libbeat-dir}/outputconfig.asciidoc[] -include::{libbeat-dir}/docs/shared-ilm.asciidoc[] +include::{libbeat-dir}/shared-ilm.asciidoc[] -include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[] +include::{libbeat-dir}/shared-ssl-config.asciidoc[] include::./auditbeat-filtering.asciidoc[] -include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[] +include::{libbeat-dir}/shared-config-ingest.asciidoc[] -include::{libbeat-dir}/docs/shared-geoip.asciidoc[] +include::{libbeat-dir}/shared-geoip.asciidoc[] -include::{libbeat-dir}/docs/shared-path-config.asciidoc[] +include::{libbeat-dir}/shared-path-config.asciidoc[] -include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[] +include::{libbeat-dir}/shared-kibana-config.asciidoc[] -include::{libbeat-dir}/docs/setup-config.asciidoc[] +include::{libbeat-dir}/setup-config.asciidoc[] -include::{libbeat-dir}/docs/loggingconfig.asciidoc[] +include::{libbeat-dir}/loggingconfig.asciidoc[] :standalone: -include::{libbeat-dir}/docs/shared-env-vars.asciidoc[] +include::{libbeat-dir}/shared-env-vars.asciidoc[] :standalone!: :standalone: -include::{libbeat-dir}/docs/yaml.asciidoc[] +include::{libbeat-dir}/yaml.asciidoc[] :standalone!: -include::{libbeat-dir}/docs/regexp.asciidoc[] +include::{libbeat-dir}/regexp.asciidoc[] -include::{libbeat-dir}/docs/http-endpoint.asciidoc[] +include::{libbeat-dir}/http-endpoint.asciidoc[] -include::{libbeat-dir}/docs/reference-yml.asciidoc[] +include::{libbeat-dir}/reference-yml.asciidoc[] diff --git a/auditbeat/docs/faq.asciidoc b/auditbeat/docs/faq.asciidoc index a5e7511c9e61..d0f4fbe8235e 100644 --- a/auditbeat/docs/faq.asciidoc +++ b/auditbeat/docs/faq.asciidoc @@ -7,6 +7,6 @@ https://discuss.elastic.co/c/beats/{beatname_lc}[{beatname_uc} discussion forum] include::./faq-ulimit.asciidoc[] -include::{libbeat-dir}/docs/faq-limit-bandwidth.asciidoc[] +include::{libbeat-dir}/faq-limit-bandwidth.asciidoc[] -include::{libbeat-dir}/docs/shared-faq.asciidoc[] +include::{libbeat-dir}/shared-faq.asciidoc[] diff --git a/auditbeat/docs/getting-started.asciidoc b/auditbeat/docs/getting-started.asciidoc index b3075ec21766..493160de8e09 100644 --- a/auditbeat/docs/getting-started.asciidoc +++ b/auditbeat/docs/getting-started.asciidoc @@ -1,7 +1,7 @@ [id="{beatname_lc}-getting-started"] == Getting started with {beatname_uc} -include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] +include::{libbeat-dir}/shared-getting-started-intro.asciidoc[] * <<{beatname_lc}-installation>> * <<{beatname_lc}-configuration>> @@ -16,7 +16,7 @@ include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] Install {beatname_uc} on all the servers you want to monitor. -include::{libbeat-dir}/docs/shared-download-and-install.asciidoc[] +include::{libbeat-dir}/shared-download-and-install.asciidoc[] [[deb]] *deb:* @@ -75,7 +75,7 @@ tar xzvf {beatname_lc}-{version}-darwin-x86_64.tar.gz endif::[] -include::{libbeat-dir}/docs/shared-brew-install.asciidoc[] +include::{libbeat-dir}/shared-brew-install.asciidoc[] [[linux]] *linux:* @@ -162,7 +162,7 @@ For more information about these options, see [id="{beatname_lc}-configuration"] === Step 2: Configure {beatname_uc} -include::{libbeat-dir}/docs/shared-configuring.asciidoc[] +include::{libbeat-dir}/shared-configuring.asciidoc[] To configure {beatname_uc}: @@ -192,25 +192,25 @@ If you accept the default configuration without specifying additional modules, + See <> for more details about configuring modules. -include::{libbeat-dir}/docs/step-configure-output.asciidoc[] +include::{libbeat-dir}/step-configure-output.asciidoc[] -include::{libbeat-dir}/docs/step-configure-kibana-endpoint.asciidoc[] +include::{libbeat-dir}/step-configure-kibana-endpoint.asciidoc[] -include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[] +include::{libbeat-dir}/step-configure-credentials.asciidoc[] -include::{libbeat-dir}/docs/step-test-config.asciidoc[] +include::{libbeat-dir}/step-test-config.asciidoc[] -include::{libbeat-dir}/docs/step-look-at-config.asciidoc[] +include::{libbeat-dir}/step-look-at-config.asciidoc[] [id="{beatname_lc}-template"] === Step 3: Load the index template in {es} -include::{libbeat-dir}/docs/shared-template-load.asciidoc[] +include::{libbeat-dir}/shared-template-load.asciidoc[] [[load-kibana-dashboards]] === Step 4: Set up the {kib} dashboards -include::{libbeat-dir}/docs/dashboards.asciidoc[] +include::{libbeat-dir}/dashboards.asciidoc[] [id="{beatname_lc}-starting"] === Step 5: Start {beatname_uc} @@ -246,7 +246,7 @@ in the _Beats Platform Reference_. If you see a warning about too many open files, you need to increase the `ulimit`. See the <> for more details. -include::{libbeat-dir}/docs/shared-brew-run.asciidoc[] +include::{libbeat-dir}/shared-brew-run.asciidoc[] *win:* @@ -280,7 +280,7 @@ To make it easier for you to start auditing the activities of users and processes on your system, we have created example {beatname_uc} dashboards. You loaded the dashboards earlier when you ran the `setup` command. -include::{libbeat-dir}/docs/opendashboards.asciidoc[] +include::{libbeat-dir}/opendashboards.asciidoc[] The dashboards are provided as examples. We recommend that you {kibana-ref}/dashboard.html[customize] them to meet your needs. diff --git a/auditbeat/docs/index.asciidoc b/auditbeat/docs/index.asciidoc index 9ce32ded405a..6de3c9db528b 100644 --- a/auditbeat/docs/index.asciidoc +++ b/auditbeat/docs/index.asciidoc @@ -1,8 +1,8 @@ = Auditbeat Reference -:libbeat-dir: {docdir}/../../libbeat +:libbeat-dir: {docdir}/../../libbeat/docs -include::{libbeat-dir}/docs/version.asciidoc[] +include::{libbeat-dir}/version.asciidoc[] include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] @@ -25,13 +25,13 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :no_script_processor: :no_timestamp_processor: -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./overview.asciidoc[] include::./getting-started.asciidoc[] -include::{libbeat-dir}/docs/repositories.asciidoc[] +include::{libbeat-dir}/repositories.asciidoc[] include::./setting-up-running.asciidoc[] @@ -43,13 +43,13 @@ include::./modules.asciidoc[] include::./fields.asciidoc[] -include::{libbeat-dir}/docs/monitoring/monitoring-beats.asciidoc[] +include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[] -include::{libbeat-dir}/docs/shared-securing-beat.asciidoc[] +include::{libbeat-dir}/shared-securing-beat.asciidoc[] include::./troubleshooting.asciidoc[] include::./faq.asciidoc[] -include::{libbeat-dir}/docs/contributing-to-beats.asciidoc[] +include::{libbeat-dir}/contributing-to-beats.asciidoc[] diff --git a/auditbeat/docs/overview.asciidoc b/auditbeat/docs/overview.asciidoc index 241e491f1803..951b9059583f 100644 --- a/auditbeat/docs/overview.asciidoc +++ b/auditbeat/docs/overview.asciidoc @@ -12,4 +12,4 @@ Audit Framework. You can also use {beatname_uc} to detect changes to critical files, like binaries and configuration files, and identify potential security policy violations. -include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[] +include::{libbeat-dir}/shared-libbeat-description.asciidoc[] diff --git a/auditbeat/docs/running-on-docker.asciidoc b/auditbeat/docs/running-on-docker.asciidoc index 216e1abfce04..74007cdeb357 100644 --- a/auditbeat/docs/running-on-docker.asciidoc +++ b/auditbeat/docs/running-on-docker.asciidoc @@ -1,4 +1,4 @@ -include::{libbeat-dir}/docs/shared-docker.asciidoc[] +include::{libbeat-dir}/shared-docker.asciidoc[] ==== Special requirements diff --git a/auditbeat/docs/setting-up-running.asciidoc b/auditbeat/docs/setting-up-running.asciidoc index 724c003f5d40..05e68bb9d52b 100644 --- a/auditbeat/docs/setting-up-running.asciidoc +++ b/auditbeat/docs/setting-up-running.asciidoc @@ -27,16 +27,16 @@ This section includes additional information on how to set up and run //MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too. -include::{libbeat-dir}/docs/shared-directory-layout.asciidoc[] +include::{libbeat-dir}/shared-directory-layout.asciidoc[] -include::{libbeat-dir}/docs/keystore.asciidoc[] +include::{libbeat-dir}/keystore.asciidoc[] -include::{libbeat-dir}/docs/command-reference.asciidoc[] +include::{libbeat-dir}/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] include::./running-on-kubernetes.asciidoc[] -include::{libbeat-dir}/docs/shared-systemd.asciidoc[] +include::{libbeat-dir}/shared-systemd.asciidoc[] -include::{libbeat-dir}/docs/shared-shutdown.asciidoc[] +include::{libbeat-dir}/shared-shutdown.asciidoc[] diff --git a/auditbeat/docs/troubleshooting.asciidoc b/auditbeat/docs/troubleshooting.asciidoc index 4a7c4d8ba1aa..463f41231676 100644 --- a/auditbeat/docs/troubleshooting.asciidoc +++ b/auditbeat/docs/troubleshooting.asciidoc @@ -17,14 +17,14 @@ following tips: [[getting-help]] == Get Help -include::{libbeat-dir}/docs/getting-help.asciidoc[] +include::{libbeat-dir}/getting-help.asciidoc[] //sets block macro for debugging.asciidoc included in next section [id="enable-{beatname_lc}-debugging"] == Debug -include::{libbeat-dir}/docs/debugging.asciidoc[] +include::{libbeat-dir}/debugging.asciidoc[] diff --git a/docs/devguide/index.asciidoc b/docs/devguide/index.asciidoc index 2820c83f421f..a4d6fe873c8d 100644 --- a/docs/devguide/index.asciidoc +++ b/docs/devguide/index.asciidoc @@ -1,9 +1,9 @@ [[beats-reference]] = Beats Developer Guide -:libbeat-dir: {docdir}/../../libbeat +:libbeat-dir: {docdir}/../../libbeat/docs -include::{libbeat-dir}/docs/version.asciidoc[] +include::{libbeat-dir}/version.asciidoc[] include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] @@ -13,13 +13,13 @@ include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] include::{asciidoc-dir}/../../shared/attributes.asciidoc[] -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./pull-request-guidelines.asciidoc[] include::./contributing.asciidoc[] -include::{libbeat-dir}/docs/communitybeats.asciidoc[] +include::{libbeat-dir}/communitybeats.asciidoc[] include::./newbeat.asciidoc[] diff --git a/filebeat/docs/configuring-howto.asciidoc b/filebeat/docs/configuring-howto.asciidoc index b521d60eb3fd..08f61a4f0605 100644 --- a/filebeat/docs/configuring-howto.asciidoc +++ b/filebeat/docs/configuring-howto.asciidoc @@ -56,44 +56,44 @@ include::./filebeat-general-options.asciidoc[] include::./reload-configuration.asciidoc[] -include::{libbeat-dir}/docs/queueconfig.asciidoc[] +include::{libbeat-dir}/queueconfig.asciidoc[] -include::{libbeat-dir}/docs/outputconfig.asciidoc[] +include::{libbeat-dir}/outputconfig.asciidoc[] include::../../libbeat/docs/shared-ilm.asciidoc[] include::./load-balancing.asciidoc[] -include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[] +include::{libbeat-dir}/shared-ssl-config.asciidoc[] include::./filebeat-filtering.asciidoc[] -include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[] +include::{libbeat-dir}/shared-config-ingest.asciidoc[] -include::{libbeat-dir}/docs/shared-geoip.asciidoc[] +include::{libbeat-dir}/shared-geoip.asciidoc[] -include::{libbeat-dir}/docs/shared-path-config.asciidoc[] +include::{libbeat-dir}/shared-path-config.asciidoc[] -include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[] +include::{libbeat-dir}/shared-kibana-config.asciidoc[] -include::{libbeat-dir}/docs/setup-config.asciidoc[] +include::{libbeat-dir}/setup-config.asciidoc[] -include::{libbeat-dir}/docs/loggingconfig.asciidoc[] +include::{libbeat-dir}/loggingconfig.asciidoc[] :standalone: -include::{libbeat-dir}/docs/shared-env-vars.asciidoc[] +include::{libbeat-dir}/shared-env-vars.asciidoc[] :standalone!: :autodiscoverJolokia: :autodiscoverHints: -include::{libbeat-dir}/docs/shared-autodiscover.asciidoc[] +include::{libbeat-dir}/shared-autodiscover.asciidoc[] :standalone: -include::{libbeat-dir}/docs/yaml.asciidoc[] +include::{libbeat-dir}/yaml.asciidoc[] :standalone!: -include::{libbeat-dir}/docs/regexp.asciidoc[] +include::{libbeat-dir}/regexp.asciidoc[] -include::{libbeat-dir}/docs/http-endpoint.asciidoc[] +include::{libbeat-dir}/http-endpoint.asciidoc[] -include::{libbeat-dir}/docs/reference-yml.asciidoc[] +include::{libbeat-dir}/reference-yml.asciidoc[] diff --git a/filebeat/docs/faq.asciidoc b/filebeat/docs/faq.asciidoc index 4fc93ac8cdc1..76c6478aed2c 100644 --- a/filebeat/docs/faq.asciidoc +++ b/filebeat/docs/faq.asciidoc @@ -122,6 +122,6 @@ reached EOF or not. Note that this option can lead to data loss if the file is deleted before {beatname_uc} reaches the end of the file. -include::{libbeat-dir}/docs/faq-limit-bandwidth.asciidoc[] +include::{libbeat-dir}/faq-limit-bandwidth.asciidoc[] -include::{libbeat-dir}/docs/shared-faq.asciidoc[] +include::{libbeat-dir}/shared-faq.asciidoc[] diff --git a/filebeat/docs/filebeat-filtering.asciidoc b/filebeat/docs/filebeat-filtering.asciidoc index bbeb8382a98f..ddfa8fd4204d 100644 --- a/filebeat/docs/filebeat-filtering.asciidoc +++ b/filebeat/docs/filebeat-filtering.asciidoc @@ -22,7 +22,7 @@ global processing across all data exported by {beatname_uc}. [[using-processors]] === Processors -include::{libbeat-dir}/docs/processors.asciidoc[] +include::{libbeat-dir}/processors.asciidoc[] [float] [[drop-event-example]] @@ -103,4 +103,4 @@ The resulting output looks something like this: } ----------------------------------------------------- -include::{libbeat-dir}/docs/processors-using.asciidoc[] +include::{libbeat-dir}/processors-using.asciidoc[] diff --git a/filebeat/docs/filebeat-general-options.asciidoc b/filebeat/docs/filebeat-general-options.asciidoc index d0310ec92dc9..45767813840e 100644 --- a/filebeat/docs/filebeat-general-options.asciidoc +++ b/filebeat/docs/filebeat-general-options.asciidoc @@ -143,4 +143,4 @@ Example configuration: filebeat.shutdown_timeout: 5s ------------------------------------------------------------------------------------- -include::{libbeat-dir}/docs/generalconfig.asciidoc[] +include::{libbeat-dir}/generalconfig.asciidoc[] diff --git a/filebeat/docs/filebeat-modules-options.asciidoc b/filebeat/docs/filebeat-modules-options.asciidoc index 7cdf1cf204db..6dde1797a67a 100644 --- a/filebeat/docs/filebeat-modules-options.asciidoc +++ b/filebeat/docs/filebeat-modules-options.asciidoc @@ -18,7 +18,7 @@ implement and deploy a log monitoring solution. * <> * <> -include::{libbeat-dir}/docs/shared-note-file-permissions.asciidoc[] +include::{libbeat-dir}/shared-note-file-permissions.asciidoc[] When you enable modules, you can also <> to change the default diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc index 7092f0c30372..fe20fdeafe44 100644 --- a/filebeat/docs/getting-started.asciidoc +++ b/filebeat/docs/getting-started.asciidoc @@ -1,7 +1,7 @@ [[filebeat-getting-started]] == Getting Started With Filebeat -include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] +include::{libbeat-dir}/shared-getting-started-intro.asciidoc[] * <> * <> @@ -15,7 +15,7 @@ include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] [[filebeat-installation]] === Step 1: Install Filebeat -include::{libbeat-dir}/docs/shared-download-and-install.asciidoc[] +include::{libbeat-dir}/shared-download-and-install.asciidoc[] [[deb]] *deb:* @@ -74,7 +74,7 @@ tar xzvf filebeat-{version}-darwin-x86_64.tar.gz endif::[] -include::{libbeat-dir}/docs/shared-brew-install.asciidoc[] +include::{libbeat-dir}/shared-brew-install.asciidoc[] [[linux]] *linux:* @@ -146,7 +146,7 @@ started experience for common log formats. If you are using Filebeat modules, skip this section, including the remaining getting started steps, and go directly to <>. -include::{libbeat-dir}/docs/shared-configuring.asciidoc[] +include::{libbeat-dir}/shared-configuring.asciidoc[] Here is a sample of the `filebeat` section of the `filebeat.yml` file. Filebeat uses predefined default values for most configuration options. @@ -185,25 +185,25 @@ To fetch all files from a predefined level of subdirectories, the following patt fetch log files from the `/var/log` folder itself. Currently it is not possible to recursively fetch all files in all subdirectories of a directory. -include::{libbeat-dir}/docs/step-configure-output.asciidoc[] +include::{libbeat-dir}/step-configure-output.asciidoc[] -include::{libbeat-dir}/docs/step-configure-kibana-endpoint.asciidoc[] +include::{libbeat-dir}/step-configure-kibana-endpoint.asciidoc[] -include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[] +include::{libbeat-dir}/step-configure-credentials.asciidoc[] -include::{libbeat-dir}/docs/step-test-config.asciidoc[] +include::{libbeat-dir}/step-test-config.asciidoc[] -include::{libbeat-dir}/docs/step-look-at-config.asciidoc[] +include::{libbeat-dir}/step-look-at-config.asciidoc[] [[filebeat-template]] === Step 3: Load the index template in Elasticsearch -include::{libbeat-dir}/docs/shared-template-load.asciidoc[] +include::{libbeat-dir}/shared-template-load.asciidoc[] [[load-kibana-dashboards]] === Step 4: Set up the Kibana dashboards -include::{libbeat-dir}/docs/dashboards.asciidoc[] +include::{libbeat-dir}/dashboards.asciidoc[] [[filebeat-starting]] === Step 5: Start Filebeat @@ -240,7 +240,7 @@ specified. See {beats-ref}/config-file-permissions.html[Config File Ownership and Permissions] in the _Beats Platform Reference_. -include::{libbeat-dir}/docs/shared-brew-run.asciidoc[] +include::{libbeat-dir}/shared-brew-run.asciidoc[] *win:* @@ -261,7 +261,7 @@ To make it easier for you to explore Filebeat data in Kibana, we've created example {beatname_uc} dashboards. You loaded the dashboards earlier when you ran the `setup` command. -include::{libbeat-dir}/docs/opendashboards.asciidoc[] +include::{libbeat-dir}/opendashboards.asciidoc[] These dashboards are designed to work out-of-the box when you use <>. However, you can also use them diff --git a/filebeat/docs/index.asciidoc b/filebeat/docs/index.asciidoc index faeabec3a93e..132b47579fc2 100644 --- a/filebeat/docs/index.asciidoc +++ b/filebeat/docs/index.asciidoc @@ -1,8 +1,8 @@ = Filebeat Reference -:libbeat-dir: {docdir}/../../libbeat +:libbeat-dir: {docdir}/../../libbeat/docs -include::{libbeat-dir}/docs/version.asciidoc[] +include::{libbeat-dir}/version.asciidoc[] include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] @@ -28,7 +28,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :docker_platform: :win_os: -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./overview.asciidoc[] @@ -36,7 +36,7 @@ include::./getting-started.asciidoc[] include::./modules-getting-started.asciidoc[] -include::{libbeat-dir}/docs/repositories.asciidoc[] +include::{libbeat-dir}/repositories.asciidoc[] include::./setting-up-running.asciidoc[] @@ -46,19 +46,19 @@ include::./how-filebeat-works.asciidoc[] include::./configuring-howto.asciidoc[] -include::{libbeat-dir}/docs/shared-central-management.asciidoc[] +include::{libbeat-dir}/shared-central-management.asciidoc[] include::./modules.asciidoc[] include::./fields.asciidoc[] -include::{libbeat-dir}/docs/monitoring/monitoring-beats.asciidoc[] +include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[] -include::{libbeat-dir}/docs/shared-securing-beat.asciidoc[] +include::{libbeat-dir}/shared-securing-beat.asciidoc[] include::./troubleshooting.asciidoc[] include::./faq.asciidoc[] -include::{libbeat-dir}/docs/contributing-to-beats.asciidoc[] +include::{libbeat-dir}/contributing-to-beats.asciidoc[] diff --git a/filebeat/docs/modules-getting-started.asciidoc b/filebeat/docs/modules-getting-started.asciidoc index 4cf94c6fbfbd..0bbb5cf28068 100644 --- a/filebeat/docs/modules-getting-started.asciidoc +++ b/filebeat/docs/modules-getting-started.asciidoc @@ -40,9 +40,9 @@ To set up and run {beatname_uc} modules: installation. By default, {beatname_uc} assumes {es} is running locally on port 9200. + -include::{libbeat-dir}/docs/step-configure-output.asciidoc[] +include::{libbeat-dir}/step-configure-output.asciidoc[] -include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[] +include::{libbeat-dir}/step-configure-credentials.asciidoc[] . Enable the modules you want to run. For example, the following command enables the system, nginx, and mysql modules: diff --git a/filebeat/docs/overview.asciidoc b/filebeat/docs/overview.asciidoc index 5aae20010f5c..4f3a9474a8ea 100644 --- a/filebeat/docs/overview.asciidoc +++ b/filebeat/docs/overview.asciidoc @@ -23,4 +23,4 @@ image::./images/filebeat.png[Beats design] For more information about inputs and harvesters, see <>. -include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[] +include::{libbeat-dir}/shared-libbeat-description.asciidoc[] diff --git a/filebeat/docs/reload-configuration.asciidoc b/filebeat/docs/reload-configuration.asciidoc index 7936254eb28f..52eb800d5a84 100644 --- a/filebeat/docs/reload-configuration.asciidoc +++ b/filebeat/docs/reload-configuration.asciidoc @@ -6,7 +6,7 @@ allowing you to separate your configuration into multiple smaller configuration files. See the <> and the <> sections for details. -include::{libbeat-dir}/docs/shared-note-file-permissions.asciidoc[] +include::{libbeat-dir}/shared-note-file-permissions.asciidoc[] [float] [[load-input-config]] @@ -129,4 +129,4 @@ set the `period` to less than 1s because the modification time of files is often stored in seconds. Setting the `period` to less than 1s will result in unnecessary overhead. -include::{libbeat-dir}/docs/shared-note-file-permissions.asciidoc[] +include::{libbeat-dir}/shared-note-file-permissions.asciidoc[] diff --git a/filebeat/docs/running-on-docker.asciidoc b/filebeat/docs/running-on-docker.asciidoc index d9306b55edce..dbfcce5b489d 100644 --- a/filebeat/docs/running-on-docker.asciidoc +++ b/filebeat/docs/running-on-docker.asciidoc @@ -1 +1 @@ -include::{libbeat-dir}/docs/shared-docker.asciidoc[] +include::{libbeat-dir}/shared-docker.asciidoc[] diff --git a/filebeat/docs/setting-up-running.asciidoc b/filebeat/docs/setting-up-running.asciidoc index 724c003f5d40..05e68bb9d52b 100644 --- a/filebeat/docs/setting-up-running.asciidoc +++ b/filebeat/docs/setting-up-running.asciidoc @@ -27,16 +27,16 @@ This section includes additional information on how to set up and run //MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too. -include::{libbeat-dir}/docs/shared-directory-layout.asciidoc[] +include::{libbeat-dir}/shared-directory-layout.asciidoc[] -include::{libbeat-dir}/docs/keystore.asciidoc[] +include::{libbeat-dir}/keystore.asciidoc[] -include::{libbeat-dir}/docs/command-reference.asciidoc[] +include::{libbeat-dir}/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] include::./running-on-kubernetes.asciidoc[] -include::{libbeat-dir}/docs/shared-systemd.asciidoc[] +include::{libbeat-dir}/shared-systemd.asciidoc[] -include::{libbeat-dir}/docs/shared-shutdown.asciidoc[] +include::{libbeat-dir}/shared-shutdown.asciidoc[] diff --git a/filebeat/docs/troubleshooting.asciidoc b/filebeat/docs/troubleshooting.asciidoc index b093c5d79585..766c7a37bc49 100644 --- a/filebeat/docs/troubleshooting.asciidoc +++ b/filebeat/docs/troubleshooting.asciidoc @@ -17,14 +17,14 @@ following tips: [[getting-help]] == Get help -include::{libbeat-dir}/docs/getting-help.asciidoc[] +include::{libbeat-dir}/getting-help.asciidoc[] //sets block macro for debugging.asciidoc included in next section [[enable-filebeat-debugging]] == Debug -include::{libbeat-dir}/docs/debugging.asciidoc[] +include::{libbeat-dir}/debugging.asciidoc[] diff --git a/heartbeat/docs/configuring-howto.asciidoc b/heartbeat/docs/configuring-howto.asciidoc index e033406ce64a..a235d52bfbd0 100644 --- a/heartbeat/docs/configuring-howto.asciidoc +++ b/heartbeat/docs/configuring-howto.asciidoc @@ -49,42 +49,42 @@ include::./heartbeat-general-options.asciidoc[] include::./heartbeat-observer-options.asciidoc[] -include::{libbeat-dir}/docs/queueconfig.asciidoc[] +include::{libbeat-dir}/queueconfig.asciidoc[] -include::{libbeat-dir}/docs/outputconfig.asciidoc[] +include::{libbeat-dir}/outputconfig.asciidoc[] -include::{libbeat-dir}/docs/shared-ilm.asciidoc[] +include::{libbeat-dir}/shared-ilm.asciidoc[] -include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[] +include::{libbeat-dir}/shared-ssl-config.asciidoc[] include::./heartbeat-filtering.asciidoc[] -include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[] +include::{libbeat-dir}/shared-config-ingest.asciidoc[] -include::{libbeat-dir}/docs/shared-geoip.asciidoc[] +include::{libbeat-dir}/shared-geoip.asciidoc[] -include::{libbeat-dir}/docs/shared-path-config.asciidoc[] +include::{libbeat-dir}/shared-path-config.asciidoc[] -include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[] +include::{libbeat-dir}/shared-kibana-config.asciidoc[] -include::{libbeat-dir}/docs/setup-config.asciidoc[] +include::{libbeat-dir}/setup-config.asciidoc[] -include::{libbeat-dir}/docs/loggingconfig.asciidoc[] +include::{libbeat-dir}/loggingconfig.asciidoc[] :standalone: -include::{libbeat-dir}/docs/shared-env-vars.asciidoc[] +include::{libbeat-dir}/shared-env-vars.asciidoc[] :standalone!: :autodiscoverAWSELB: -include::{libbeat-dir}/docs/shared-autodiscover.asciidoc[] +include::{libbeat-dir}/shared-autodiscover.asciidoc[] :autodiscoverAWSELB!: :standalone: -include::{libbeat-dir}/docs/yaml.asciidoc[] +include::{libbeat-dir}/yaml.asciidoc[] :standalone!: -include::{libbeat-dir}/docs/regexp.asciidoc[] +include::{libbeat-dir}/regexp.asciidoc[] -include::{libbeat-dir}/docs/http-endpoint.asciidoc[] +include::{libbeat-dir}/http-endpoint.asciidoc[] -include::{libbeat-dir}/docs/reference-yml.asciidoc[] +include::{libbeat-dir}/reference-yml.asciidoc[] diff --git a/heartbeat/docs/faq.asciidoc b/heartbeat/docs/faq.asciidoc index 4848f8733a43..bbe89a61c721 100644 --- a/heartbeat/docs/faq.asciidoc +++ b/heartbeat/docs/faq.asciidoc @@ -5,6 +5,6 @@ This section describes common problems you might encounter with {beatname_uc}. Also check out the https://discuss.elastic.co/c/beats/{beatname_lc}[{beatname_uc} discussion forum]. -include::{libbeat-dir}/docs/faq-limit-bandwidth.asciidoc[] +include::{libbeat-dir}/faq-limit-bandwidth.asciidoc[] -include::{libbeat-dir}/docs/shared-faq.asciidoc[] +include::{libbeat-dir}/shared-faq.asciidoc[] diff --git a/heartbeat/docs/getting-started.asciidoc b/heartbeat/docs/getting-started.asciidoc index 0d3427cebc5f..bc7026805977 100644 --- a/heartbeat/docs/getting-started.asciidoc +++ b/heartbeat/docs/getting-started.asciidoc @@ -1,7 +1,7 @@ [[heartbeat-getting-started]] == Getting Started With Heartbeat -include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] +include::{libbeat-dir}/shared-getting-started-intro.asciidoc[] * <> * <> @@ -22,7 +22,7 @@ monitor are running. //TODO: Add a separate topic that explores deployment scenarios in more detail (like installing on a sub-network where there's a firewall etc. -include::{libbeat-dir}/docs/shared-download-and-install.asciidoc[] +include::{libbeat-dir}/shared-download-and-install.asciidoc[] [[deb]] *deb:* @@ -81,7 +81,7 @@ tar xzvf heartbeat-{version}-darwin-x86_64.tar.gz endif::[] -include::{libbeat-dir}/docs/shared-brew-install.asciidoc[] +include::{libbeat-dir}/shared-brew-install.asciidoc[] [[linux]] *linux:* @@ -151,7 +151,7 @@ options, see <>. [[heartbeat-configuration]] === Step 2: Configure Heartbeat -include::{libbeat-dir}/docs/shared-configuring.asciidoc[] +include::{libbeat-dir}/shared-configuring.asciidoc[] Heartbeat provides monitors to check the status of hosts at set intervals. You configure each monitor individually. Heartbeat currently provides monitors @@ -198,20 +198,20 @@ was started. Heartbeat adds the `@every` keyword to the syntax provided by the See <> for a full description of each configuration option. -include::{libbeat-dir}/docs/step-configure-output.asciidoc[] +include::{libbeat-dir}/step-configure-output.asciidoc[] -include::{libbeat-dir}/docs/step-configure-kibana-endpoint.asciidoc[] +include::{libbeat-dir}/step-configure-kibana-endpoint.asciidoc[] -include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[] +include::{libbeat-dir}/step-configure-credentials.asciidoc[] -include::{libbeat-dir}/docs/step-test-config.asciidoc[] +include::{libbeat-dir}/step-test-config.asciidoc[] -include::{libbeat-dir}/docs/step-look-at-config.asciidoc[] +include::{libbeat-dir}/step-look-at-config.asciidoc[] [[heartbeat-template]] === Step 3: Load the index template in Elasticsearch -include::{libbeat-dir}/docs/shared-template-load.asciidoc[] +include::{libbeat-dir}/shared-template-load.asciidoc[] [[load-kibana-dashboards]] === Step 4: Set up the Kibana dashboards @@ -249,7 +249,7 @@ configuration file, or run Heartbeat with `--strict.perms=false` specified. See in the _Beats Platform Reference_. :requires-sudo: -include::{libbeat-dir}/docs/shared-brew-run.asciidoc[] +include::{libbeat-dir}/shared-brew-run.asciidoc[] :requires-sudo!: *win:* @@ -272,7 +272,7 @@ created example {beatname_uc} dashboards in the https://github.com/elastic/uptime-contrib[uptime-contrib] github repository. If you loaded them earlier, open them now. -include::{libbeat-dir}/docs/opendashboards.asciidoc[] +include::{libbeat-dir}/opendashboards.asciidoc[] The dashboards are provided as examples. We recommend that you {kibana-ref}/dashboard.html[customize] them to meet your needs. diff --git a/heartbeat/docs/heartbeat-filtering.asciidoc b/heartbeat/docs/heartbeat-filtering.asciidoc index 8dc1fbb5791a..29545c3320f2 100644 --- a/heartbeat/docs/heartbeat-filtering.asciidoc +++ b/heartbeat/docs/heartbeat-filtering.asciidoc @@ -1,6 +1,6 @@ [[filtering-and-enhancing-data]] == Filter and Enhance the exported data -include::{libbeat-dir}/docs/processors.asciidoc[] +include::{libbeat-dir}/processors.asciidoc[] -include::{libbeat-dir}/docs/processors-using.asciidoc[] +include::{libbeat-dir}/processors-using.asciidoc[] diff --git a/heartbeat/docs/heartbeat-general-options.asciidoc b/heartbeat/docs/heartbeat-general-options.asciidoc index 60e017c7a29d..2013d3103ee4 100644 --- a/heartbeat/docs/heartbeat-general-options.asciidoc +++ b/heartbeat/docs/heartbeat-general-options.asciidoc @@ -4,5 +4,5 @@ You can specify settings in the +{beatname_lc}.yml+ config file to control the general behavior of {beatname_uc}. -include::{libbeat-dir}/docs/generalconfig.asciidoc[] +include::{libbeat-dir}/generalconfig.asciidoc[] diff --git a/heartbeat/docs/index.asciidoc b/heartbeat/docs/index.asciidoc index d23ea5849ea8..9b356037603a 100644 --- a/heartbeat/docs/index.asciidoc +++ b/heartbeat/docs/index.asciidoc @@ -1,8 +1,8 @@ = Heartbeat Reference -:libbeat-dir: {docdir}/../../libbeat +:libbeat-dir: {docdir}/../../libbeat/docs -include::{libbeat-dir}/docs/version.asciidoc[] +include::{libbeat-dir}/version.asciidoc[] include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] @@ -26,13 +26,13 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :no_script_processor: :no_timestamp_processor: -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./overview.asciidoc[] include::./getting-started.asciidoc[] -include::{libbeat-dir}/docs/repositories.asciidoc[] +include::{libbeat-dir}/repositories.asciidoc[] include::./setting-up-running.asciidoc[] @@ -40,13 +40,13 @@ include::./configuring-howto.asciidoc[] include::./fields.asciidoc[] -include::{libbeat-dir}/docs/monitoring/monitoring-beats.asciidoc[] +include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[] -include::{libbeat-dir}/docs/shared-securing-beat.asciidoc[] +include::{libbeat-dir}/shared-securing-beat.asciidoc[] include::./troubleshooting.asciidoc[] include::./faq.asciidoc[] -include::{libbeat-dir}/docs/contributing-to-beats.asciidoc[] +include::{libbeat-dir}/contributing-to-beats.asciidoc[] diff --git a/heartbeat/docs/overview.asciidoc b/heartbeat/docs/overview.asciidoc index 6d0b78a63f31..2dd97907117e 100644 --- a/heartbeat/docs/overview.asciidoc +++ b/heartbeat/docs/overview.asciidoc @@ -37,4 +37,4 @@ specific status code, response header, or content. The `tcp` and `http` monitors both support SSL/TLS and some proxy settings. -include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[] +include::{libbeat-dir}/shared-libbeat-description.asciidoc[] diff --git a/heartbeat/docs/running-on-docker.asciidoc b/heartbeat/docs/running-on-docker.asciidoc index d9306b55edce..dbfcce5b489d 100644 --- a/heartbeat/docs/running-on-docker.asciidoc +++ b/heartbeat/docs/running-on-docker.asciidoc @@ -1 +1 @@ -include::{libbeat-dir}/docs/shared-docker.asciidoc[] +include::{libbeat-dir}/shared-docker.asciidoc[] diff --git a/heartbeat/docs/setting-up-running.asciidoc b/heartbeat/docs/setting-up-running.asciidoc index 66e1ead2027c..8ec02a23fbdf 100644 --- a/heartbeat/docs/setting-up-running.asciidoc +++ b/heartbeat/docs/setting-up-running.asciidoc @@ -24,14 +24,14 @@ This section includes additional information on how to set up and run //MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too. -include::{libbeat-dir}/docs/shared-directory-layout.asciidoc[] +include::{libbeat-dir}/shared-directory-layout.asciidoc[] -include::{libbeat-dir}/docs/keystore.asciidoc[] +include::{libbeat-dir}/keystore.asciidoc[] -include::{libbeat-dir}/docs/command-reference.asciidoc[] +include::{libbeat-dir}/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] -include::{libbeat-dir}/docs/shared-systemd.asciidoc[] +include::{libbeat-dir}/shared-systemd.asciidoc[] -include::{libbeat-dir}/docs/shared-shutdown.asciidoc[] +include::{libbeat-dir}/shared-shutdown.asciidoc[] diff --git a/heartbeat/docs/troubleshooting.asciidoc b/heartbeat/docs/troubleshooting.asciidoc index c99b54c1f64d..0fa1379f6c9f 100644 --- a/heartbeat/docs/troubleshooting.asciidoc +++ b/heartbeat/docs/troubleshooting.asciidoc @@ -17,14 +17,14 @@ following tips: [[getting-help]] == Get help -include::{libbeat-dir}/docs/getting-help.asciidoc[] +include::{libbeat-dir}/getting-help.asciidoc[] //sets block macro for debugging.asciidoc included in next section [[enable-heartbeat-debugging]] == Debug -include::{libbeat-dir}/docs/debugging.asciidoc[] +include::{libbeat-dir}/debugging.asciidoc[] diff --git a/journalbeat/docs/configuring-howto.asciidoc b/journalbeat/docs/configuring-howto.asciidoc index 620d0d6e710f..2a651def0f50 100644 --- a/journalbeat/docs/configuring-howto.asciidoc +++ b/journalbeat/docs/configuring-howto.asciidoc @@ -8,7 +8,7 @@ Before modifying configuration settings, make sure you've completed the <<{beatname_lc}-configuration,configuration steps>> in the Getting Started. This section describes some common use cases for changing configuration options. -include::{libbeat-dir}/docs/shared-configuring.asciidoc[] +include::{libbeat-dir}/shared-configuring.asciidoc[] The following topics describe how to configure {beatname_uc}: @@ -37,38 +37,38 @@ include::./config-options.asciidoc[] include::./general-options.asciidoc[] -include::{libbeat-dir}/docs/queueconfig.asciidoc[] +include::{libbeat-dir}/queueconfig.asciidoc[] -include::{libbeat-dir}/docs/outputconfig.asciidoc[] +include::{libbeat-dir}/outputconfig.asciidoc[] -include::{libbeat-dir}/docs/shared-ilm.asciidoc[] +include::{libbeat-dir}/shared-ilm.asciidoc[] -include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[] +include::{libbeat-dir}/shared-ssl-config.asciidoc[] include::./filtering.asciidoc[] -include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[] +include::{libbeat-dir}/shared-config-ingest.asciidoc[] -include::{libbeat-dir}/docs/shared-geoip.asciidoc[] +include::{libbeat-dir}/shared-geoip.asciidoc[] -include::{libbeat-dir}/docs/shared-path-config.asciidoc[] +include::{libbeat-dir}/shared-path-config.asciidoc[] -include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[] +include::{libbeat-dir}/shared-kibana-config.asciidoc[] -include::{libbeat-dir}/docs/setup-config.asciidoc[] +include::{libbeat-dir}/setup-config.asciidoc[] -include::{libbeat-dir}/docs/loggingconfig.asciidoc[] +include::{libbeat-dir}/loggingconfig.asciidoc[] :standalone: -include::{libbeat-dir}/docs/shared-env-vars.asciidoc[] +include::{libbeat-dir}/shared-env-vars.asciidoc[] :standalone!: :standalone: -include::{libbeat-dir}/docs/yaml.asciidoc[] +include::{libbeat-dir}/yaml.asciidoc[] :standalone!: -include::{libbeat-dir}/docs/regexp.asciidoc[] +include::{libbeat-dir}/regexp.asciidoc[] -include::{libbeat-dir}/docs/http-endpoint.asciidoc[] +include::{libbeat-dir}/http-endpoint.asciidoc[] -include::{libbeat-dir}/docs/reference-yml.asciidoc[] +include::{libbeat-dir}/reference-yml.asciidoc[] diff --git a/journalbeat/docs/faq.asciidoc b/journalbeat/docs/faq.asciidoc index 4848f8733a43..bbe89a61c721 100644 --- a/journalbeat/docs/faq.asciidoc +++ b/journalbeat/docs/faq.asciidoc @@ -5,6 +5,6 @@ This section describes common problems you might encounter with {beatname_uc}. Also check out the https://discuss.elastic.co/c/beats/{beatname_lc}[{beatname_uc} discussion forum]. -include::{libbeat-dir}/docs/faq-limit-bandwidth.asciidoc[] +include::{libbeat-dir}/faq-limit-bandwidth.asciidoc[] -include::{libbeat-dir}/docs/shared-faq.asciidoc[] +include::{libbeat-dir}/shared-faq.asciidoc[] diff --git a/journalbeat/docs/filtering.asciidoc b/journalbeat/docs/filtering.asciidoc index 1150e70f754a..fc7dba749d4f 100644 --- a/journalbeat/docs/filtering.asciidoc +++ b/journalbeat/docs/filtering.asciidoc @@ -19,7 +19,7 @@ global processing across all data exported by {beatname_uc}. [[using-processors]] === Processors -include::{libbeat-dir}/docs/processors.asciidoc[] +include::{libbeat-dir}/processors.asciidoc[] // You must set the processor-scope attribute to resolve the attribute reference // defined in processors-using.asciidoc. The attribute is used to indicate where @@ -28,5 +28,5 @@ include::{libbeat-dir}/docs/processors.asciidoc[] // to processors-using.asciidoc. :processor-scope: input -include::{libbeat-dir}/docs/processors-using.asciidoc[] +include::{libbeat-dir}/processors-using.asciidoc[] :processor-scope!: diff --git a/journalbeat/docs/general-options.asciidoc b/journalbeat/docs/general-options.asciidoc index 8596fc7dea64..5649877fc8c9 100644 --- a/journalbeat/docs/general-options.asciidoc +++ b/journalbeat/docs/general-options.asciidoc @@ -56,5 +56,5 @@ This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see <>. -include::{libbeat-dir}/docs/generalconfig.asciidoc[] +include::{libbeat-dir}/generalconfig.asciidoc[] diff --git a/journalbeat/docs/getting-started.asciidoc b/journalbeat/docs/getting-started.asciidoc index c0a06c0e0aa7..73defd5424a0 100644 --- a/journalbeat/docs/getting-started.asciidoc +++ b/journalbeat/docs/getting-started.asciidoc @@ -1,7 +1,7 @@ [id="{beatname_lc}-getting-started"] == Getting started with {beatname_uc} -include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] +include::{libbeat-dir}/shared-getting-started-intro.asciidoc[] * <<{beatname_lc}-installation>> * <<{beatname_lc}-configuration>> @@ -13,7 +13,7 @@ include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] [id="{beatname_lc}-installation"] === Step 1: Install {beatname_uc} -include::{libbeat-dir}/docs/shared-download-and-install.asciidoc[] +include::{libbeat-dir}/shared-download-and-install.asciidoc[] [[deb]] *deb:* @@ -94,7 +94,7 @@ Before running {beatname_uc}, you can specify the location of the systemd journal files and configure how you want the files to be read. If you accept the default configuration, {beatname_uc} reads from the local journal. -include::{libbeat-dir}/docs/shared-configuring.asciidoc[] +include::{libbeat-dir}/shared-configuring.asciidoc[] Here is a sample of the +{beatname_lc}+ section of the +{beatname_lc}.yml+ file. {beatname_uc} uses predefined default values for most configuration options. @@ -144,21 +144,21 @@ Redis events from a Docker container tagged as `redis`, use: - "_COMM=redis" ---- -include::{libbeat-dir}/docs/step-configure-output.asciidoc[] +include::{libbeat-dir}/step-configure-output.asciidoc[] -include::{libbeat-dir}/docs/step-configure-kibana-endpoint.asciidoc[] +include::{libbeat-dir}/step-configure-kibana-endpoint.asciidoc[] -include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[] +include::{libbeat-dir}/step-configure-credentials.asciidoc[] -include::{libbeat-dir}/docs/step-test-config.asciidoc[] +include::{libbeat-dir}/step-test-config.asciidoc[] -include::{libbeat-dir}/docs/step-look-at-config.asciidoc[] +include::{libbeat-dir}/step-look-at-config.asciidoc[] [id="{beatname_lc}-template"] === Step 3: Load the index template in {es} -include::{libbeat-dir}/docs/shared-template-load.asciidoc[] +include::{libbeat-dir}/shared-template-load.asciidoc[] [id="{beatname_lc}-starting"] === Step 5: Start {beatname_uc} diff --git a/journalbeat/docs/index.asciidoc b/journalbeat/docs/index.asciidoc index 70b20f0746b3..2fb3b7ad0c52 100644 --- a/journalbeat/docs/index.asciidoc +++ b/journalbeat/docs/index.asciidoc @@ -1,8 +1,8 @@ = Journalbeat Reference -:libbeat-dir: {docdir}/../../libbeat +:libbeat-dir: {docdir}/../../libbeat/docs -include::{libbeat-dir}/docs/version.asciidoc[] +include::{libbeat-dir}/version.asciidoc[] include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] @@ -21,13 +21,13 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :no_dashboards: :no_decode_cef_processor: -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./overview.asciidoc[] include::./getting-started.asciidoc[] -include::{libbeat-dir}/docs/repositories.asciidoc[] +include::{libbeat-dir}/repositories.asciidoc[] include::./setting-up-running.asciidoc[] @@ -35,9 +35,9 @@ include::./configuring-howto.asciidoc[] include::./fields.asciidoc[] -include::{libbeat-dir}/docs/monitoring/monitoring-beats.asciidoc[] +include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[] -include::{libbeat-dir}/docs/shared-securing-beat.asciidoc[] +include::{libbeat-dir}/shared-securing-beat.asciidoc[] include::./troubleshooting.asciidoc[] diff --git a/journalbeat/docs/overview.asciidoc b/journalbeat/docs/overview.asciidoc index 815de9bc8a01..332dd624234d 100644 --- a/journalbeat/docs/overview.asciidoc +++ b/journalbeat/docs/overview.asciidoc @@ -12,4 +12,4 @@ locations that you specify, collects log events, and forwards them to either to https://www.elastic.co/products/elasticsearch[Elasticsearch] or https://www.elastic.co/products/logstash[Logstash]. -include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[] +include::{libbeat-dir}/shared-libbeat-description.asciidoc[] diff --git a/journalbeat/docs/running-on-docker.asciidoc b/journalbeat/docs/running-on-docker.asciidoc index d9306b55edce..dbfcce5b489d 100644 --- a/journalbeat/docs/running-on-docker.asciidoc +++ b/journalbeat/docs/running-on-docker.asciidoc @@ -1 +1 @@ -include::{libbeat-dir}/docs/shared-docker.asciidoc[] +include::{libbeat-dir}/shared-docker.asciidoc[] diff --git a/journalbeat/docs/setting-up-running.asciidoc b/journalbeat/docs/setting-up-running.asciidoc index 8969c14981a6..bf67e6501abb 100644 --- a/journalbeat/docs/setting-up-running.asciidoc +++ b/journalbeat/docs/setting-up-running.asciidoc @@ -23,14 +23,14 @@ This section includes additional information on how to set up and run //MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too. -include::{libbeat-dir}/docs/shared-directory-layout.asciidoc[] +include::{libbeat-dir}/shared-directory-layout.asciidoc[] -include::{libbeat-dir}/docs/keystore.asciidoc[] +include::{libbeat-dir}/keystore.asciidoc[] -include::{libbeat-dir}/docs/command-reference.asciidoc[] +include::{libbeat-dir}/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] -include::{libbeat-dir}/docs/shared-systemd.asciidoc[] +include::{libbeat-dir}/shared-systemd.asciidoc[] -include::{libbeat-dir}/docs/shared-shutdown.asciidoc[] +include::{libbeat-dir}/shared-shutdown.asciidoc[] diff --git a/journalbeat/docs/troubleshooting.asciidoc b/journalbeat/docs/troubleshooting.asciidoc index 8d87893bf70b..a1b4b1e72c6f 100644 --- a/journalbeat/docs/troubleshooting.asciidoc +++ b/journalbeat/docs/troubleshooting.asciidoc @@ -18,14 +18,14 @@ following tips: [[getting-help]] == Get help -include::{libbeat-dir}/docs/getting-help.asciidoc[] +include::{libbeat-dir}/getting-help.asciidoc[] //sets block macro for debugging.asciidoc included in next section [id="enable-{beatname_lc}-debugging"] == Debug -include::{libbeat-dir}/docs/debugging.asciidoc[] +include::{libbeat-dir}/debugging.asciidoc[] diff --git a/libbeat/docs/index.asciidoc b/libbeat/docs/index.asciidoc index 402368ea9117..5d1309e4f88b 100644 --- a/libbeat/docs/index.asciidoc +++ b/libbeat/docs/index.asciidoc @@ -1,6 +1,6 @@ = Beats Platform Reference -:libbeat-dir: {docdir}/../../libbeat +:libbeat-dir: {docdir}/../../libbeat/docs include::./version.asciidoc[] @@ -16,7 +16,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :beat_default_index_prefix: {beatname_lc} :has_ml_jobs: -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./overview.asciidoc[] @@ -34,4 +34,4 @@ include::./release-notes/breaking/breaking.asciidoc[] include::./release.asciidoc[] -include::{libbeat-dir}/docs/contributing-to-beats.asciidoc[] +include::{libbeat-dir}/contributing-to-beats.asciidoc[] diff --git a/libbeat/docs/outputs/output-logstash.asciidoc b/libbeat/docs/outputs/output-logstash.asciidoc index 10c3c1c5b519..9fb1ce99d71b 100644 --- a/libbeat/docs/outputs/output-logstash.asciidoc +++ b/libbeat/docs/outputs/output-logstash.asciidoc @@ -49,7 +49,7 @@ endif::[] ifndef::win-only[] -include::{libbeat-dir}/docs/step-test-config.asciidoc[] +include::{libbeat-dir}/step-test-config.asciidoc[] endif::win-only[] diff --git a/metricbeat/docs/configuring-howto.asciidoc b/metricbeat/docs/configuring-howto.asciidoc index 7a7155a63133..d532b8a5a3e0 100644 --- a/metricbeat/docs/configuring-howto.asciidoc +++ b/metricbeat/docs/configuring-howto.asciidoc @@ -49,42 +49,42 @@ include::./metricbeat-general-options.asciidoc[] include::./reload-configuration.asciidoc[] -include::{libbeat-dir}/docs/queueconfig.asciidoc[] +include::{libbeat-dir}/queueconfig.asciidoc[] -include::{libbeat-dir}/docs/outputconfig.asciidoc[] +include::{libbeat-dir}/outputconfig.asciidoc[] -include::{libbeat-dir}/docs/shared-ilm.asciidoc[] +include::{libbeat-dir}/shared-ilm.asciidoc[] -include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[] +include::{libbeat-dir}/shared-ssl-config.asciidoc[] include::./metricbeat-filtering.asciidoc[] -include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[] +include::{libbeat-dir}/shared-config-ingest.asciidoc[] -include::{libbeat-dir}/docs/shared-geoip.asciidoc[] +include::{libbeat-dir}/shared-geoip.asciidoc[] -include::{libbeat-dir}/docs/shared-path-config.asciidoc[] +include::{libbeat-dir}/shared-path-config.asciidoc[] -include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[] +include::{libbeat-dir}/shared-kibana-config.asciidoc[] -include::{libbeat-dir}/docs/setup-config.asciidoc[] +include::{libbeat-dir}/setup-config.asciidoc[] -include::{libbeat-dir}/docs/loggingconfig.asciidoc[] +include::{libbeat-dir}/loggingconfig.asciidoc[] :standalone: -include::{libbeat-dir}/docs/shared-env-vars.asciidoc[] +include::{libbeat-dir}/shared-env-vars.asciidoc[] :standalone!: :autodiscoverJolokia: :autodiscoverHints: -include::{libbeat-dir}/docs/shared-autodiscover.asciidoc[] +include::{libbeat-dir}/shared-autodiscover.asciidoc[] :standalone: -include::{libbeat-dir}/docs/yaml.asciidoc[] +include::{libbeat-dir}/yaml.asciidoc[] :standalone!: -include::{libbeat-dir}/docs/regexp.asciidoc[] +include::{libbeat-dir}/regexp.asciidoc[] -include::{libbeat-dir}/docs/http-endpoint.asciidoc[] +include::{libbeat-dir}/http-endpoint.asciidoc[] -include::{libbeat-dir}/docs/reference-yml.asciidoc[] +include::{libbeat-dir}/reference-yml.asciidoc[] diff --git a/metricbeat/docs/faq.asciidoc b/metricbeat/docs/faq.asciidoc index 7f550fbf34ab..81c188a520f8 100644 --- a/metricbeat/docs/faq.asciidoc +++ b/metricbeat/docs/faq.asciidoc @@ -22,6 +22,6 @@ sudo mount -t linprocfs /dev/null /compat/linux/proc include::faq-unexpected-metrics.asciidoc[] -include::{libbeat-dir}/docs/faq-limit-bandwidth.asciidoc[] +include::{libbeat-dir}/faq-limit-bandwidth.asciidoc[] -include::{libbeat-dir}/docs/shared-faq.asciidoc[] +include::{libbeat-dir}/shared-faq.asciidoc[] diff --git a/metricbeat/docs/gettingstarted.asciidoc b/metricbeat/docs/gettingstarted.asciidoc index 60631dece5a8..db1c9fe33659 100644 --- a/metricbeat/docs/gettingstarted.asciidoc +++ b/metricbeat/docs/gettingstarted.asciidoc @@ -4,7 +4,7 @@ {beatname_uc} helps you monitor your servers and the services they host by collecting metrics from the operating system and services. -include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] +include::{libbeat-dir}/shared-getting-started-intro.asciidoc[] * <<{beatname_lc}-installation>> * <<{beatname_lc}-configuration>> @@ -25,7 +25,7 @@ traffic or prevent {beatname_uc} from collecting metrics when there are network problems. Metrics from multiple {beatname_uc} instances will be combined on the Elasticsearch server. -include::{libbeat-dir}/docs/shared-download-and-install.asciidoc[] +include::{libbeat-dir}/shared-download-and-install.asciidoc[] [[deb]] *deb:* @@ -84,7 +84,7 @@ tar xzvf {beatname_lc}-{version}-darwin-x86_64.tar.gz endif::[] -include::{libbeat-dir}/docs/shared-brew-install.asciidoc[] +include::{libbeat-dir}/shared-brew-install.asciidoc[] [[linux]] *linux:* @@ -160,7 +160,7 @@ For more information about these options, see [id="{beatname_lc}-configuration"] === Step 2: Configure {beatname_uc} -include::{libbeat-dir}/docs/shared-configuring.asciidoc[] +include::{libbeat-dir}/shared-configuring.asciidoc[] When you configure {beatname_uc}, you need to specify which <<{beatname_lc}-modules,modules>> to run. {beatname_uc} uses modules to collect @@ -214,25 +214,25 @@ settings. See <> if you want to add the module configs to the +{beatname_lc}.yml+ file rather than using the `modules.d` directory. -include::{libbeat-dir}/docs/step-configure-output.asciidoc[] +include::{libbeat-dir}/step-configure-output.asciidoc[] -include::{libbeat-dir}/docs/step-configure-kibana-endpoint.asciidoc[] +include::{libbeat-dir}/step-configure-kibana-endpoint.asciidoc[] -include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[] +include::{libbeat-dir}/step-configure-credentials.asciidoc[] -include::{libbeat-dir}/docs/step-test-config.asciidoc[] +include::{libbeat-dir}/step-test-config.asciidoc[] -include::{libbeat-dir}/docs/step-look-at-config.asciidoc[] +include::{libbeat-dir}/step-look-at-config.asciidoc[] [id="{beatname_lc}-template"] === Step 3: Load the index template in Elasticsearch -include::{libbeat-dir}/docs/shared-template-load.asciidoc[] +include::{libbeat-dir}/shared-template-load.asciidoc[] [[load-kibana-dashboards]] === Step 4: Set up the Kibana dashboards -include::{libbeat-dir}/docs/dashboards.asciidoc[] +include::{libbeat-dir}/dashboards.asciidoc[] [id="{beatname_lc}-starting"] === Step 5: Start {beatname_uc} @@ -271,7 +271,7 @@ or run {beatname_uc} with `--strict.perms=false` specified. See in the _Beats Platform Reference_. :requires-sudo: -include::{libbeat-dir}/docs/shared-brew-run.asciidoc[] +include::{libbeat-dir}/shared-brew-run.asciidoc[] :requires-sudo!: *win:* @@ -309,7 +309,7 @@ To make it easier for you to start monitoring your servers in Kibana, we have created example {beatname_uc} dashboards. You loaded the dashboards earlier when you ran the `setup` command. -include::{libbeat-dir}/docs/opendashboards.asciidoc[] +include::{libbeat-dir}/opendashboards.asciidoc[] The dashboards are provided as examples. We recommend that you {kibana-ref}/dashboard.html[customize] them to meet your needs. diff --git a/metricbeat/docs/index.asciidoc b/metricbeat/docs/index.asciidoc index cb335599ea99..4991692b2888 100644 --- a/metricbeat/docs/index.asciidoc +++ b/metricbeat/docs/index.asciidoc @@ -1,10 +1,10 @@ = Metricbeat Reference -:libbeat-dir: {docdir}/../../libbeat +:libbeat-dir: {docdir}/../../libbeat/docs :libbeat-xpack-dir: ../../../x-pack/libbeat -include::{libbeat-dir}/docs/version.asciidoc[] +include::{libbeat-dir}/version.asciidoc[] include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] @@ -31,13 +31,13 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :no_script_processor: :no_timestamp_processor: -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./overview.asciidoc[] include::./gettingstarted.asciidoc[] -include::{libbeat-dir}/docs/repositories.asciidoc[] +include::{libbeat-dir}/repositories.asciidoc[] include::./setting-up-running.asciidoc[] @@ -47,18 +47,18 @@ include::./how-metricbeat-works.asciidoc[] include::./configuring-howto.asciidoc[] -include::{libbeat-dir}/docs/shared-central-management.asciidoc[] +include::{libbeat-dir}/shared-central-management.asciidoc[] include::./modules.asciidoc[] include::./fields.asciidoc[] -include::{libbeat-dir}/docs/monitoring/monitoring-beats.asciidoc[] +include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[] -include::{libbeat-dir}/docs/shared-securing-beat.asciidoc[] +include::{libbeat-dir}/shared-securing-beat.asciidoc[] include::./troubleshooting.asciidoc[] include::./faq.asciidoc[] -include::{libbeat-dir}/docs/contributing-to-beats.asciidoc[] +include::{libbeat-dir}/contributing-to-beats.asciidoc[] diff --git a/metricbeat/docs/metricbeat-filtering.asciidoc b/metricbeat/docs/metricbeat-filtering.asciidoc index 68d23b391077..b518823375b3 100644 --- a/metricbeat/docs/metricbeat-filtering.asciidoc +++ b/metricbeat/docs/metricbeat-filtering.asciidoc @@ -1,7 +1,7 @@ [[filtering-and-enhancing-data]] == Filter and enhance the exported data -include::{libbeat-dir}/docs/processors.asciidoc[] +include::{libbeat-dir}/processors.asciidoc[] For example, the following configuration reduces the exported fields by dropping the `agent.name` and `agent.version` fields under `beat` from all documents. @@ -13,4 +13,4 @@ processors: fields: ['agent'] ---- -include::{libbeat-dir}/docs/processors-using.asciidoc[] +include::{libbeat-dir}/processors-using.asciidoc[] diff --git a/metricbeat/docs/metricbeat-general-options.asciidoc b/metricbeat/docs/metricbeat-general-options.asciidoc index 3aff4ec257de..3c3ce834b0ec 100644 --- a/metricbeat/docs/metricbeat-general-options.asciidoc +++ b/metricbeat/docs/metricbeat-general-options.asciidoc @@ -42,4 +42,4 @@ timeseries.enabled: true ---- -include::{libbeat-dir}/docs/generalconfig.asciidoc[] +include::{libbeat-dir}/generalconfig.asciidoc[] diff --git a/metricbeat/docs/metricbeat-options.asciidoc b/metricbeat/docs/metricbeat-options.asciidoc index fb39a129d204..675d46262266 100644 --- a/metricbeat/docs/metricbeat-options.asciidoc +++ b/metricbeat/docs/metricbeat-options.asciidoc @@ -6,7 +6,7 @@ Metricbeat provides a couple different ways to enable modules and metricsets: * <> * <> -include::{libbeat-dir}/docs/shared-note-file-permissions.asciidoc[] +include::{libbeat-dir}/shared-note-file-permissions.asciidoc[] [float] [[enable-modules-d-configs]] diff --git a/metricbeat/docs/overview.asciidoc b/metricbeat/docs/overview.asciidoc index 2f1cb50830f4..95cf3c7789c5 100644 --- a/metricbeat/docs/overview.asciidoc +++ b/metricbeat/docs/overview.asciidoc @@ -28,4 +28,4 @@ See <> for the complete list of supported services. Metricbeat can insert the collected metrics directly into Elasticsearch or send them to Logstash, Redis, or Kafka. -include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[] +include::{libbeat-dir}/shared-libbeat-description.asciidoc[] diff --git a/metricbeat/docs/reload-configuration.asciidoc b/metricbeat/docs/reload-configuration.asciidoc index 630920aa319e..49fedc9271e5 100644 --- a/metricbeat/docs/reload-configuration.asciidoc +++ b/metricbeat/docs/reload-configuration.asciidoc @@ -38,7 +38,7 @@ definitions. For example: ------------------------------------------------------------------------------ -include::{libbeat-dir}/docs/shared-note-file-permissions.asciidoc[] +include::{libbeat-dir}/shared-note-file-permissions.asciidoc[] === Live reloading @@ -80,4 +80,4 @@ set the `period` to less than 1s because the modification time of files is often stored in seconds. Setting the `period` to less than 1s will result in unnecessary overhead. -include::{libbeat-dir}/docs/shared-note-file-permissions.asciidoc[] +include::{libbeat-dir}/shared-note-file-permissions.asciidoc[] diff --git a/metricbeat/docs/running-on-docker.asciidoc b/metricbeat/docs/running-on-docker.asciidoc index 97736a319c47..c51f1314beed 100644 --- a/metricbeat/docs/running-on-docker.asciidoc +++ b/metricbeat/docs/running-on-docker.asciidoc @@ -1,4 +1,4 @@ -include::{libbeat-dir}/docs/shared-docker.asciidoc[] +include::{libbeat-dir}/shared-docker.asciidoc[] [float] [[monitoring-host]] diff --git a/metricbeat/docs/setting-up-running.asciidoc b/metricbeat/docs/setting-up-running.asciidoc index 3121309d6a6b..9ae0014d472a 100644 --- a/metricbeat/docs/setting-up-running.asciidoc +++ b/metricbeat/docs/setting-up-running.asciidoc @@ -26,16 +26,16 @@ This section includes additional information on how to set up and run //MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too. -include::{libbeat-dir}/docs/shared-directory-layout.asciidoc[] +include::{libbeat-dir}/shared-directory-layout.asciidoc[] -include::{libbeat-dir}/docs/keystore.asciidoc[] +include::{libbeat-dir}/keystore.asciidoc[] -include::{libbeat-dir}/docs/command-reference.asciidoc[] +include::{libbeat-dir}/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] include::./running-on-kubernetes.asciidoc[] -include::{libbeat-dir}/docs/shared-systemd.asciidoc[] +include::{libbeat-dir}/shared-systemd.asciidoc[] -include::{libbeat-dir}/docs/shared-shutdown.asciidoc[] +include::{libbeat-dir}/shared-shutdown.asciidoc[] diff --git a/metricbeat/docs/troubleshooting.asciidoc b/metricbeat/docs/troubleshooting.asciidoc index 805878c311b1..07ed381f9084 100644 --- a/metricbeat/docs/troubleshooting.asciidoc +++ b/metricbeat/docs/troubleshooting.asciidoc @@ -16,11 +16,11 @@ If you have issues installing or running {beatname_uc}, read the following tips: [[getting-help]] == Get help -include::{libbeat-dir}/docs/getting-help.asciidoc[] +include::{libbeat-dir}/getting-help.asciidoc[] //sets block macro for debugging.asciidoc included in next section [[enable-metricbeat-debugging]] == Debug -include::{libbeat-dir}/docs/debugging.asciidoc[] +include::{libbeat-dir}/debugging.asciidoc[] diff --git a/packetbeat/docs/configuring-howto.asciidoc b/packetbeat/docs/configuring-howto.asciidoc index 90a19ee2ddaa..0ac11ad1b70a 100644 --- a/packetbeat/docs/configuring-howto.asciidoc +++ b/packetbeat/docs/configuring-howto.asciidoc @@ -47,36 +47,36 @@ include::./packetbeat-options.asciidoc[] include::./packetbeat-general-options.asciidoc[] -include::{libbeat-dir}/docs/queueconfig.asciidoc[] +include::{libbeat-dir}/queueconfig.asciidoc[] -include::{libbeat-dir}/docs/outputconfig.asciidoc[] +include::{libbeat-dir}/outputconfig.asciidoc[] -include::{libbeat-dir}/docs/shared-ilm.asciidoc[] +include::{libbeat-dir}/shared-ilm.asciidoc[] -include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[] +include::{libbeat-dir}/shared-ssl-config.asciidoc[] include::./packetbeat-filtering.asciidoc[] -include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[] +include::{libbeat-dir}/shared-config-ingest.asciidoc[] -include::{libbeat-dir}/docs/shared-geoip.asciidoc[] +include::{libbeat-dir}/shared-geoip.asciidoc[] -include::{libbeat-dir}/docs/shared-path-config.asciidoc[] +include::{libbeat-dir}/shared-path-config.asciidoc[] -include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[] +include::{libbeat-dir}/shared-kibana-config.asciidoc[] -include::{libbeat-dir}/docs/setup-config.asciidoc[] +include::{libbeat-dir}/setup-config.asciidoc[] -include::{libbeat-dir}/docs/loggingconfig.asciidoc[] +include::{libbeat-dir}/loggingconfig.asciidoc[] :standalone: -include::{libbeat-dir}/docs/shared-env-vars.asciidoc[] +include::{libbeat-dir}/shared-env-vars.asciidoc[] :standalone!: :standalone: -include::{libbeat-dir}/docs/yaml.asciidoc[] +include::{libbeat-dir}/yaml.asciidoc[] :standalone!: -include::{libbeat-dir}/docs/http-endpoint.asciidoc[] +include::{libbeat-dir}/http-endpoint.asciidoc[] -include::{libbeat-dir}/docs/reference-yml.asciidoc[] +include::{libbeat-dir}/reference-yml.asciidoc[] diff --git a/packetbeat/docs/faq.asciidoc b/packetbeat/docs/faq.asciidoc index eedc28ca649d..da1f4ae6be8e 100644 --- a/packetbeat/docs/faq.asciidoc +++ b/packetbeat/docs/faq.asciidoc @@ -57,8 +57,8 @@ response messages are not sent. include::./faq-mysql-ssl.asciidoc[] -include::{libbeat-dir}/docs/faq-limit-bandwidth.asciidoc[] +include::{libbeat-dir}/faq-limit-bandwidth.asciidoc[] -include::{libbeat-dir}/docs/shared-faq.asciidoc[] +include::{libbeat-dir}/shared-faq.asciidoc[] -include::{libbeat-dir}/docs/faq-refresh-index.asciidoc[] +include::{libbeat-dir}/faq-refresh-index.asciidoc[] diff --git a/packetbeat/docs/gettingstarted.asciidoc b/packetbeat/docs/gettingstarted.asciidoc index 1ddd0a793193..a00f7737a634 100644 --- a/packetbeat/docs/gettingstarted.asciidoc +++ b/packetbeat/docs/gettingstarted.asciidoc @@ -4,7 +4,7 @@ The best way to understand the value of a network packet analytics system like Packetbeat is to try it on your own traffic. -include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] +include::{libbeat-dir}/shared-getting-started-intro.asciidoc[] * <> * <> @@ -17,7 +17,7 @@ include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] [[packetbeat-installation]] === Step 1: Install Packetbeat -include::{libbeat-dir}/docs/shared-download-and-install.asciidoc[] +include::{libbeat-dir}/shared-download-and-install.asciidoc[] [[deb]] *deb:* @@ -83,7 +83,7 @@ tar xzvf packetbeat-{version}-darwin-x86_64.tar.gz endif::[] -include::{libbeat-dir}/docs/shared-brew-install.asciidoc[] +include::{libbeat-dir}/shared-brew-install.asciidoc[] [[linux]] *linux:* @@ -151,7 +151,7 @@ more information about these options, see <>. [[packetbeat-configuration]] === Step 2: Configure Packetbeat -include::{libbeat-dir}/docs/shared-configuring.asciidoc[] +include::{libbeat-dir}/shared-configuring.asciidoc[] To configure Packetbeat: @@ -233,25 +233,25 @@ packetbeat.protocols: ---------------------------------------------------------------------- + -include::{libbeat-dir}/docs/step-configure-output.asciidoc[] +include::{libbeat-dir}/step-configure-output.asciidoc[] -include::{libbeat-dir}/docs/step-configure-kibana-endpoint.asciidoc[] +include::{libbeat-dir}/step-configure-kibana-endpoint.asciidoc[] -include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[] +include::{libbeat-dir}/step-configure-credentials.asciidoc[] -include::{libbeat-dir}/docs/step-test-config.asciidoc[] +include::{libbeat-dir}/step-test-config.asciidoc[] -include::{libbeat-dir}/docs/step-look-at-config.asciidoc[] +include::{libbeat-dir}/step-look-at-config.asciidoc[] [[packetbeat-template]] === Step 3: Load the index template in Elasticsearch -include::{libbeat-dir}/docs/shared-template-load.asciidoc[] +include::{libbeat-dir}/shared-template-load.asciidoc[] [[load-kibana-dashboards]] === Step 4: Set up the Kibana dashboards -include::{libbeat-dir}/docs/dashboards.asciidoc[] +include::{libbeat-dir}/dashboards.asciidoc[] [[packetbeat-starting]] === Step 5: Start Packetbeat @@ -287,7 +287,7 @@ configuration file, or run Packetbeat with `--strict.perms=false` specified. See {beats-ref}/config-file-permissions.html[Config File Ownership and Permissions]in the _Beats Platform Reference_. -include::{libbeat-dir}/docs/shared-brew-run.asciidoc[] +include::{libbeat-dir}/shared-brew-run.asciidoc[] *win:* @@ -325,7 +325,7 @@ To make it easier for you to get application performance insights from packet data, we have created example {beatname_uc} dashboards. You loaded the dashboards earlier when you ran the `setup` command. -include::{libbeat-dir}/docs/opendashboards.asciidoc[] +include::{libbeat-dir}/opendashboards.asciidoc[] The dashboards are provided as examples. We recommend that you {kibana-ref}/dashboard.html[customize] them to meet your needs. diff --git a/packetbeat/docs/index.asciidoc b/packetbeat/docs/index.asciidoc index 33b27552173b..149fed09afbd 100644 --- a/packetbeat/docs/index.asciidoc +++ b/packetbeat/docs/index.asciidoc @@ -1,8 +1,8 @@ = Packetbeat Reference -:libbeat-dir: {docdir}/../../libbeat +:libbeat-dir: {docdir}/../../libbeat/docs -include::{libbeat-dir}/docs/version.asciidoc[] +include::{libbeat-dir}/version.asciidoc[] include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] @@ -27,13 +27,13 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :no_script_processor: :no_timestamp_processor: -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./overview.asciidoc[] include::./gettingstarted.asciidoc[] -include::{libbeat-dir}/docs/repositories.asciidoc[] +include::{libbeat-dir}/repositories.asciidoc[] include::./setting-up-running.asciidoc[] @@ -43,9 +43,9 @@ include::./configuring-howto.asciidoc[] include::./fields.asciidoc[] -include::{libbeat-dir}/docs/monitoring/monitoring-beats.asciidoc[] +include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[] -include::{libbeat-dir}/docs/shared-securing-beat.asciidoc[] +include::{libbeat-dir}/shared-securing-beat.asciidoc[] include::./visualizing-data-packetbeat.asciidoc[] @@ -55,4 +55,4 @@ include::./troubleshooting.asciidoc[] include::./faq.asciidoc[] -include::{libbeat-dir}/docs/contributing-to-beats.asciidoc[] +include::{libbeat-dir}/contributing-to-beats.asciidoc[] diff --git a/packetbeat/docs/overview.asciidoc b/packetbeat/docs/overview.asciidoc index 51a84590c637..b0797cdcab76 100644 --- a/packetbeat/docs/overview.asciidoc +++ b/packetbeat/docs/overview.asciidoc @@ -44,4 +44,4 @@ network traffic gathered by Packetbeat can be used for analysing the log files gathered by Logstash. This way, you can have network traffic and log analysis in the same system. -include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[] +include::{libbeat-dir}/shared-libbeat-description.asciidoc[] diff --git a/packetbeat/docs/packetbeat-filtering.asciidoc b/packetbeat/docs/packetbeat-filtering.asciidoc index 4fefe9b0bc9e..50dad2d84306 100644 --- a/packetbeat/docs/packetbeat-filtering.asciidoc +++ b/packetbeat/docs/packetbeat-filtering.asciidoc @@ -1,7 +1,7 @@ [[filtering-and-enhancing-data]] == Filter and enhance the exported data -include::{libbeat-dir}/docs/processors.asciidoc[] +include::{libbeat-dir}/processors.asciidoc[] For example, the following configuration includes a subset of the Packetbeat DNS fields so that only the requests and their response codes are reported: @@ -70,4 +70,4 @@ processors: fields: ["request", "response"] ---- -include::{libbeat-dir}/docs/processors-using.asciidoc[] +include::{libbeat-dir}/processors-using.asciidoc[] diff --git a/packetbeat/docs/packetbeat-general-options.asciidoc b/packetbeat/docs/packetbeat-general-options.asciidoc index 60e017c7a29d..2013d3103ee4 100644 --- a/packetbeat/docs/packetbeat-general-options.asciidoc +++ b/packetbeat/docs/packetbeat-general-options.asciidoc @@ -4,5 +4,5 @@ You can specify settings in the +{beatname_lc}.yml+ config file to control the general behavior of {beatname_uc}. -include::{libbeat-dir}/docs/generalconfig.asciidoc[] +include::{libbeat-dir}/generalconfig.asciidoc[] diff --git a/packetbeat/docs/running-on-docker.asciidoc b/packetbeat/docs/running-on-docker.asciidoc index 77fcad1b4931..66ee487c10ec 100644 --- a/packetbeat/docs/running-on-docker.asciidoc +++ b/packetbeat/docs/running-on-docker.asciidoc @@ -1,4 +1,4 @@ -include::{libbeat-dir}/docs/shared-docker.asciidoc[] +include::{libbeat-dir}/shared-docker.asciidoc[] [float] ==== Required network capabilities diff --git a/packetbeat/docs/setting-up-running.asciidoc b/packetbeat/docs/setting-up-running.asciidoc index 66e1ead2027c..8ec02a23fbdf 100644 --- a/packetbeat/docs/setting-up-running.asciidoc +++ b/packetbeat/docs/setting-up-running.asciidoc @@ -24,14 +24,14 @@ This section includes additional information on how to set up and run //MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too. -include::{libbeat-dir}/docs/shared-directory-layout.asciidoc[] +include::{libbeat-dir}/shared-directory-layout.asciidoc[] -include::{libbeat-dir}/docs/keystore.asciidoc[] +include::{libbeat-dir}/keystore.asciidoc[] -include::{libbeat-dir}/docs/command-reference.asciidoc[] +include::{libbeat-dir}/command-reference.asciidoc[] include::./running-on-docker.asciidoc[] -include::{libbeat-dir}/docs/shared-systemd.asciidoc[] +include::{libbeat-dir}/shared-systemd.asciidoc[] -include::{libbeat-dir}/docs/shared-shutdown.asciidoc[] +include::{libbeat-dir}/shared-shutdown.asciidoc[] diff --git a/packetbeat/docs/troubleshooting.asciidoc b/packetbeat/docs/troubleshooting.asciidoc index 4ec0665094fd..738d9ad8d0d6 100644 --- a/packetbeat/docs/troubleshooting.asciidoc +++ b/packetbeat/docs/troubleshooting.asciidoc @@ -18,14 +18,14 @@ following tips: [[getting-help]] == Get help -include::{libbeat-dir}/docs/getting-help.asciidoc[] +include::{libbeat-dir}/getting-help.asciidoc[] //sets block macro for debugging.asciidoc included in next section [[enable-packetbeat-debugging]] == Debug -include::{libbeat-dir}/docs/debugging.asciidoc[] +include::{libbeat-dir}/debugging.asciidoc[] //sets block macro for recording-trace content included in next section diff --git a/winlogbeat/docs/configuring-howto.asciidoc b/winlogbeat/docs/configuring-howto.asciidoc index 811254f037fd..445d5150e0ba 100644 --- a/winlogbeat/docs/configuring-howto.asciidoc +++ b/winlogbeat/docs/configuring-howto.asciidoc @@ -42,36 +42,36 @@ include::./winlogbeat-options.asciidoc[] include::./winlogbeat-general-options.asciidoc[] -include::{libbeat-dir}/docs/queueconfig.asciidoc[] +include::{libbeat-dir}/queueconfig.asciidoc[] -include::{libbeat-dir}/docs/outputconfig.asciidoc[] +include::{libbeat-dir}/outputconfig.asciidoc[] -include::{libbeat-dir}/docs/shared-ilm.asciidoc[] +include::{libbeat-dir}/shared-ilm.asciidoc[] -include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[] +include::{libbeat-dir}/shared-ssl-config.asciidoc[] include::./winlogbeat-filtering.asciidoc[] -include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[] +include::{libbeat-dir}/shared-config-ingest.asciidoc[] -include::{libbeat-dir}/docs/shared-geoip.asciidoc[] +include::{libbeat-dir}/shared-geoip.asciidoc[] -include::{libbeat-dir}/docs/shared-path-config.asciidoc[] +include::{libbeat-dir}/shared-path-config.asciidoc[] -include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[] +include::{libbeat-dir}/shared-kibana-config.asciidoc[] -include::{libbeat-dir}/docs/setup-config.asciidoc[] +include::{libbeat-dir}/setup-config.asciidoc[] -include::{libbeat-dir}/docs/loggingconfig.asciidoc[] +include::{libbeat-dir}/loggingconfig.asciidoc[] :standalone: -include::{libbeat-dir}/docs/shared-env-vars.asciidoc[] +include::{libbeat-dir}/shared-env-vars.asciidoc[] :standalone!: :standalone: -include::{libbeat-dir}/docs/yaml.asciidoc[] +include::{libbeat-dir}/yaml.asciidoc[] :standalone!: -include::{libbeat-dir}/docs/http-endpoint.asciidoc[] +include::{libbeat-dir}/http-endpoint.asciidoc[] -include::{libbeat-dir}/docs/reference-yml.asciidoc[] +include::{libbeat-dir}/reference-yml.asciidoc[] diff --git a/winlogbeat/docs/faq.asciidoc b/winlogbeat/docs/faq.asciidoc index 737987817e81..9f8d891d7b31 100644 --- a/winlogbeat/docs/faq.asciidoc +++ b/winlogbeat/docs/faq.asciidoc @@ -16,7 +16,7 @@ The index template might not be loaded correctly. See <>. Prior to the hostname configuration stage, during OS installation any event log records generated may have a randomly assigned hostname. -include::{libbeat-dir}/docs/shared-faq.asciidoc[] +include::{libbeat-dir}/shared-faq.asciidoc[] [[reading-from-evtx]] === Not sure how to read from .evtx files diff --git a/winlogbeat/docs/getting-started.asciidoc b/winlogbeat/docs/getting-started.asciidoc index 0c139ade45ef..ba9d4eaae9da 100644 --- a/winlogbeat/docs/getting-started.asciidoc +++ b/winlogbeat/docs/getting-started.asciidoc @@ -1,7 +1,7 @@ [[winlogbeat-getting-started]] == Getting Started With Winlogbeat -include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] +include::{libbeat-dir}/shared-getting-started-intro.asciidoc[] * <> * <> @@ -95,11 +95,11 @@ To obtain a list of available event logs, run `Get-EventLog *` in PowerShell. For more information about this command, see the configuration details for <>. -include::{libbeat-dir}/docs/step-configure-output.asciidoc[] +include::{libbeat-dir}/step-configure-output.asciidoc[] -include::{libbeat-dir}/docs/step-configure-kibana-endpoint.asciidoc[] +include::{libbeat-dir}/step-configure-kibana-endpoint.asciidoc[] -include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[] +include::{libbeat-dir}/step-configure-credentials.asciidoc[] . After you save your configuration file, test it with the following command. + @@ -111,17 +111,17 @@ PS C:\Program Files\Winlogbeat> .\winlogbeat.exe test config -c .\winlogbeat.yml [[config-winlogbeat-logstash]] === Step 3: Configure Winlogbeat to use Logstash -include::{libbeat-dir}/docs/outputs/output-logstash.asciidoc[tag=shared-logstash-config] +include::{libbeat-dir}/outputs/output-logstash.asciidoc[tag=shared-logstash-config] [[winlogbeat-template]] === Step 4: Load the index template in Elasticsearch -include::{libbeat-dir}/docs/shared-template-load.asciidoc[] +include::{libbeat-dir}/shared-template-load.asciidoc[] [[load-kibana-dashboards]] === Step 5: Set up the Kibana dashboards -include::{libbeat-dir}/docs/dashboards.asciidoc[] +include::{libbeat-dir}/dashboards.asciidoc[] [[winlogbeat-starting]] === Step 6: Start Winlogbeat @@ -164,7 +164,7 @@ To make it easier for you to start monitoring your servers in Kibana, we have created example {beatname_uc} dashboards. You loaded the dashboards earlier when you ran the `setup` command. -include::{libbeat-dir}/docs/opendashboards.asciidoc[] +include::{libbeat-dir}/opendashboards.asciidoc[] The dashboards are provided as examples. We recommend that you {kibana-ref}/dashboard.html[customize] them to meet your needs. diff --git a/winlogbeat/docs/index.asciidoc b/winlogbeat/docs/index.asciidoc index 28f8b47c020e..4046b891ac8e 100644 --- a/winlogbeat/docs/index.asciidoc +++ b/winlogbeat/docs/index.asciidoc @@ -1,8 +1,8 @@ = Winlogbeat Reference -:libbeat-dir: {docdir}/../../libbeat +:libbeat-dir: {docdir}/../../libbeat/docs -include::{libbeat-dir}/docs/version.asciidoc[] +include::{libbeat-dir}/version.asciidoc[] include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] @@ -21,7 +21,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :no_decode_cef_processor: :no_decode_csv_fields_processor: -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./overview.asciidoc[] @@ -37,13 +37,13 @@ include::./modules.asciidoc[] include::./fields.asciidoc[] -include::{libbeat-dir}/docs/monitoring/monitoring-beats.asciidoc[] +include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[] -include::{libbeat-dir}/docs/shared-securing-beat.asciidoc[] +include::{libbeat-dir}/shared-securing-beat.asciidoc[] include::./troubleshooting.asciidoc[] include::./faq.asciidoc[] -include::{libbeat-dir}/docs/contributing-to-beats.asciidoc[] +include::{libbeat-dir}/contributing-to-beats.asciidoc[] diff --git a/winlogbeat/docs/overview.asciidoc b/winlogbeat/docs/overview.asciidoc index d3b96ab6557e..04f9cd5f7860 100644 --- a/winlogbeat/docs/overview.asciidoc +++ b/winlogbeat/docs/overview.asciidoc @@ -22,4 +22,4 @@ For example, you can capture events such as: * security events * system events -include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[] +include::{libbeat-dir}/shared-libbeat-description.asciidoc[] diff --git a/winlogbeat/docs/setting-up-running.asciidoc b/winlogbeat/docs/setting-up-running.asciidoc index d0baf63f9f27..4ca55ed9beef 100644 --- a/winlogbeat/docs/setting-up-running.asciidoc +++ b/winlogbeat/docs/setting-up-running.asciidoc @@ -20,10 +20,10 @@ This section includes additional information on how to set up and run //MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too. -include::{libbeat-dir}/docs/shared-directory-layout.asciidoc[] +include::{libbeat-dir}/shared-directory-layout.asciidoc[] -include::{libbeat-dir}/docs/keystore.asciidoc[] +include::{libbeat-dir}/keystore.asciidoc[] -include::{libbeat-dir}/docs/command-reference.asciidoc[] +include::{libbeat-dir}/command-reference.asciidoc[] -include::{libbeat-dir}/docs/shared-shutdown.asciidoc[] +include::{libbeat-dir}/shared-shutdown.asciidoc[] diff --git a/winlogbeat/docs/troubleshooting.asciidoc b/winlogbeat/docs/troubleshooting.asciidoc index 3e21e59a0dbf..cfab0a586e18 100644 --- a/winlogbeat/docs/troubleshooting.asciidoc +++ b/winlogbeat/docs/troubleshooting.asciidoc @@ -16,7 +16,7 @@ If you have issues installing or running Winlogbeat, read the following tips: [[getting-help]] == Get Help -include::{libbeat-dir}/docs/getting-help.asciidoc[] +include::{libbeat-dir}/getting-help.asciidoc[] //sets block macro for debugging.asciidoc included in next section @@ -24,4 +24,4 @@ include::{libbeat-dir}/docs/getting-help.asciidoc[] [[enable-winlogbeat-debugging]] == Debug -include::{libbeat-dir}/docs/debugging.asciidoc[] +include::{libbeat-dir}/debugging.asciidoc[] diff --git a/winlogbeat/docs/winlogbeat-filtering.asciidoc b/winlogbeat/docs/winlogbeat-filtering.asciidoc index c6fd80e2250b..f9302db3db62 100644 --- a/winlogbeat/docs/winlogbeat-filtering.asciidoc +++ b/winlogbeat/docs/winlogbeat-filtering.asciidoc @@ -1,7 +1,7 @@ [[filtering-and-enhancing-data]] == Filter and Enhance the exported data -include::{libbeat-dir}/docs/processors.asciidoc[] +include::{libbeat-dir}/processors.asciidoc[] For example, the following filter configuration drops a few fields that are rarely used (`provider_guid`, `process_id`, `thread_id`, and `version`) and one nested field, `event_data.ErrorSourceTable`: @@ -12,5 +12,5 @@ processors: fields: [winlog.provider_guid, winlog.process.pid, winlog.process.thread.id, winlog.version, winlog.event_data.ErrorSourceTable] ----------------------------------------------------- -include::{libbeat-dir}/docs/processors-using.asciidoc[] +include::{libbeat-dir}/processors-using.asciidoc[] diff --git a/winlogbeat/docs/winlogbeat-general-options.asciidoc b/winlogbeat/docs/winlogbeat-general-options.asciidoc index df2e66555126..6fb7ba164e9b 100644 --- a/winlogbeat/docs/winlogbeat-general-options.asciidoc +++ b/winlogbeat/docs/winlogbeat-general-options.asciidoc @@ -4,4 +4,4 @@ You can specify settings in the +{beatname_lc}.yml+ config file to control the general behavior of {beatname_uc}. -include::{libbeat-dir}/docs/generalconfig.asciidoc[] +include::{libbeat-dir}/generalconfig.asciidoc[] diff --git a/x-pack/functionbeat/docs/configuring-howto.asciidoc b/x-pack/functionbeat/docs/configuring-howto.asciidoc index 8eda42459997..5ba496f38fd4 100644 --- a/x-pack/functionbeat/docs/configuring-howto.asciidoc +++ b/x-pack/functionbeat/docs/configuring-howto.asciidoc @@ -8,7 +8,7 @@ Before modifying configuration settings, make sure you've completed the <<{beatname_lc}-configuration,configuration steps>> in the Getting Started. This section describes some common use cases for changing configuration options. -include::{libbeat-dir}/docs/shared-configuring.asciidoc[] +include::{libbeat-dir}/shared-configuring.asciidoc[] The following topics describe how to configure {beatname_uc}: @@ -37,62 +37,62 @@ include::./general-options.asciidoc[] :allplatforms: [role="xpack"] -include::{libbeat-dir}/docs/queueconfig.asciidoc[] +include::{libbeat-dir}/queueconfig.asciidoc[] :allplatforms!: [role="xpack"] -include::{libbeat-dir}/docs/outputconfig.asciidoc[tag=shared-outputconfig] +include::{libbeat-dir}/outputconfig.asciidoc[tag=shared-outputconfig] * <> * <> * <> [role="xpack"] -include::{libbeat-dir}/docs/outputs/output-elasticsearch.asciidoc[] +include::{libbeat-dir}/outputs/output-elasticsearch.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/outputs/output-logstash.asciidoc[] +include::{libbeat-dir}/outputs/output-logstash.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/outputs/output-cloud.asciidoc[] +include::{libbeat-dir}/outputs/output-cloud.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/shared-ilm.asciidoc[] +include::{libbeat-dir}/shared-ilm.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/shared-ssl-config.asciidoc[] +include::{libbeat-dir}/shared-ssl-config.asciidoc[] include::./filtering.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/shared-config-ingest.asciidoc[] +include::{libbeat-dir}/shared-config-ingest.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/shared-geoip.asciidoc[] +include::{libbeat-dir}/shared-geoip.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/shared-kibana-config.asciidoc[] +include::{libbeat-dir}/shared-kibana-config.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/setup-config.asciidoc[] +include::{libbeat-dir}/setup-config.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/loggingconfig.asciidoc[] +include::{libbeat-dir}/loggingconfig.asciidoc[] :standalone: [role="xpack"] -include::{libbeat-dir}/docs/shared-env-vars.asciidoc[] +include::{libbeat-dir}/shared-env-vars.asciidoc[] :standalone!: :standalone: :allplatforms: [role="xpack"] -include::{libbeat-dir}/docs/yaml.asciidoc[] +include::{libbeat-dir}/yaml.asciidoc[] :standalone!: :allplatforms!: [role="xpack"] -include::{libbeat-dir}/docs/regexp.asciidoc[] +include::{libbeat-dir}/regexp.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/reference-yml.asciidoc[] +include::{libbeat-dir}/reference-yml.asciidoc[] diff --git a/x-pack/functionbeat/docs/faq.asciidoc b/x-pack/functionbeat/docs/faq.asciidoc index 2bf340c52070..6e942b9633cd 100644 --- a/x-pack/functionbeat/docs/faq.asciidoc +++ b/x-pack/functionbeat/docs/faq.asciidoc @@ -19,5 +19,5 @@ deployment fails. include::faq-resource-limit.asciidoc[] -include::{libbeat-dir}/docs/shared-faq.asciidoc[] +include::{libbeat-dir}/shared-faq.asciidoc[] diff --git a/x-pack/functionbeat/docs/filtering.asciidoc b/x-pack/functionbeat/docs/filtering.asciidoc index c4f9fe9614fe..37f4ada3adb3 100644 --- a/x-pack/functionbeat/docs/filtering.asciidoc +++ b/x-pack/functionbeat/docs/filtering.asciidoc @@ -19,8 +19,8 @@ Another approach (the one described here) is to define processors. [[using-processors]] === Processors -include::{libbeat-dir}/docs/processors.asciidoc[] +include::{libbeat-dir}/processors.asciidoc[] :processor-scope: function -include::{libbeat-dir}/docs/processors-using.asciidoc[] +include::{libbeat-dir}/processors-using.asciidoc[] :processor-scope!: diff --git a/x-pack/functionbeat/docs/general-options.asciidoc b/x-pack/functionbeat/docs/general-options.asciidoc index 2b4233b643cd..91ef914c5025 100644 --- a/x-pack/functionbeat/docs/general-options.asciidoc +++ b/x-pack/functionbeat/docs/general-options.asciidoc @@ -5,5 +5,5 @@ You can specify settings in the +{beatname_lc}.yml+ config file to control the general behavior of {beatname_uc}. -include::{libbeat-dir}/docs/generalconfig.asciidoc[] +include::{libbeat-dir}/generalconfig.asciidoc[] diff --git a/x-pack/functionbeat/docs/getting-started.asciidoc b/x-pack/functionbeat/docs/getting-started.asciidoc index 26527e17b021..f62b2981f04e 100644 --- a/x-pack/functionbeat/docs/getting-started.asciidoc +++ b/x-pack/functionbeat/docs/getting-started.asciidoc @@ -2,7 +2,7 @@ [role="xpack"] == Getting Started With {beatname_uc} -include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] +include::{libbeat-dir}/shared-getting-started-intro.asciidoc[] * <<{beatname_lc}-installation>> * <<{beatname_lc}-configuration>> @@ -150,20 +150,20 @@ from Amazon SQS: - event_source_arn: arn:aws:sqs:us-east-1:123456789012:myevents ---- -include::{libbeat-dir}/docs/step-configure-output.asciidoc[] +include::{libbeat-dir}/step-configure-output.asciidoc[] -include::{libbeat-dir}/docs/step-configure-credentials.asciidoc[] +include::{libbeat-dir}/step-configure-credentials.asciidoc[] -include::{libbeat-dir}/docs/step-test-config.asciidoc[] +include::{libbeat-dir}/step-test-config.asciidoc[] -include::{libbeat-dir}/docs/step-look-at-config.asciidoc[] +include::{libbeat-dir}/step-look-at-config.asciidoc[] [id="{beatname_lc}-template"] [role="xpack"] === Step 3: Load the index template in Elasticsearch :allplatforms: -include::{libbeat-dir}/docs/shared-template-load.asciidoc[] +include::{libbeat-dir}/shared-template-load.asciidoc[] [id="{beatname_lc}-deploying"] [role="xpack"] diff --git a/x-pack/functionbeat/docs/index.asciidoc b/x-pack/functionbeat/docs/index.asciidoc index 61d78f85c053..f8cc736c22ed 100644 --- a/x-pack/functionbeat/docs/index.asciidoc +++ b/x-pack/functionbeat/docs/index.asciidoc @@ -1,8 +1,8 @@ = Functionbeat Reference -:libbeat-dir: {docdir}/../../../libbeat +:libbeat-dir: {docdir}/../../../libbeat/docs -include::{libbeat-dir}/docs/version.asciidoc[] +include::{libbeat-dir}/version.asciidoc[] include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] @@ -30,7 +30,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :no_script_processor: :no_timestamp_processor: -include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] +include::{libbeat-dir}/shared-beats-attributes.asciidoc[] include::./overview.asciidoc[] @@ -44,10 +44,10 @@ include::./configuring-howto.asciidoc[] include::./fields.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/monitoring/monitoring-beats.asciidoc[] +include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/shared-securing-beat.asciidoc[] +include::{libbeat-dir}/shared-securing-beat.asciidoc[] include::./troubleshooting.asciidoc[] diff --git a/x-pack/functionbeat/docs/overview.asciidoc b/x-pack/functionbeat/docs/overview.asciidoc index bed75859c974..6837140f48e3 100644 --- a/x-pack/functionbeat/docs/overview.asciidoc +++ b/x-pack/functionbeat/docs/overview.asciidoc @@ -19,7 +19,7 @@ responds to the triggers defined for the following event sources: image::./images/diagram-functionbeat-architecture.svg["{beatname_uc} collects events generated by cloud services"] -include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[] +include::{libbeat-dir}/shared-libbeat-description.asciidoc[] The following sections explore some common use cases for {beatname_uc}: diff --git a/x-pack/functionbeat/docs/setting-up-running.asciidoc b/x-pack/functionbeat/docs/setting-up-running.asciidoc index 7aef0bd5c473..99be5e317fd4 100644 --- a/x-pack/functionbeat/docs/setting-up-running.asciidoc +++ b/x-pack/functionbeat/docs/setting-up-running.asciidoc @@ -31,16 +31,16 @@ This section includes additional information on how to set up and run //MAINTAINERS: If you add a new file to this section, make sure you update the bulleted list ^^ too. [role="xpack"] -include::{libbeat-dir}/docs/shared-directory-layout.asciidoc[] +include::{libbeat-dir}/shared-directory-layout.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/keystore.asciidoc[] +include::{libbeat-dir}/keystore.asciidoc[] include::iam-permissions.asciidoc[] include::deploying.asciidoc[] [role="xpack"] -include::{libbeat-dir}/docs/command-reference.asciidoc[] +include::{libbeat-dir}/command-reference.asciidoc[] include::export-cloudformation-template.asciidoc[] diff --git a/x-pack/functionbeat/docs/troubleshooting.asciidoc b/x-pack/functionbeat/docs/troubleshooting.asciidoc index d9f37f6a252e..b67c2dee6b70 100644 --- a/x-pack/functionbeat/docs/troubleshooting.asciidoc +++ b/x-pack/functionbeat/docs/troubleshooting.asciidoc @@ -19,7 +19,7 @@ following tips: [role="xpack"] == Get help -include::{libbeat-dir}/docs/getting-help.asciidoc[] +include::{libbeat-dir}/getting-help.asciidoc[] //sets block macro for debugging.asciidoc included in next section @@ -27,7 +27,7 @@ include::{libbeat-dir}/docs/getting-help.asciidoc[] [role="xpack"] == Debug -include::{libbeat-dir}/docs/debugging.asciidoc[] +include::{libbeat-dir}/debugging.asciidoc[]