Skip to content

Commit

Permalink
Add ingress_controller docs (#17510) (#17584)
Browse files Browse the repository at this point in the history
Signed-off-by: chrismark <[email protected]>
(cherry picked from commit c0f1854)
  • Loading branch information
ChrsMark authored Apr 8, 2020
1 parent 329eb1a commit 8876d65
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 2 deletions.
22 changes: 21 additions & 1 deletion filebeat/docs/modules/nginx.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ This file is generated! See scripts/docs_collector.py
The +{modulename}+ module parses access and error logs created by the
http://nginx.org/[Nginx] HTTP server.

`ingress_controller` fileset parses access logs created by https://github.com/kubernetes/ingress-nginx[ingress-nginx] controller.
Log patterns could be found on the controllers'
https://github.com/kubernetes/ingress-nginx/blob/nginx-0.28.0/docs/user-guide/nginx-configuration/log-format.md[docs].

include::../include/what-happens.asciidoc[]

include::../include/gs-link.asciidoc[]
Expand All @@ -24,6 +28,8 @@ The Nginx module was tested with logs from version 1.10.
On Windows, the module was tested with Nginx installed from the Chocolatey
repository.

`ingress_controller` fileset was tested with version 0.28.0 of `nginx-ingress-controller`.

include::../include/configuring-intro.asciidoc[]

The following example shows how to set paths in the +modules.d/{modulename}.yml+
Expand All @@ -48,8 +54,17 @@ To specify the same settings at the command line, you use:
-M "nginx.access.var.paths=[/path/to/log/nginx/access.log*]" -M "nginx.error.var.paths=[/path/to/log/nginx/error.log*]"
-----

The following example shows how to configure `ingress_controller` fileset which can be used in Kubernetes environments
to parse ingress-nginx logs:

["source","yaml",subs="attributes"]
-----
- module: nginx
ingress_controller:
enabled: true
var.paths: ["/path/to/log/nginx/ingress.log"]
-----



//set the fileset name used in the included example
:fileset_ex: access
Expand All @@ -66,6 +81,11 @@ include::../include/var-paths.asciidoc[]

include::../include/var-paths.asciidoc[]

[float]
==== `ingress_controller` log fileset

include::../include/var-paths.asciidoc[]

include::../include/timezone-support.asciidoc[]

[float]
Expand Down
22 changes: 21 additions & 1 deletion filebeat/module/nginx/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
The +{modulename}+ module parses access and error logs created by the
http://nginx.org/[Nginx] HTTP server.

`ingress_controller` fileset parses access logs created by https://github.com/kubernetes/ingress-nginx[ingress-nginx] controller.
Log patterns could be found on the controllers'
https://github.com/kubernetes/ingress-nginx/blob/nginx-0.28.0/docs/user-guide/nginx-configuration/log-format.md[docs].

include::../include/what-happens.asciidoc[]

include::../include/gs-link.asciidoc[]
Expand All @@ -19,6 +23,8 @@ The Nginx module was tested with logs from version 1.10.
On Windows, the module was tested with Nginx installed from the Chocolatey
repository.

`ingress_controller` fileset was tested with version 0.28.0 of `nginx-ingress-controller`.

include::../include/configuring-intro.asciidoc[]

The following example shows how to set paths in the +modules.d/{modulename}.yml+
Expand All @@ -43,8 +49,17 @@ To specify the same settings at the command line, you use:
-M "nginx.access.var.paths=[/path/to/log/nginx/access.log*]" -M "nginx.error.var.paths=[/path/to/log/nginx/error.log*]"
-----

The following example shows how to configure `ingress_controller` fileset which can be used in Kubernetes environments
to parse ingress-nginx logs:

["source","yaml",subs="attributes"]
-----
- module: nginx
ingress_controller:
enabled: true
var.paths: ["/path/to/log/nginx/ingress.log"]
-----



//set the fileset name used in the included example
:fileset_ex: access
Expand All @@ -61,6 +76,11 @@ include::../include/var-paths.asciidoc[]

include::../include/var-paths.asciidoc[]

[float]
==== `ingress_controller` log fileset

include::../include/var-paths.asciidoc[]

include::../include/timezone-support.asciidoc[]

[float]
Expand Down

0 comments on commit 8876d65

Please sign in to comment.