Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.45 KB

README.md

File metadata and controls

54 lines (40 loc) · 2.45 KB
Raw

gruf-newrelic - New Relic support for gruf

CircleCI Gem Version Inline docs

Adds New Relic support for gruf 2.0.0+.

Installation

gem 'gruf-newrelic'

In your gruf initializer:

Gruf.configure do |c|
  c.interceptors.use(Gruf::Newrelic::ServerInterceptor)
end

This will add New Relic tracing support to all gruf controllers.

Distributed Tracing

When controller receives gRPC request, it will automatically apply NewRelic distributed tracing information to current request if it is present in newrelic header. Make sure request has newrelic header with tracing payload (see below) and that your account and application settings have distributed tracing enabled

If you are using ::Gruf::Client to make gRPC request, you need to explicitly add NewRelic Client Interceptor in client_options:

client = ::Gruf::Client.new(
  service: ::Demo::ThingService, 
  client_options: {
    interceptors: [::Gruf::Newrelic::ClientInterceptor.new]
  }
)

License

Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.