IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« MISP module MSSQL module »
Elastic Docs ›Filebeat Reference [7.16] ›Modules

MongoDB module

edit

MongoDB module

edit

Prefer to use Elastic Agent for this use case?

Refer to the Elastic Integrations documentation.

Learn more

Elastic Agent is a single, unified agent that you can deploy to hosts or containers to collect data and send it to the Elastic Stack. Elastic Agent uses integrations to connect your data to the Elastic Stack. Behind the scenes, Elastic Agent runs the Beats shippers required for your configuration. Refer to the documentation for a detailed comparison of Beats and Elastic Agent.

The 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

edit

The 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

edit

You 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.

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

edit

Each 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

edit

This module comes with one sample dashboard including error and regular logs.

filebeat mongodb overview

Fields

edit

For a description of each field in the module, see the exported fields section.

« MISP module MSSQL module »