Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs of MSSQL filebeat module referencing Traefik plus change paths from Linux to MS Windows #23360

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions filebeat/docs/modules/mssql.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@ include::../include/gs-link.asciidoc[]
include::../include/configuring-intro.asciidoc[]

The following example shows how to set paths in the +modules.d/{modulename}.yml+
file to override the default paths for Træfik logs:
file to override the default paths for MSSQL logs:

["source","yaml",subs="attributes"]
-----
- module: mssql
log:
enabled: true
var.paths: ["/var/opt/mssql/log/error*"]
var.paths: ["C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backslashes in YAML need to be escaped or single-quoted:

Suggested change
var.paths: ["C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*"]
var.paths: ['C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*']

-----


To specify the same settings at the command line, you use:

["source","sh",subs="attributes"]
-----
-M "mssql.log.var.paths=[/var/opt/mssql/log/error*]"
-M "mssql.log.var.paths=[C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*]"
-----

//set the fileset name used in the included example
Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/filebeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1410,7 +1410,7 @@ filebeat.modules:

# Set custom paths for the log files. If left empty,
# Filebeat will choose the paths depending on your OS.
#var.paths:
#var.paths: ["C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*"]

#-------------------------------- MySQL Module --------------------------------
#- module: mysql
Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/module/mssql/_meta/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

# Set custom paths for the log files. If left empty,
# Filebeat will choose the paths depending on your OS.
#var.paths:
#var.paths: ["C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*"]
6 changes: 3 additions & 3 deletions x-pack/filebeat/module/mssql/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,22 @@ include::../include/gs-link.asciidoc[]
include::../include/configuring-intro.asciidoc[]

The following example shows how to set paths in the +modules.d/{modulename}.yml+
file to override the default paths for Træfik logs:
file to override the default paths for MSSQL logs:

["source","yaml",subs="attributes"]
-----
- module: mssql
log:
enabled: true
var.paths: ["/var/opt/mssql/log/error*"]
var.paths: ["C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*"]
-----


To specify the same settings at the command line, you use:

["source","sh",subs="attributes"]
-----
-M "mssql.log.var.paths=[/var/opt/mssql/log/error*]"
-M "mssql.log.var.paths=[C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*]"
-----

//set the fileset name used in the included example
Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/modules.d/mssql.yml.disabled
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@

# Set custom paths for the log files. If left empty,
# Filebeat will choose the paths depending on your OS.
#var.paths:
#var.paths: ["C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*"]