Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 1.8 KB

README.md

File metadata and controls

58 lines (33 loc) · 1.8 KB
Raw

Zipkin

OpenTracing Tracer implementation for Zipkin in Ruby

Requirements

Zipkin version >= 2.0.0

Installation

Add this line to your application's Gemfile:

gem 'zipkin'

Usage

require 'zipkin/tracer'
OpenTracing.global_tracer = Zipkin::Tracer.build(url: 'http://localhost:9411', service_name: 'echo')

OpenTracing.start_active_span('span name') do
  # do something

  OpenTracing.start_active_span('inner span name') do
    # do something else
  end
end

See opentracing-ruby for more examples.

Samplers

Const sampler

Const sampler always makes the same decision for new traces depending on the initialization value. Set sampler to: Zipkin::Samplers::Const.new(true) to mark all new traces as sampled.

Probabilistic sampler

Probabilistic sampler samples traces with probability equal to rate (must be between 0.0 and 1.0). Set sampler to Zipkin::Samplers::Probabilistic.new(rate: 0.1) to mark 10% of new traces as sampled.

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/salemove/zipkin-ruby-opentracing

License

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