MongoDB module
editMongoDB module
editThe mongodb
module collects and parses logs created by
MongoDB.
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.
Compatibility
editThe mongodb
module was tested with plaintext logs from version v3.2.11 on Debian and json logs from version v4.4.4 on Ubuntu.
Configure the module
editYou can further refine the behavior of the mongodb
module by specifying
variable settings in the
modules.d/mongodb.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 modules.d/mongodb.yml
file to override the default paths for MongoDB logs:
- module: mongodb log: enabled: true var.paths: ["/path/to/log/mongodb/*.log*"]
To specify the same settings at the command line, you use:
-M "mongodb.log.var.paths=[/path/to/log/mongodb/*.log*]"
Variable settings
editEach fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the mongodb
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, mongodb.log.var.paths
instead of log.var.paths
.
log
log fileset settings
edit-
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.log
files from the subfolders of/path/to/log
. It does not fetch log files from the/path/to/log
folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system.
Example dashboard
editThis module comes with one sample dashboard including error and regular logs.
Fields
editFor a description of each field in the module, see the exported fields section.