bc-lightstep-ruby - LightStep distributed tracing

Adds LightStep tracing support for Ruby. This is an extension of the LightStep ruby gem and adds extra functionality and resiliency.

Installation

gem 'bc-lightstep-ruby'

Then in an initializer or before use:

require 'bigcommerce/lightstep'
Bigcommerce::Lightstep.configure do |c|
  c.component_name = 'myapp'
  c.access_token = 'abcdefg'
  c.host = 'my.lightstep.service.io'
  c.port = 8080
  c.verbosity = 1
end

Then in your script:

tracer = Bigcommerce::Lightstep::Tracer.instance
tracer.start_span('my-span', context: request.headers) do |span|
  span.set_tag('my-tag', 'value')
  # do thing to measure
end

Environment Config

bc-lightstep-ruby can be automatically configured from these ENV vars, if you'd rather use that instead:

Name	Description
LIGHTSTEP_ENABLED	Flag to determine whether to broadcast spans. Defaults to (1) enabled, 0 will disable.
LIGHTSTEP_COMPONENT_NAME	The component name to use
LIGHTSTEP_ACCESS_TOKEN	The access token to use to connect to the collector. Optional.
LIGHTSTEP_HOST	Host of the collector.
LIGHTSTEP_PORT	Port of the collector.
LIGHTSTEP_SSL_VERIFY_PEER	If using 443 as the port, toggle SSL verification.
LIGHTSTEP_MAX_BUFFERED_SPANS	The maximum number of spans to buffer before dropping.
LIGHTSTEP_MAX_LOG_RECORDS	Maximum number of log records on a span to accept.
LIGHTSTEP_MAX_REPORTING_INTERVAL_SECONDS	The maximum number of seconds to wait before flushing the report to the collector.
LIGHTSTEP_VERBOSITY	The verbosity level of lightstep logs.

Most systems will only need to customize the component name.

Instrumenting Rails Controllers

Just drop this include into ApplicationController:

include Bigcommerce::Lightstep::RailsControllerInstrumentation

Faraday Middleware

To use the supplied faraday middleware, simply:

Faraday.new do |faraday|
  faraday.use Bigcommerce::Lightstep::Middleware::Faraday, 'name-of-external-service'
end

Spans will be built with the external service name. It's generally not a good idea to use the Faraday adapter with internal services that are also instrumented with LightStep - use the Faraday adapter on external services or systems outside of your instrumenting control.

Redis

This gem will automatically detect and instrumnent Redis calls when they are made using the Redis::Client class. It will set as tags on the span the host, port, db instance, and the command (but no arguments).

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.