Mongo instrumentation

The Ruby agent has built-in instrumentation for MongoDB queries made via the mongo gem.

Supported gems

This summarizes the Ruby agent's support for gems by version.

Gem version Comments
mongo 1.8 and 1.9 Supported by New Relic's Ruby agent 3.7.1 or higher
mongo 2.0 Not supported
mongo 2.1 or higher Requires New Relic's Ruby agent 3.13.1 or higher
Other gems Support for Mongoid 2/3/4 and Moped currently is available only via third-party gems. For links to the relevant projects, see the plugin list on rpm_contrib.

Third-party and rpm_contrib instrumentation

The rpm_contrib and newrelic_mongo gems both provided basic instrumentation for mongo. New Relic does not recommend running Mongo instrumentation via these gems alongside the Ruby agent's built-in Mongo support. This might double-count metrics such as overall database time.

Also, the rpm_contrib and newrelic_mongo gems both use a distinct setting that can be used to disable them if removing those gems entirely isn't possible in your environment. For those third party gems, set disable_mongodb: false in your newrelic.yml.

Disabling instrumentation

To disable Mongo instrumentation in the agent, add the following to your newrelic.yml:

disable_mongo: true

For more help

Additional documentation resources include:

  • New Relic for Ruby (compatibility and requirements, general information about installation, configuration, troubleshooting, and known issues)
  • Ruby agent installation (using the New Relic Ruby gem and configuration file)

If you need more help, check out these support and learning resources: