Docs Menu

Docs HomeMongoDB Cluster-to-Cluster Sync

Configuration

On this page

  • Configuration File
  • Options

You can configure mongosync instances at startup using a configuration file. The configuration file contains settings that are the equivalent of mongosync command-line options.

Most mongosync command-line options can be written to a YAML file. The configuration file specifies values for each setting using YAML format.

For example:

cluster0: "mongodb://192.0.2.10:27017"
cluster1: "mongodb://192.0.2.20:27017"
logPath: "/var/log/mongosync"
verbosity: "WARN"

To use a configuration file, start mongosync with the --config option to set the path to the file:

$ mongosync --config mongosync.conf

Note

The start command provides additional options for features like reversibility and user write blocking. For more details, see the start API documentation.

cluster0

Type: string

Sets the connection URI for the first cluster. The first cluster can serve as either the source or the destination in the sync process. Designate the source and destination clusters in the call to the start API endpoint.

For more information on connecting mongosync, see Connections.

To set the cluster0 setting from the command-line, see the --cluster0 option.

cluster1

Type: string

Sets the connection URI for the second cluster. The second cluster can serve as either the source or the destination in the sync process. Designate the source and destination clusters in the call to the start API endpoint.

For more information on connecting mongosync, see Connections.

To set the cluster1 setting from the command-line, see the --cluster1 option.

id

Type: string

Sets an identifier for the mongosync instance.

Use this setting when running multiple instances of mongosync on a sharded cluster, to synchronize the shards individually.

The identifier value for this setting must correspond to the shard ID of the shard it syncs. To find the shard ID, use the listShards command.

To set the id setting from the command-line, see the --id option.

logPath

Type: string

Sets the path to the log directory. Cluster-to-Cluster Sync writes logs to files in this directory.

For more information, see Logging.

To set the logPath setting from the command-line, see the --logPath option.

port

Type: integer

Default: 27182

Sets the port used by the HTTP server for the Cluster-to-Cluster Sync HTTP API.

To set the port setting from the command-line, see the --port option.

verbosity

Type: string

Default: INFO

Sets the verbosity level to use in log messages. Cluster-to-Cluster Sync logs all messages at the specified level and any messages at lower levels.

The verbosity setting supports the following values:

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • FATAL

  • PANIC

To set the verbosity setting from the command-line, see the --verbosity option.

←  mongosyncmongosync API Endpoints →
Share Feedback
© 2023 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2023 MongoDB, Inc.