Skip to content

Latest commit

 

History

History
99 lines (59 loc) · 5.41 KB

README.md

File metadata and controls

99 lines (59 loc) · 5.41 KB
Raw

Praxis New Relic Support Dependency Status

New Relic instrumentation for Praxis, Praxis Blueprints, and Praxis Mapper.

example trace

Getting Started

Add the gem to your Gemfile:

gem 'newrelic-praxis'

Make sure you require the gem before calling Praxis::Application.instance.setup. For example, using a simple config.ru file like this one:

ENV['RACK_ENV'] ||= 'development'
Bundler.setup(:default, ENV['RACK_ENV'])
Bundler.require(:default, ENV['RACK_ENV'])

run Praxis::Application.instance.setup

What Is Instrumented

This gem provides separate instrumentation for Praxis, Praxis Blueprints, and Praxis Mapper. It uses the existing notifications provided by Praxis where available, and injects additional New Relic-specific instrumentation to Praxis Mapper.

Praxis

With this gem, you'll have three different traces with each request:

  • Praxis::Application#call -- your full Praxis app, starting from the run Praxis::Application.instance in your config.ru. This will include any Rack middleware you've specified in the application configuration, not any prior to that run.
  • Praxis::Router#call -- request handling inside Praxis. This includes all of the request stages (i.e. param/payload parsing, validation, the action, and etc.), with their before, after, and around filters.
  • ControllerClass#action_method -- traces just the action code in a Controller, without including any filters. This is done by subscribing to the 'praxis.request_stage.execute' event with ActiveSupport::Notifications.

Praxis::Blueprint

Reports rendering time for all Praxis::MediaType views (and any other Praxis::Blueprint subclasses) as :ClassName/:view_name Template in New Relic, along with any relevant nesting when rendering related objects.

This uses the 'praxis.blueprint.render notification.

Praxis::Mapper

Provides three different types of instrumentaiton for Praxis::Mapper:

  • :ModelClass/Load -- includes the full time and SQL statements associated with executing IdentityMap.load(ModelClass) query. This will include any subloads specified by load.
  • PraxisMapper/Finalize-- includes the full time and SQL statements associated with executing IdentityMap#finalize! to retrieve any records staged by queries using track.
  • PraxisMapper :ModelClass select -- Any SQL statements executed (using the Sequel query type) are instrumented as a Datastore in New Relic.

Additionally, any database interaction outside of Praxis::Mapper (i.e. ModelClass.all in Sequel), will use any other instrumentation supported by New Relic.

Configuration

It is likely that the default configuration suits most of your needs so you might not need to configure anything else than the license key.

However, if you need to tweak any settings, this gem can be configured following exactly the same methods of the underlying newrelic_rpm gem. This includes defining a config file (typically newrelic.yml) with all the original supported options or passing these equivalent settings through environment variables. See this for more details.

In addition to those standard options, there are three more that allow you to disable specific portions of the Praxis instrumentation:

  • disable_praxis_instrumentation -- disables the ControllerClass#action_method tracing. Praxis::Application#call and Praxis::Router#call are provided by New Relic as part of its Rack instrumentation.
  • disable_praxis_blueprints_instrumentation -- disables :ClassName/:view_name Template tracing for Praxis::Blueprint.
  • disable_praxis_mapper_instrumentation -- disables all tracing for Praxis::Mapper.

Note: Disabling Praxis::Mapper instrumentation has no effect any other database instrumentation that may be present (i.e., the Sequel support provided by New Relic). This can be either a feature if you wish to remove the database traces from this gem and use another set, or a bug if you wish to completely disable all query tracing. Consult the New Relic documentation in the latter case for how to disable other instrumentation that may be installed.

Mailing List

Join our Google Groups for discussion, support and announcements.

And follow us on twitter: @praxisapi

Contributions

Contributions to make this gem better are welcome. Please refer to CONTRIBUTING for further details on what contributions are accepted and how to go about contributing.

Requirements

Praxis requires Ruby 2.1.0 or greater.

License

This software is released under the MIT License. Please see LICENSE for further details.

Copyright (c) 2015 RightScale