﻿---
title: MongoDB module
description: 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...
url: https://www.elastic.co/elastic/docs-builder/docs/2348/reference/beats/filebeat/filebeat-module-mongodb
applies_to:
  - Elastic Stack: Generally available in 9.0+
---

# MongoDB module
<admonition title="Prefer to use Elastic Agent for this use case?">
  Refer to the [Elastic Integrations documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2348/reference/mongodb).
  <dropdown title="Learn more">
    Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed [comparison of Beats and Elastic Agent](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2348/reference/fleet).
  </dropdown>
</admonition>

The `mongodb` module collects and parses logs created by [MongoDB](https://www.mongodb.com/).
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

<tip>
  Read the [quick start](https://www.elastic.co/elastic/docs-builder/docs/2348/reference/beats/filebeat/filebeat-installation-configuration) to learn how to configure and run modules.
</tip>


## Compatibility

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

You can further refine the behavior of the `mongodb` module by specifying [variable settings](#mongodb-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:
```yaml
- module: mongodb
  log:
    enabled: true
    var.paths: ["/path/to/log/mongodb/*.log*"]
```

To specify the same settings at the command line, you use:
```sh
-M "mongodb.log.var.paths=[/path/to/log/mongodb/*.log*]"
```


### Variable settings

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](https://www.elastic.co/elastic/docs-builder/docs/2348/reference/beats/filebeat/advanced-settings).
<tip>
  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`.
</tip>


### `log` log fileset settings

<definitions>
  <definition term="var.paths">
    An array of glob-based paths that specify where to look for the log files. All patterns supported by [Go Glob](https://golang.org/pkg/path/filepath/#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.
  </definition>
</definitions>


## Example dashboard

This module comes with one sample dashboard including error and regular logs.
![filebeat mongodb overview](https://www.elastic.co/elastic/docs-builder/docs/2348/reference/beats/filebeat/images/filebeat-mongodb-overview.png)

## Fields

For a description of each field in the module, see the [exported fields](https://www.elastic.co/elastic/docs-builder/docs/2348/reference/beats/filebeat/exported-fields-mongodb) section.