The project is in a healthy, maintained state
An interceptor for using OpenCensus with gRPC.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Project Readme

GrpcOpencensusInterceptor

An interceptor for using OpenCensus with gRPC.

Installation

Add this line to your application's Gemfile:

gem 'grpc_opencensus_interceptor'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grpc_opencensus_interceptor

Usage

Server

Please set a GrpcOpencensusInterceptor as an interceptor of your gRPC application.

require 'grpc'
require 'grpc_opencensus_interceptor'

server = GRPC::RpcServer.new(
  interceptors: [
    GrpcOpencensusInterceptor::ServerInterceptor.new,
  ]
)
server.handle(MyHandler.new)
server.run_till_terminated_or_interrupted(['SIGINT'])

Client

require 'grpc'
require 'grpc_opencensus_interceptor'
url = "dns:test-service:80"
stub = TestService::Stub.new(url, :this_channel_is_insecure, interceptors: [
  GrpcOpencensusInterceptor::ClientInterceptor.new,
])
stub.hello_rpc

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/wantedly/grpc_opencensus_interceptor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the GrpcOpencensusInterceptor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.