Reference >
Build a Resilient Application with MongoDB

Build a Resilient Application with MongoDB¶

On this page

Install the Latest Drivers
Connection Strings
Retryable Writes and Reads
Write and Read Concern
Error Handling
Resilient Example Application

To write application code that takes advantage of the capabilities of MongoDB and gracefully handles replica set elections, you should:

Install the latest drivers.
Use a connection string that specifies all hosts.
Use retryable writes and retryable reads.
Use a majority write concern and a read concern that makes sense for your application.
Handle errors in your application.

Install the Latest Drivers¶

First, install the latest drivers for your language from MongoDB Drivers. Drivers connect and relay queries from your application to your database. Using the latest drivers enables the latest MongoDB features.

Then, in your application, import the dependency:

Java (Sync)
Node.js

If you are using Maven, add the following to your pom.xml dependencies list:

copy

<dependencies>
    <dependency>
        <groupId>org.mongodb</groupId>
        <artifactId>mongodb-driver-sync</artifactId>
        <version>4.0.1</version>
    </dependency>
</dependencies>

If you are using Gradle, add the following to your build.gradle dependencies list:

copy

dependencies {
  compile 'org.mongodb:mongodb-driver-sync:4.0.1'
}

copy

// Latest 'mongodb' version installed with npm
const MongoClient = require('mongodb').MongoClient;

Connection Strings¶

Use a connection string that specifies all the hosts in your deployment to connect your application to your database. If your deployment performs a replica set election and a new primary is elected, a connection string that specifies all hosts in your deployment discovers the new primary without application logic.

You can specify all the hosts in your deployment using either:

the Standard Connection String Format, or
the DNS Seedlist Connection Format.

The connection string can also specify options, notably retryWrites and writeConcern.

See also

For help formatting your connection string, see Connect to a Deployment Using a MongoDB Driver.

Use your connection string to instantiate a MongoDB client in your application:

Java (Sync)
Node.js

copy

// Create a variable for your connection string
String uri = "mongodb://[<username>:<password>@]hostname0<:port>[,hostname1:<port1>][,hostname2:<port2>][...][,hostnameN:<portN>]";

// Instantiate the MongoDB client with the URI
MongoClient client = MongoClients.create(uri);

copy

// Create a variable for your connection string
const uri = "mongodb://[<username>:<password>@]hostname0<:port>[,hostname1:<port1>][,hostname2:<port2>][...][,hostnameN:<portN>]";

// Instantiate the MongoDB client with the URI
const client = new MongoClient(uri, {
    useNewUrlParser: true,
    useUnifiedTopology: true
});

Retryable Writes and Reads¶

Note

Starting in MongoDB version 3.6 and with 4.2-compatible drivers, MongoDB retries both writes and reads once by default.

Retryable Writes¶

Use retryable writes to retry certain write operations a single time if they fail.

Retrying writes exactly once is the best strategy for handling transient network errors and replica set elections in which the application temporarily can’t find a healthy primary node. If the retry succeeds, the operation as a whole succeeds and no error is returned. If the operation fails, it is likely due to:

A lasting network error, or
An invalid command.

See also

For more information on enabling retryable writes, see Enabling Retryable Writes.

When an operation fails, your application needs to handle the error itself.

Retryable Reads¶

Read operations are automatically retried a single time if they fail starting in MongoDB version 3.6 and with 4.2-compatible drivers. You don’t need to configure your application to retry reads.

Write and Read Concern¶

You can tune the consistency and availability of your application using write concerns and read concerns. Stricter concerns imply that database operations wait for stronger data consistency guarantees, whereas loosening consistency requirements provides higher availability.

Example

If your application handles monetary balances, consistency is extremely important. You might use majority write and read concerns to ensure you never read from stale data or data that might be rolled back.

Alternatively, if your application records temperature data from hundreds of sensors every second, you may not be concerned if you read data that does not include the most recent readouts. You can loosen consistency requirements to provide faster access to that data.

Write Concern¶

You can set the write concern level of your replica set through the connection string URI. Use a majority write concern to ensure your data is successfully written to your database and persisted. This is the recommended default and sufficient for most use cases.

When you use a write concern that requires acknowledgement, such as majority, you may also specify a maximum time limit for writes to achieve that level of acknowledgement:

The wtimeoutMS connection string parameter for all writes, or
The wtimeout option for a single write operation.

Whether or not you use a time limit and the value you use depends on your application context.

See also

For more information on setting write concern levels, see Write Concern Options.

Important

If you do not specify a time limit for writes and the level of write concern is unachievable, the write operation will never complete.

Read Concern¶

You can set the read concern level of your replica set through the connection string URI. The ideal read concern depends on your application requirements, but the default is sufficient for most use cases. No connection string parameter is required to use default read concerns.

Specifying a read concern can improve guarantees around the data your application receives from your database.

See also

For more information on setting read concern levels, see Read Concern Options.

Note

The specific combination of write and read concern your application uses affects order-of-operation guarantees. This is called causal consistency. For more information on causal consistency guarantees, see Causal Consistency and Read and Write Concerns.

Error Handling¶

Invalid commands, network outages, and network errors that are not handled by retryable writes return errors. Refer to your driver’s API documentation for error details.

For example, if an application tries to insert a document with a duplicate _id, your driver returns an error that includes:

Java (Sync)
Node.js

copy

Unable to insert due to an error: com.mongodb.MongoWriteException:
E11000 duplicate key error collection: <db>.<collection> ...

{
    "name": : "MongoError",
    "message": "E11000 duplicate key error collection on: <db>.<collection> ... ",
    ...
}

Without proper error handling, an error might block your application from processing requests until it is restarted.

Your application should handle errors without crashing or side effects. In the previous example of an application inserting a duplicate _id, that application could handle errors as follows:

Java (Sync)
Node.js

copy

// Declare a logger instance from java.util.logging.Logger
private static final Logger LOGGER = ...
...
try {
    InsertOneResult result = collection.insertOne(new Document()
        .append("_id", 1)
        .append("body", "I'm a goofball trying to insert a duplicate _id"));

    // Everything is OK
    LOGGER.info("Inserted document id: " + result.getInsertedId());

// Refer to the API documentation for specific exceptions to catch
} catch (MongoException me) {
    // Report the error
    LOGGER.severe("Failed due to an error: " + me);
}

copy

...
collection.insertOne({
    _id: 1,
    body: "I'm a goofball trying to insert a duplicate _id"
})
.then(result => {
    response.sendStatus(200) // send "OK" message to the client
},
err => {
    response.sendStatus(400); // send "Bad Request" message to the client
});

The insert operation in this example throws a “duplicate key” error the second time it’s invoked because the _id field must be unique. The application catches the error, the client is notified, and the app continues to run. The insert operation fails, however, and it is up to you to decide whether to show the user a message, retry the operation, or do something else.

You should always log errors. Common strategies for further processing errors include:

Return the error to the client with an error message. This is a good strategy when you cannot resolve the error and need to inform a user that an action can’t be completed.
Write to a backup database. This is a good strategy when you can’t resolve the error but don’t want to risk losing the request data.
Retry the operation beyond the single default retry. This is a good strategy when you can solve the cause of an error programmatically, then retry it.

You must select the best strategies for your application context.

Example

In the example of a duplicate key error, you should log the error but not retry the operation because it will never succeed. Instead, you could write to a fallback database and review the contents of that database at a later time to ensure that no information is lost. The user doesn’t need to do anything else and the data is recorded, so you can choose not to send an error message to the client.

Planning for Network Errors¶

Returning an error can be desirable behavior when an operation would otherwise never complete and block your application from executing new operations. You can use the maxTimeMS method to place a time limit on individual operations, returning an error for your application to handle if that time limit is exceeded.

The time limit you place on each operation depends on the context of that operation.

Example

If your application reads and displays simple product information from an inventory collection, you can be reasonably confident that those read operations only take a moment. An unusually long-running query is a good indicator that there is a lasting network problem. Setting maxTimeMS on that operation to 5000, or 5 seconds, means that your application receives feedback as soon as you are confident there is a network problem.

Resilient Example Application¶

The following example application brings together the recommendations for building resilient applications.

The application is a simple user records API that exposes two endpoints on http://localhost:3000:

Method	Endpoint	Description
`GET`	`/users`	Gets a list of user names from a `users` collection.
`POST`	`/users`	Requires a `name` in the request body. Adds a new user to a `users` collection.

Java (Sync)
Node.js

Note

The following server application uses NanoHTTPD and json which you need to add to your project as dependencies before you can run it.

copy

// File: App.java

import java.util.Map;
import java.util.logging.Logger;

import org.bson.Document;
import org.json.JSONArray;

import com.mongodb.MongoException;
import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoClients;
import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoDatabase;

import fi.iki.elonen.NanoHTTPD;

public class App extends NanoHTTPD {
    private static final Logger LOGGER = Logger.getLogger(App.class.getName());

    static int port = 3000;
    static MongoClient client = null;

    public App() throws Exception {
        super(port);

        // Replace the uri string with your MongoDB deployment's connection string
        String uri = "mongodb://<username>:<password>@hostname0:27017,hostname1:27017,hostname2:27017/?retryWrites=true&w=majority";
        client = MongoClients.create(uri);

        start(NanoHTTPD.SOCKET_READ_TIMEOUT, false);
        LOGGER.info("\nStarted the server: http://localhost:" + port + "/ \n");
    }

    public static void main(String[] args) {
        try {
            new App();
        } catch (Exception e) {
            LOGGER.severe("Couldn't start server:\n" + e);
        }
    }

    @Override
    public Response serve(IHTTPSession session) {
        StringBuilder msg = new StringBuilder();
        Map<String, String> params = session.getParms();

        Method reqMethod = session.getMethod();
        String uri = session.getUri();

        if (Method.GET == reqMethod) {
            if (uri.equals("/")) {
                msg.append("Welcome to my API!");
            } else if (uri.equals("/users")) {
                msg.append(listUsers(client));
            } else {
                msg.append("Unrecognized URI: ").append(uri);
            }
        } else if (Method.POST == reqMethod) {
            try {
                String name = params.get("name");
                if (name == null) {
                    throw new Exception("Unable to process POST request: 'name' parameter required");
                } else {
                    insertUser(client, name);
                    msg.append("User successfully added!");
                }
            } catch (Exception e) {
                msg.append(e);
            }
        }

        return newFixedLengthResponse(msg.toString());
    }

    static String listUsers(MongoClient client) {
        MongoDatabase database = client.getDatabase("test");
        MongoCollection<Document> collection = database.getCollection("users");

        final JSONArray jsonResults = new JSONArray();
        collection.find().forEach((result) -> jsonResults.put(result.toJson()));

        return jsonResults.toString();
    }

    static String insertUser(MongoClient client, String name) throws MongoException {
        MongoDatabase database = client.getDatabase("test");
        MongoCollection<Document> collection = database.getCollection("users");

        collection.insertOne(new Document().append("name", name));
        return "Successfully inserted user: " + name;
    }
}

Note

The following server application uses Express, which you need to add to your project as a dependency before you can run it.

copy

const express = require('express');
const bodyParser = require('body-parser');

// Use the latest drivers by installing & importing them
const MongoClient = require('mongodb').MongoClient;

const app = express();
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));

// Use a connection string that lists all hosts
// with retryable writes & majority write concern
const uri = "mongodb://<username>:<password>@hostname0:27017,hostname1:27017,hostname2:27017/?retryWrites=true&w=majority";

const client = new MongoClient(uri, {
    useNewUrlParser: true,
    useUnifiedTopology: true
});

// ----- API routes ----- //
app.get('/', (req, res) => res.send('Welcome to my API!'));

app.get('/users', (req, res) => {
    const collection = client.db("test").collection("users");

    collection
    .find({})
    // In this example, 'maxTimeMS' throws an error after 5 seconds,
    // alerting the application to a lasting network outage
    .maxTimeMS(5000)
    .toArray((err, data) => {
        if (err) {
            // Handle errors in your application
            // In this example, by sending the client a message
            res.send("The request has timed out. Please check your connection and try again.");
        }
        return res.json(data);
    });
});

app.post('/users', (req, res) => {
    const collection = client.db("test").collection("users");
    collection.insertOne({ name: req.body.name })
    .then(result => {
        res.send("User successfully added!");
    }, err => {
        // Handle errors in your application
        // In this example, by sending the client a message
        res.send("An application error has occurred. Please try again.");
    })
});
// ----- End of API routes ----- //

app.listen(3000, () => {
    console.log(`Listening on port 3000.`);
    client.connect(err => {
        if (err) {
            console.log("Not connected: ", err);
            process.exit(0);
        }
        console.log('Connected.');
    });
});

← SNMP Traps and Ops Manager Severities Release Notes →