Incompatible gems

Problem: The db-charmer gem has incompatibilities of how it patches Rails controllers.

Solution: Force New Relic to load and start before DbCharmer.enable_controller_magic! is called. For example, add the following to your config/application.rb:

require 'newrelic_rpm'
NewRelic::Agent.manual_start
DbCharmer.enable_controller_magic!

Problem: The escape_utils gem is incompatible with automatic instrumentation for New Relic's page load timing feature (sometimes referred to as real user monitoring or RUM). Due to the way escape_utils monkey-patches Rack, your whole HTML response may be escaped.

Solution: If you see HTML source instead of the rendered page, use either of these options:

• Remove the escape_utils gem.
• Use manual instrumentation for page load timing.

Problem: If the right_http_connection gem is loaded after newrelic_rpm, it patches the Net::HTTP class in a way that causes New Relic's Externals instrumentation to be missed.

Solution: Ensure that right_http_connection is required before newrelic_rpm.

Problem: The ar-octopus gem changes the way ActiveRecord's connection management works, breaking the Ruby agent's ability to gather instance information, apply vendor-specific obfuscation to queries, and capture explain plans for long-running database queries.

Solution: No known workaround. Either remove the ar-octopus gem, or continue to use it, in which case no explain plans will be captured.

Problem: The makara gem masks the Ruby agent's ability to detect the database adapter underlying ActiveRecord by modifying the name of the underlying connection. The original adapter name is needed to properly obfuscate queries. Some transaction traces display ActiveRecord content instead of MySQL content.

Solution: No known workaround. Either remove the makara gem, or continue to use it. Over-obfuscation will be the expected behavior.