PyMongo

Learn about the PyMongo integration and how it adds support for connections to MongoDB databases.

The PyMongo integration adds support for PyMongo, the official MongoDB driver.

Install sentry-sdk from PyPI with the pymongo extra:

Copied
pip install --upgrade 'sentry-sdk[pymongo]'

To configure the SDK, initialize it before creating any of PyMongo's MongoClient instances:

Copied
import sentry_sdk
from sentry_sdk.integrations.pymongo import PyMongoIntegration

sentry_sdk.init(
    dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
    enable_tracing=True,
    integrations=[
        PyMongoIntegration(),
    ],
)

In the future, we will make this auto-enabling, so you won't need to add the PyMongoIntegration to your sentry_sdk.init() call. Instead, the Sentry SDK will detect the presence of PyMongo and will set up the integration automatically.

Copied
import pymongo

def main():
    sentry_sdk.init(...)  # same as above
    client = pymongo.MongoClient(DATABASE_HOST, DATABASE_PORT)

    db = client["sentry_test_db"]
    collection = db["sentry_test"]

    with sentry_sdk.start_transaction(name="testing_sentry"):
        collection.insert_one({"test": "sentry"})
        collection.find_one({"test": "sentry"})

main()

This will create a transaction called testing_sentry in the Performance section of sentry.io, and create spans for the database operations.

It takes a couple of moments for the data to appear in sentry.io.

The following information about your MongoDB queries will be available to you on Sentry.io:

  • Performance traces for all MongoDB queries
  • Breadcrumbs for all MongoDB queries
  • Personal identifiable information (PII) will be stripped from all MongoDB queries if send_default_pii is disabled in the SDK. (This was tested for PyMongo 4.2 and below, but "should" also be future proof)

MongoDB query details are shown as a waterfall diagram

PyMongo is an official synchronous driver for MongoDB. It means that many other Python libraries interacting with MongoDB use it under the hood, like, for example mongoengine (always) or umongo (if selected from multiple available drivers). Official async MongoDB driver called Motor uses PyMongo under the hood as well. Queries generated by those libraries will also be monitored.

If you use a different driver (for example, TxMongo), this integration won't work.

While mongomock can be used to replace PyMongo in tests, it doesn't implement all features available in the official driver. This integration will not generate any breadcrumbs or spans from mongomock's clients.

  • PyMongo: 3.1+
  • Python: Python 3.6+

The versions above apply for Sentry Python SDK version 2.0+, which drops support for some legacy Python and framework versions. If you're looking to use Sentry with older Python or framework versions, consider using an SDK version from the 1.x major line of releases.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").