https://github.com/bigcommerce/gruf-newrelic

New Relic tracing for gruf services
https://github.com/bigcommerce/gruf-newrelic

grpc gruf newrelic ruby

Last synced: 3 days ago
JSON representation

New Relic tracing for gruf services

• Host: GitHub
• URL: https://github.com/bigcommerce/gruf-newrelic
• Owner: bigcommerce
• License: mit
• Created: 2018-10-05T15:39:08.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2022-05-11T22:35:53.000Z (over 2 years ago)
• Last Synced: 2023-03-12T06:24:45.980Z (over 1 year ago)
• Topics: grpc, gruf, newrelic, ruby
• Language: Ruby
• Homepage:
• Size: 34.2 KB
• Stars: 7
• Watchers: 17
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# gruf-newrelic - New Relic support for gruf

[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-newrelic/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-newrelic/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf-newrelic.svg)](https://badge.fury.io/rb/gruf-newrelic) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-newrelic.svg?branch=main)](http://inch-ci.org/github/bigcommerce/gruf-newrelic)

Adds New Relic support for [gruf](https://github.com/bigcommerce/gruf) 2.0.0+.

## Installation

```ruby

gem 'gruf-newrelic'

```

In your gruf initializer:

```ruby

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`:

```ruby

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.