No commit activity in last 3 years
No release in over 3 years
OpenTracing Tracer implementation for Tests in Ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.15
~> 10.0
~> 3.0
~> 0.54.0
~> 1.24.0

Runtime

 Project Readme

OpenTracingTestTracer

OpenTracing compatible in-memory Tracer implementation. It exposes information about the recorded spans which are useful for testing.

Installation

Add this line to your application's Gemfile:

gem 'opentracing_test_tracer'

Usage

require 'opentracing_test_tracer'
OpenTracing.global_tracer = OpenTracingTestTracer.build

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.

In addition to OpenTracing compatible methods this tracer provides following methods:

OpenTracingTestTracer

  1. #spans returns all spans, including those in progress.

OpenTracingTestTracer::Span

  1. finished? informs whether the span is finished.
  2. start_time returns when the span was started.
  3. end_time returns when the span was finished, or nil if still in progress.
  4. tags returns the span tags.
  5. logs returns the span logs.

OpenTracingTestTracer::SpanContext

  1. trace_id returns the trace ID.
  2. span_id returns the current span ID.
  3. parent_id returns the parent span ID.

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/test-ruby-opentracing

Credits

This gem is heavily inspired by @iaintshine test-tracer.

opentracing_test_tracer is maintained and funded by SaleMove, Inc.