From efdd057ce399a27f9bc59edd268227cf778ee675 Mon Sep 17 00:00:00 2001 From: Jaime Soriano Pastor Date: Thu, 22 Aug 2019 15:52:39 +0200 Subject: [PATCH] Add explanations about timezone support to filebeat modules (#13313) Add documentation about the use of `event.timezone` in modules that do some kind of timestamp parsing in their pipelines. Related to #12469 (cherry picked from commit 1c95ea57d88e7b9e01155af8f9c92c6f29c520db) --- filebeat/docs/modules/cisco.asciidoc | 2 ++ filebeat/docs/modules/elasticsearch.asciidoc | 2 ++ filebeat/docs/modules/iptables.asciidoc | 2 ++ filebeat/docs/modules/logstash.asciidoc | 2 ++ filebeat/docs/modules/mssql.asciidoc | 2 ++ filebeat/docs/modules/nginx.asciidoc | 2 ++ filebeat/docs/modules/panw.asciidoc | 2 ++ filebeat/module/elasticsearch/_meta/docs.asciidoc | 2 ++ filebeat/module/logstash/_meta/docs.asciidoc | 2 ++ filebeat/module/nginx/_meta/docs.asciidoc | 2 ++ x-pack/filebeat/module/cisco/_meta/docs.asciidoc | 2 ++ x-pack/filebeat/module/iptables/_meta/docs.asciidoc | 2 ++ x-pack/filebeat/module/mssql/_meta/docs.asciidoc | 2 ++ x-pack/filebeat/module/panw/_meta/docs.asciidoc | 2 ++ 14 files changed, 28 insertions(+) diff --git a/filebeat/docs/modules/cisco.asciidoc b/filebeat/docs/modules/cisco.asciidoc index ab48e1d4f71e..5c6441e556f3 100644 --- a/filebeat/docs/modules/cisco.asciidoc +++ b/filebeat/docs/modules/cisco.asciidoc @@ -130,6 +130,8 @@ Set to 0.0.0.0 to bind to all available interfaces. The UDP port to listen for syslog traffic. Defaults to 9002. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/filebeat/docs/modules/elasticsearch.asciidoc b/filebeat/docs/modules/elasticsearch.asciidoc index d9a8c47a5b82..730dcd0177ab 100644 --- a/filebeat/docs/modules/elasticsearch.asciidoc +++ b/filebeat/docs/modules/elasticsearch.asciidoc @@ -123,6 +123,8 @@ NOTE: If you're running against Elasticsearch >= 7.0.0, configure the `var.paths` setting to point to JSON logs. Otherwise, configure it to point to plain text logs. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/filebeat/docs/modules/iptables.asciidoc b/filebeat/docs/modules/iptables.asciidoc index 0ab091fe4a70..c9e9714fa60b 100644 --- a/filebeat/docs/modules/iptables.asciidoc +++ b/filebeat/docs/modules/iptables.asciidoc @@ -75,6 +75,8 @@ The UDP port to listen for syslog traffic. Defaults to `9001` NOTE: Ports below 1024 require Filebeat to run as root. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/filebeat/docs/modules/logstash.asciidoc b/filebeat/docs/modules/logstash.asciidoc index 34b29110fb21..8776e2d1a880 100644 --- a/filebeat/docs/modules/logstash.asciidoc +++ b/filebeat/docs/modules/logstash.asciidoc @@ -94,6 +94,8 @@ include::../include/var-paths.asciidoc[] The configured Logstash log format. Possible values are: `json` or `plain`. The default is `plain`. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/filebeat/docs/modules/mssql.asciidoc b/filebeat/docs/modules/mssql.asciidoc index 83f83a82549a..4442766a1ecc 100644 --- a/filebeat/docs/modules/mssql.asciidoc +++ b/filebeat/docs/modules/mssql.asciidoc @@ -48,6 +48,8 @@ include::../include/config-option-intro.asciidoc[] include::../include/var-paths.asciidoc[] +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/filebeat/docs/modules/nginx.asciidoc b/filebeat/docs/modules/nginx.asciidoc index 398d8597e8ee..5e65820905b1 100644 --- a/filebeat/docs/modules/nginx.asciidoc +++ b/filebeat/docs/modules/nginx.asciidoc @@ -74,6 +74,8 @@ include::../include/var-paths.asciidoc[] include::../include/var-paths.asciidoc[] +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/filebeat/docs/modules/panw.asciidoc b/filebeat/docs/modules/panw.asciidoc index 79b8d1735448..ca96711fce4b 100644 --- a/filebeat/docs/modules/panw.asciidoc +++ b/filebeat/docs/modules/panw.asciidoc @@ -177,6 +177,8 @@ The UDP port to listen for syslog traffic. Defaults to `9001` NOTE: Ports below 1024 require {beatname_uc} to run as root. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/filebeat/module/elasticsearch/_meta/docs.asciidoc b/filebeat/module/elasticsearch/_meta/docs.asciidoc index 4890c928cfd7..0f41f3366514 100755 --- a/filebeat/module/elasticsearch/_meta/docs.asciidoc +++ b/filebeat/module/elasticsearch/_meta/docs.asciidoc @@ -118,6 +118,8 @@ NOTE: If you're running against Elasticsearch >= 7.0.0, configure the `var.paths` setting to point to JSON logs. Otherwise, configure it to point to plain text logs. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/filebeat/module/logstash/_meta/docs.asciidoc b/filebeat/module/logstash/_meta/docs.asciidoc index 22d0a47e1f9a..c59685c00b42 100644 --- a/filebeat/module/logstash/_meta/docs.asciidoc +++ b/filebeat/module/logstash/_meta/docs.asciidoc @@ -89,6 +89,8 @@ include::../include/var-paths.asciidoc[] The configured Logstash log format. Possible values are: `json` or `plain`. The default is `plain`. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/filebeat/module/nginx/_meta/docs.asciidoc b/filebeat/module/nginx/_meta/docs.asciidoc index 8488abeb2ff1..e9d03ceae70c 100644 --- a/filebeat/module/nginx/_meta/docs.asciidoc +++ b/filebeat/module/nginx/_meta/docs.asciidoc @@ -69,6 +69,8 @@ include::../include/var-paths.asciidoc[] include::../include/var-paths.asciidoc[] +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/x-pack/filebeat/module/cisco/_meta/docs.asciidoc b/x-pack/filebeat/module/cisco/_meta/docs.asciidoc index a9d4903db79a..2b19673057fa 100644 --- a/x-pack/filebeat/module/cisco/_meta/docs.asciidoc +++ b/x-pack/filebeat/module/cisco/_meta/docs.asciidoc @@ -125,6 +125,8 @@ Set to 0.0.0.0 to bind to all available interfaces. The UDP port to listen for syslog traffic. Defaults to 9002. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/x-pack/filebeat/module/iptables/_meta/docs.asciidoc b/x-pack/filebeat/module/iptables/_meta/docs.asciidoc index cc0fe800e7e2..12875fb946e6 100644 --- a/x-pack/filebeat/module/iptables/_meta/docs.asciidoc +++ b/x-pack/filebeat/module/iptables/_meta/docs.asciidoc @@ -70,6 +70,8 @@ The UDP port to listen for syslog traffic. Defaults to `9001` NOTE: Ports below 1024 require Filebeat to run as root. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/x-pack/filebeat/module/mssql/_meta/docs.asciidoc b/x-pack/filebeat/module/mssql/_meta/docs.asciidoc index 3f74f125767b..969105e1c49e 100644 --- a/x-pack/filebeat/module/mssql/_meta/docs.asciidoc +++ b/x-pack/filebeat/module/mssql/_meta/docs.asciidoc @@ -43,6 +43,8 @@ include::../include/config-option-intro.asciidoc[] include::../include/var-paths.asciidoc[] +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: diff --git a/x-pack/filebeat/module/panw/_meta/docs.asciidoc b/x-pack/filebeat/module/panw/_meta/docs.asciidoc index 54d12835264b..2e50e3d2f2b1 100644 --- a/x-pack/filebeat/module/panw/_meta/docs.asciidoc +++ b/x-pack/filebeat/module/panw/_meta/docs.asciidoc @@ -172,6 +172,8 @@ The UDP port to listen for syslog traffic. Defaults to `9001` NOTE: Ports below 1024 require {beatname_uc} to run as root. +include::../include/timezone-support.asciidoc[] + :has-dashboards!: :fileset_ex!: