PyMongo

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

Install

Install sentry-sdk from PyPI with the pymongo extra:

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

Configure

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",
    integrations=[
        PyMongoIntegration(),
    ],

    # Set traces_sample_rate to 1.0 to capture 100%
    # of transactions for performance monitoring.
    # We recommend adjusting this value in production,
    traces_sample_rate=1.0,
)

Behavior

The following information about your MonogDB 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

Other MongoDB libraries

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.

Mongomock

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.

Supported Versions

  • PyMongo: 3.1+, 4.0, 4.1, 4.2
  • Python: 2.7 (PyMongo 3.1+), Python 3.6+ (PyMongo 4.0), Python 3.7+ (PyMongo 4.1+)
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").