# mongo

![](../.gitbook/assets/mongo%20%283%29.png)

The `out_mongo` Output plugin writes records into [MongoDB](https://mongodb.org/), the emerging document-oriented database system.

If you're using `ReplicaSet`, please see the [`out_mongo_replset`](mongo_replset.md) article instead.

{% hint style='warning' %}
This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section.
If you can afford to improve this article, please send a pull request to https://github.com/fluent/fluentd-docs-gitbook
{% endhint %}

## Why Fluentd with MongoDB?

Fluentd enables your apps to insert records to MongoDB asynchronously with batch-insertion, unlike direct insertion of records from your apps. This has the following advantages:

1. less impact on application performance
2. higher MongoDB insertion throughput while maintaining JSON record structure

## Install

`out_mongo` is not included in `fluent-package`, by default. Fluentd gem users will need to install the `fluent-plugin-mongo` gem using the following command:

```text
$ sudo fluent-gem install fluent-plugin-mongo
```

For more details, see [Plugin Management](../deployment/plugin-management.md).

## Example Configuration

```text
# Single MongoDB
<match mongo.**>
  @type mongo
  host fluentd
  port 27017
  database fluentd
  collection test

  # for capped collection
  capped
  capped_size 1024m

  # authentication
  user michael
  password jordan

  <inject>
    # key name of timestamp
    time_key time
  </inject>

  <buffer>
    # flush
    flush_interval 10s
  </buffer>
</match>
```

Please see the [Store Apache Logs into MongoDB](../how-to-guides/apache-to-mongodb.md) article for real-world use cases.

Please see the [Configuration File](../configuration/config-file.md) article for the basic structure and syntax of the configuration file.

For `<buffer>`, refer to [Buffer Section Configuration](../configuration/buffer-section.md).

## Parameters

### `@type`

The value must be `mongo`.

### `connection_string` \(required\)

| type | default | version |
| :--- | :--- | :--- |
| string | `nil` | 1.0.0 |

The MongoDB connection string for URI.

### `host`

| type | default | version |
| :--- | :--- | :--- |
| string | 'localhost' | 1.0.0 |

The MongoDB hostname.

### `port` \(required\)

| type | default | version |
| :--- | :--- | :--- |
| integer | 27017 | 1.0.0 |

The MongoDB port.

### `database` \(required\)

| type | default | version |
| :--- | :--- | :--- |
| string | `nil` | 1.0.0 |

The database name.

### `collection` \(required, if not `tag_mapped`\)

| type | default | version |
| :--- | :--- | :--- |
| string | 'untagged' or required parameter if not `tag_mapped` | 1.0.0 |

The collection name.

### `capped`

| type | default | version |
| :--- | :--- | :--- |
| string | optional | 1.0.0 |

This option enables the capped collection. This is always recommended because MongoDB is not suited for storing large amounts of historical data.

#### `capped_size`

| type | default | version |
| :--- | :--- | :--- |
| size | optional | 1.0.0 |

Sets the capped collection size.

### `user`

| type | default | version |
| :--- | :--- | :--- |
| string | `nil` | 1.0.0 |

The username to use for authentication.

### `password`

| type | default | version |
| :--- | :--- | :--- |
| string | `nil` | 1.0.0 |

The password to use for authentication.

### `time_key`

| type | default | version |
| :--- | :--- | :--- |
| string | `time` | 1.0.0 |

The key name of timestamp.

### `tag_mapped`

| type | default | version |
| :--- | :--- | :--- |
| bool | `false` | 1.0.0 |

This option allows `out_mongo` to use Fluentd's tag to determine the destination collection.

For example, if you generate records with tags `mongo.foo`, the records will be inserted into the `foo` collection within the `fluentd` database:

```text
<match mongo.*>
  @type mongo
  host fluentd
  port 27017
  database fluentd

  # Set 'tag_mapped' if you want to use tag mapped mode.
  tag_mapped

  # If the tag is "mongo.foo", then the prefix "mongo." is removed.
  # The inserted collection name is "foo".
  remove_tag_prefix mongo.

  # This configuration is used if the tag is not found. The default is 'untagged'.
  collection misc
</match>
```

This option is useful for flexible log collection.

## Common Output / Buffer parameters

For common output / buffer parameters, please check the following articles:

* [Output Plugin Overview](./)
* [Buffer Section Configuration](../configuration/buffer-section.md)

## Further Reading

* [`fluent-plugin-mongo`](https://github.com/fluent/fluent-plugin-mongo)