mssql module parses error logs created by MSSQL.
When you run the module, it performs a few tasks under the hood:
- Sets the default paths to the log files (but don’t worry, you can override the defaults)
- Makes sure each multiline log event gets sent as a single event
- Uses an Elasticsearch ingest pipeline to parse and process the log lines, shaping the data into a structure suitable for visualizing in Kibana
Read the quick start to learn how to configure and run modules.
Configure the moduleedit
You can further refine the behavior of the
mssql module by specifying
variable settings in the
modules.d/mssql.yml file, or overriding settings at the command line.
You must enable at least one fileset in the module. Filesets are disabled by default.
The following example shows how to set paths in the
file to override the default paths for MSSQL logs:
- module: mssql log: enabled: true var.paths: ['C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*']
To specify the same settings at the command line, you use:
-M "mssql.log.var.paths=['C:\Program Files\Microsoft SQL Server\MSSQL.150\MSSQL\LOG\ERRORLOG*']"
Each fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the
mssql module uses
For advanced use cases, you can also override input settings. See Override input settings.
When you specify a setting at the command line, remember to prefix the
setting with the module name, for example,
log fileset settingsedit
An array of glob-based paths that specify where to look for the log files. All
patterns supported by Go Glob
are also supported here. For example, you can use wildcards to fetch all files
from a predefined level of subdirectories:
/path/to/log/*/*.log. This fetches all
.logfiles from the subfolders of
/path/to/log. It does not fetch log files from the
/path/to/logfolder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system.
Time zone supportedit
This module parses logs that don’t contain time zone information. For these logs,
Filebeat reads the local time zone and uses it when parsing to convert the
timestamp to UTC. The time zone to be used for parsing is included in the event
To disable this conversion, the
event.timezone field can be removed with
If logs are originated from systems or applications with a different time zone to
the local one, the
event.timezone field can be overwritten with the original
time zone using the
See Processors for information about specifying processors in your config.
For a description of each field in the module, see the exported fields section.