Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Zipkin tracing plugin for Gruf
https://github.com/bigcommerce/gruf-zipkin

grpc gruf ruby zipkin

Last synced: 3 months ago
JSON representation

Zipkin tracing plugin for Gruf

Host: GitHub
URL: https://github.com/bigcommerce/gruf-zipkin
Owner: bigcommerce
License: mit
Created: 2017-05-04T17:08:16.000Z (almost 8 years ago)
Default Branch: main
Last Pushed: 2020-09-17T18:09:01.000Z (over 4 years ago)
Last Synced: 2024-10-31T14:48:02.991Z (3 months ago)
Topics: grpc, gruf, ruby, zipkin
Language: Ruby
Homepage:
Size: 38.1 KB
Stars: 5
Watchers: 17
Forks: 2
Open Issues: 1
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-zipkin - Zipkin tracing for gruf

[![Build Status](https://travis-ci.org/bigcommerce/gruf-zipkin.svg?branch=main)](https://travis-ci.org/bigcommerce/gruf-zipkin) [![Gem Version](https://badge.fury.io/rb/gruf-zipkin.svg)](https://badge.fury.io/rb/gruf-zipkin) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-zipkin.svg?branch=main)](http://inch-ci.org/github/bigcommerce/gruf-zipkin)

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

## Installation

```ruby
gem 'gruf-zipkin'
```

Then in an initializer or before use, after loading gruf:

```ruby
require 'zipkin-tracer'
require 'gruf/zipkin'

# Set it in the Rails config, or alternatively make this just a hash if not using Rails
Rails.application.config.zipkin_tracer = {
service_name: 'my-service',
service_port: 1234,
json_api_host: 'zipkin.mydomain.com',
sampled_as_boolean: false,
sample_rate: 0.1 # 0.0 to 1.0, where 1.0 => 100% of requests
}
Gruf.configure do |c|
c.interceptors.use(Gruf::Zipkin::Interceptor, Rails.application.config.zipkin_tracer)
end
```

This assumes you have Zipkin already setup in your Ruby/Rails app via the installation
instructions in the [zipkin-tracer](https://github.com/openzipkin/zipkin-ruby) gem.

### Rails/Rack Tracing

Add this to config.ru, if using above configuration:

```ruby
use ZipkinTracer::RackHandler, Rails.application.config.zipkin_tracer
```

## Configuration

You can further customize the tracing of gruf services via the configuration:

```ruby
Gruf.configure do |c|
c.interceptors.use(
Gruf::Zipkin::Interceptor,
span_prefix: 'myapp'
)
end
```

## License

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.