Icinga moduleedit
The icinga module parses the main, debug, and startup logs of
Icinga.
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
- Deploys dashboards for visualizing the log data
Read the quick start to learn how to configure and run modules.
Compatibilityedit
The icinga module was tested with Icinga >= 2.x on various Linux and Windows
systems.
This module is not available for macOS.
Configure the moduleedit
You can further refine the behavior of the icinga module by specifying
variable settings in the
modules.d/icinga.yml file, or overriding settings at the command line.
The following example shows how to set paths in the modules.d/icinga.yml
file to override the default paths for logs:
- module: icinga
main:
enabled: true
var.paths: ["/path/to/log/icinga2/icinga2.log*"]
debug:
enabled: true
var.paths: ["/path/to/log/icinga2/debug.log*"]
startup:
enabled: true
var.paths: ["/path/to/log/icinga2/startup.log"]
To specify the same settings at the command line, you use:
-M "icinga.main.var.paths=[/path/to/log/icinga2/icinga2.log*]" -M "icinga.debug.var.paths=[/path/to/log/icinga2/debug.log*]" -M "icinga.startup.var.paths=[/path/to/log/icinga2/startup.log]"
Variable settingsedit
Each fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the icinga module uses
the defaults.
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, icinga.main.var.paths
instead of main.var.paths.
main log fileset settingsedit
-
var.paths -
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.
debug log fileset settingsedit
-
var.paths -
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.
startup log fileset settingsedit
-
var.paths -
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.
Example dashboardedit
This module comes with sample dashboards. For example:
Fieldsedit
For a description of each field in the module, see the exported fields section.