zipkin-tracer 0.36.1 → 0.36.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9731d7b33a04a21d40dbb5e887bc9f54d3052822b9a940b4c67abd9d263802ee
-  data.tar.gz: 914938b89e93da3977a7df4eea19d5ec5e4c626410776c2fb69c25ec853a9c0c
+  metadata.gz: 795d59f52ecde287fa4afd8e391285c4bfcd5e60bc8eef827b31c53b14525b4f
+  data.tar.gz: f21cb46bf09dda5b55e660d7c47a2a70e281a3b21089e033b1ad9828e8802ec8
 SHA512:
-  metadata.gz: de1f610c691567ed0f31bfe1d71625082c0b8a73b2fd78294770b566d24d39b49af45fab24b440947a3ae9f869ae6d25f97165c790f3a7170b414d4c94f5d820
-  data.tar.gz: 74f20c4a09682e3049194e3d1d897f2977d6a00b08f2ffc98707c8d9e1dff76918892ea9726a0fe938670aa642ea01b7f03073ac9fe2efa0b78148ddbcc4c1ba
+  metadata.gz: b63fc26c0ac9cd3c64cd1fcbe3079657ae9fea506213aeed3885cb4a334908aaa18b61086699282c629afb712923e56a4b3ee45e06d3dd4051011b62d528d37b
+  data.tar.gz: 7b6c764aeee41e2b124c5494a180f31decd6f4f302195f9a3a8f273aff5775cd3fd76a474e97484bc081e54fd522953fbbe7333eb04db3df33f2f5c0fa558592

data/.gitignore

@@ -0,0 +1,31 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# do not include Gemfile.lock in gem source
+Gemfile.lock
+
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+jdk:
+  - oraclejdk8
+rvm:
+  - 2.6.2
+  - 2.5.5
+  - 2.4.5
+  - 2.3.8
+  - jruby-9.1.17.0
+  - jruby-9.2.6.0
+deploy:
+  provider: rubygems
+  api_key:
+    secure: HJquPWOoh9YKHTJrGTBriao4wVDu/tn+JwZphPrS38PNu5FkzyRuhjq2XyBrm8BkuJWdqkVx9rpJTlFkcjIfhpZOJUn5gtTUgp12/voUMWBCWw9AUfbYdYkGhy6Lmq6miJcUFkhdeiMmnliz0Wav1ZYEWkodC25ACKQiGtk9rwr+4wKkluljOnmbyPFRiF61ZjSaz4qy9ZpwWOSPGuEjCQuvhW1hx0VNBjsio59sKUK0v2lFHxSfMjW+QrB5GAV0isv4CtG5V9MKMlRBX8+4RbklO0LHdCmykTDTioyYrfBI0x7RiO/l453/EH4dQEzivZ9AQNtIIshPu1Zht63LHWff4JyytSGxe5WmXaQjxfrZi2LMIXbeg5g2pPDmiMqFVSCgxFKJQW1eyU9pF3w5C4v9P0uLeizGnLReOwwjBDqiWIQ2bR4YWn+fsg/wbhjXHmefEjcJYL59niK8pw1JOcg7fy/P32wbbqILUcIg3of1ih1lyPV4YBY62KJny6e0c83zX2KukVMP9M6crW2NEspMqcQWFzbp3SR9oM0ziMDGUs0s1/PKVtuFTZ2S+ykbawX5P9YqSSx8iXp+Ez5MAMbrjiPXlzpzMvudDaN3kqRT2EomJ4iQjJOxXgUyTspLpZFojh4+RVjgi+sGEA8SeNiqrytThsCwQV1ro8ymL+8=
+  gem: zipkin-tracer
+  on:
+    tags: true
+    repo: openzipkin/zipkin-ruby
+    condition: "$TRAVIS_RUBY_VERSION == 2.6.2"
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/637e968b45032d16ee26
+    on_success: change
+    on_failure: always
+    on_start: false
+script: "bundle exec rspec"

data/CHANGELOG.md

@@ -0,0 +1,241 @@
+# 0.36.2
+* Cleanup the gemspec. No code changes.
+
+# 0.36.1
+* Bugfix: Prevent uninitialized constant AsyncHttpApiClient::ZipkinHttpSender error
+
+# 0.36.0
+* Add ZipkinSqsSender to send spans via Amazon SQS
+* Rename ZipkinJsonTracer to ZipkinHttpSender and rename others to replace the term "tracer" with "sender"
+
+# 0.35.1
+* Fix bug with Rails 5.1 when calling recognize_path with a nil path
+
+# 0.35.0
+* removes record_on_server_receive option
+* records status_code and method on all server receive events.
+
+# 0.34.0
+* Whitelist plugin ensure a request is traced even if it is not routable
+* Gem requires Ruby > 2.3.0. In practice this was true already.
+
+# 0.33.0
+* Switch to Zipkin v2 span format
+
+# 0.32.4
+* Remove the ':service_port' configuration.
+* Fix 'sa' annotation encoding.
+
+# 0.32.3
+* Fix bug using trace generator.
+
+# 0.32.2
+* Recover the old Trace.id logic but based not the new API. Again, for compatibility.
+
+# 0.32.1
+* Delete added parameter to trace.next_id
+
+# 0.32.0
+* Restore Trace.id for now as software needs to migrate out of it.
+
+# 0.31.0
+* Remove dependency from finagle-thrift
+* Use http.url instead of http.uri
+
+# 0.30.0
+* Add 'http.method' to client annotations
+
+# 0.29.1
+* Patch abstract route to work with Grape
+
+# 0.29.0
+* Add abstract route to span name
+* Fix not to raise "NoMethodError" for Rails:Module
+
+# 0.28.0
+* Add the `:trace_id_128bit` configuration option.
+
+# 0.27.2.1
+* Update version.rb to fix checksum mismatch on RubyGems.org
+* Add `condition` on Travis CI deployment
+
+# 0.27.2
+* Convert trace values to string
+
+# 0.27.1
+* Rescue connection errors when sending information to Zipkin fails
+
+# 0.27.0
+* Add tagging of errors for Faraday and Excon.
+
+# 0.26.0
+* Add sidekiq worker tracing.
+
+# 0.25.0
+* Fix pass kafka producer to rack middleware
+
+# 0.24.0
+* Fix Pass and use the span in annotate_plugin
+
+# 0.23.0
+* Fix Excon middleware span duration
+* Add `start_span` and `end_span` to the Null tracer
+
+# 0.22.0
+* Add the `:record_on_server_receive` configuration option.
+
+# 0.21.2
+* Bugfix: Guard against tracer not set in Faraday and Excon middlewares
+
+# 0.21.1
+* Bugfix: better guard against nil response in the Excon middleware
+
+# 0.21.0
+* Added an Excon middleware
+
+# 0.20.1
+* Bugfix: Properly handle the `sampled_as_boolean` configuration option
+
+# 0.20.0
+* Bugfix: The Faraday middleware does not leave in the container any generated Id
+* Added TraceContainer and TraceGenerator to provide easier abstractions to interact with this library
+
+# 0.19.1
+* Limits the required headers to x_b3_trace_id and x_b3_span_id as per spec.
+
+# 0.19.0
+* Propagates the X-B3-Sampled in the same form it receives it (boolean or 1/0)
+* Adds a configuration option to allow a service to emit boolean or numbers for the X-B3-Sampled header
+
+# 0.18.6
+* Passes HTTP Method to recognize_path
+
+# 0.18.5
+* `NullTracer` has a noop `flush!` method.
+* Spans from `local_component_span` will be named according to `local_component_value` over `lc`.
+
+# 0.18.4
+* Uses http.path to annotate paths instead of http.uri.
+
+# 0.18.3
+* Ensures ip addresses for all hostnames are resolved, solves issue with docker hostnames
+
+# 0.18.2
+* Remove nil parentId from zipkin span payload.
+
+# 0.18.1
+* Turn the ZipkinTracer::FaradayHandler::B3_HEADERS constant into a private method
+
+# 0.18.0
+* Adds the :log_tracing option to explicitly use the logger tracer.
+* Logger classes can not be passed via the configuration file (never worked correctly).
+* Logger tracer logs in JSON format for easy analysis by other tools.
+
+# 0.17.0
+Adds a :producer configuration key as an alternative to Hermann as Kafka client.
+
+# 0.16.0
+* Remove the scribe tracer.
+* Use sucker_punch 2.x. The main feature is the dependency on concurrent-ruby instead of celluloid.
+
+# 0.15.1
+* Less strict dependency on Rack. Allows to use Rails 5.
+
+# 0.15.0
+* Hostname resolution done asyncronously for the JSON tracer
+
+# 0.14.1
+* Access to the tracer when we need it and not before.
+
+# 0.14.0
+* Adds a logger kind of tracer.
+
+# 0.13.2
+* Move record methods in TraceClient to Span
+* Relocate definition of constant variables
+
+# 0.13.1
+* Check the config entry is not blank when infering adapters
+
+# 0.13.0
+* Remove support for buffering. It was broken anyways.
+
+# 0.12.2
+* Make local tracing method (ZipkinTracer::TraceClient.local_component_span) returns the result of block
+
+# 0.12.1
+* Allow nesting of local tracing spans
+
+# 0.12.0
+* Add local tracing, fix flushing, add timestamp and duration to span
+
+# 0.11.0
+* Use local spans instead of thread-safe variables to improve performance
+* Add new `with_new_span` method to the tracer api to allow creating custom spans
+
+# 0.10.3
+* Avoid requiring finagle-thrift when possible to avoid a hard dependency on Thrift
+
+# 0.10.2
+* Add faraday as a dependency
+
+# 0.10.1
+* Performance optimization: Do not create tracing related objects in the Faraday middleware if we
+are not sampling.
+* Fix benchmark Rake task so it uses the proper Faraday middlewares
+
+# 0.10.0
+* Always create trace IDs even when the trace  will not be sent to zipkin (other parts of the app may use them).
+* Bugfix: Tracer is now Threadsafe
+* Development improvement: Benchmark Rake task to help finding performance issues
+
+# 0.9.1
+* Make Scribe actually optional by inspecting the conf first and requiring after.
+
+# 0.9.0
+* Add a JSON tracer (ZipkinJsonTracer).
+
+# 0.8.1
+* Set caller service name using domain environment variable. If the value
+is not set, it will fall back to the configuration file default.
+
+# 0.8.0
+* To proper follow the correct spec, now the annotations cr/cs set the local service as servicename
+* Added a 'sa' annotation to indicate the remote service servicename
+
+# 0.7.3
+* Send method name (get, post, etc) as lowercase (zipkin > 1.22 expect them lowercase)
+
+# 0.7.2
+* Rescue possible errors when lookup of the hostname fails
+
+# 0.7.1
+* Remove Scribe from direct dependencies list
+
+# 0.7
+* The ruby client does not wait to receive ACK from the collector. Just send traces
+* Connecting to the collector now happens in a different thread
+* The server annotations will not add information about the URL hit if hit by a zipkin enabled client
+
+# 0.6.3
+* Properly pop the Id from the traces stacks when finishing the Faraday tracer
+
+# 0.6.2
+* Do not trace requests if the current application will not serve them.
+
+# 0.6.1
+* Relax constraint on Rack from ~> 1.6 to ~> 1.3
+
+# 0.6
+* New configuration option :logger to setup a logger for error messages
+* The Zipkin Rack middleware will not raise an error if sending information to Zipkin raises an error
+
+# 0.5.1
+* The Zipkin Rack middleware will not raise an error if sending information to Zipkin raises an error
+* Integration specs to make sure information is properly passed when using Rack middleware together with Faraday's
+
+# 0.5.0
+* Added Faraday middleware to the repo
+
+# 0.4.0
+* Use Thread safe Finagle version to store the traces

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zipkin-tracer.gemspec
+gemspec
+
+platform :ruby do
+  gem 'benchmark-ips'
+  gem 'rbtrace'
+  gem 'byebug'
+  gem 'simplecov', require: false
+end
+
+platform :jruby do
+  gem 'hermann', '~> 0.27.0'
+end
+

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2011 Twitter Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE.md

@@ -0,0 +1,3 @@
+This repository was originally developed by Twitter and released under Apache license.
+
+Further code has been developed by Openzipkin contributors.

data/README.md

@@ -0,0 +1,237 @@
+# ZipkinTracer: Zipkin client for Ruby
+
+[![Build Status](https://api.travis-ci.org/openzipkin/zipkin-ruby.svg?branch=master)](https://travis-ci.org/openzipkin/zipkin-ruby)
+
+Rack and Faraday integration middlewares for Zipkin tracing.
+
+## Usage
+
+### Sending traces on incoming requests
+
+Options can be provided via Rails.config for a Rails 3+ app, or can be passed as a hash argument to the Rack plugin.
+
+```ruby
+require 'zipkin-tracer'
+use ZipkinTracer::RackHandler, config # config is optional
+```
+
+where `Rails.config.zipkin_tracer` or `config` is a hash that can contain the following keys:
+
+* `:service_name` **REQUIRED** - the name of the service being traced. There are two ways to configure this value. Either write the service name in the config file or set the "DOMAIN" environment variable (e.g. 'test-service.example.com' or 'test-service'). The environment variable takes precedence over the config file value.
+* `:sample_rate` (default: 0.1) - the ratio of requests to sample, from 0 to 1
+* `:json_api_host` - hostname with protocol of a zipkin api instance (e.g. `https://zipkin.example.com`) to use the HTTP sender
+* `:zookeeper` - the address of the zookeeper server to use by the Kafka sender
+* `:sqs_queue_name` - the name of the Amazon SQS queue to use the SQS sender
+* `:sqs_region` - the AWS region for the Amazon SQS queue
+* `:log_tracing` - Set to true to log all traces. Only used if traces are not sent to the API or Kafka.
+* `:annotate_plugin` - plugin function which receives the Rack env, the response status, headers, and body to record annotations
+* `:filter_plugin` - plugin function which receives the Rack env and will skip tracing if it returns false
+* `:whitelist_plugin` - plugin function which receives the Rack env and will force sampling if it returns true
+* `:sampled_as_boolean` - When set to true (default but deprecrated), it uses true/false for the `X-B3-Sampled` header. When set to false uses 1/0 which is preferred.
+* `:trace_id_128bit` - When set to true, high 8-bytes will be prepended to trace_id. The upper 4-bytes are epoch seconds and the lower 4-bytes are random. This makes it convertible to Amazon X-Ray trace ID format v1. (See http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-request-tracing.html)
+
+### Sending traces on outgoing requests with Faraday
+
+First, Faraday has to be part of your Gemfile:
+```
+gem 'faraday', '~> 0.8'
+```
+
+For the Faraday middleware to have the correct trace ID, the rack middleware should be used in your application as explained above.
+
+Then include `ZipkinTracer::FaradayHandler` as a Faraday middleware:
+
+```ruby
+require 'faraday'
+require 'zipkin-tracer'
+
+conn = Faraday.new(:url => 'http://localhost:9292/') do |faraday|
+  faraday.use ZipkinTracer::FaradayHandler, 'service_name' # 'service_name' is optional (but recommended)
+  # default Faraday stack
+  faraday.request :url_encoded
+  faraday.adapter Faraday.default_adapter
+end
+```
+
+Note that supplying the service name for the destination service is optional;
+the tracing will default to a service name derived from the first section of the destination URL (e.g. 'service.example.com' => 'service').
+
+### Tracing Sidekiq workers
+
+Sidekiq tracing can be turned on by adding ZipkinTracer::Sidekiq::Middleware to your sidekiq middleware chain:
+
+```ruby
+zipkin_tracer_config = {
+  service_name: 'service',
+  json_api_host: 'http://zipkin.io',
+  traceable_workers: [:MyWorker, :MyWorker2],
+  sample_rate: 0.5
+}
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add ZipkinTracer::Sidekiq::Middleware, zipkin_tracer_config
+  end
+end
+```
+
+By default workers aren't traced. You can specify the workers that you want to trace with traceable_workers config option. If you want all your workers to be traced pass [:all] to traceable_workers option (traceable_workers: [:all]).
+
+### Local tracing
+
+`ZipkinTracer::TraceClient` provides an API to record local traces in your application.
+It can be used to measure the performance of process, record value of variables, and so on.
+
+When `local_component_span` method is called, it creates a new span and a local component, and provides the following methods to create annotations.
+* record(key) - annotation
+* record_tag(key, value) - tag
+
+Example:
+```ruby
+ZipkinTracer::TraceClient.local_component_span('DB process') do |ztc|
+  ztc.record 'Create users'
+  ztc.record_tag 'number', '1000'
+
+  # create 1000 users
+end
+```
+
+
+## Senders
+
+Only one of the following senders can be used at a given time.
+
+### HTTP
+
+Sends traces as JSON over HTTP. This is the preferred sender to use as the openzipkin project moves away from Thrift.
+
+You need to specify the `:json_api_host` parameter to wherever your zipkin collector is running. It will POST traces to the `/api/v2/spans` path.
+
+### Kafka
+
+Uses Kafka as the transport.
+
+If in the config `:zookeeper` is set, then the gem will use Kafka via
+[Hermann](https://github.com/reiseburo/hermann); you will need the `hermann`
+gem  (~> 0.27.0) installed, as it is not part of zipkin-tracer's gemspec.
+
+Alternatively, you may provide a :producer option in the config; this producer
+should accept #push() with a message and optional :topic.  If the value returned
+responds to #value!, it will be called (to block until completed).
+
+Caveat: Hermann is only usable from within Jruby, due to its implementation of zookeeper based broker discovery being JVM based.
+
+The Kafka transport send data using Thrift. Since version 0.31.0, Thrift is not a dependency, thus the gem 'finagle-thrift' needs to be added to the Gemfile also.
+
+### Amazon SQS
+
+Uses Amazon SQS as the transport.
+
+If `:sqs_queue_name` is set in the config, then the gem will use Amazon SQS; you will need the `aws-sdk-sqs` gem installed, as it is not part of zipkin-tracer's gemspec.
+
+The following [Amazon SQS permissions](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-permissions-reference.html) are required:
+- `sqs:SendMessage`
+- `sqs:GetQueueUrl`
+
+Optionally, you can set `:sqs_region` to specify the AWS region to connect to.
+
+### Logger
+
+The simplest sender that does something. It will log all your spans.
+This sender can be used for debugging purpose (to see what is going to be sent) or to deliver zipkin information into the logs for later retrieval and analysis.
+
+You need to set `:log_tracing` to true in the configuration.
+
+### Null
+
+If the configuration does not provide either an API host, Zookeeper server or Amazon SQS queue then the middlewares will not attempt to send traces although they will still generate proper IDs and pass them to other services.
+
+Thus, if you only want to generate IDs for instance for logging and do not intent to integrate with Zipkin you can still use this gem. Just do not specify any server :)
+
+
+## Plugins
+
+### annotate_plugin
+The annotate plugin expects a function of the form:
+
+```ruby
+lambda { |span, env, status, response_headers, response_body| ... }
+```
+
+The annotate plugin is expected to perform annotation based on content of the Rack environment and the response components.
+
+**Warning:** Access to the response body may cause problems if the response is being streamed, in general this should be avoided.
+See the Rack specification for more detail and instructions for properly hijacking responses.
+
+The return value is ignored.
+
+For example:
+
+```ruby
+lambda do |span, env, status, response_headers, response_body|
+  ep = ::Trace.default_endpoint
+  # string annotation
+  span.record_tag('http.referrer', env['HTTP_REFERRER'])
+  # integer annotation
+  span.record_tag('http.content_size', env['CONTENT_SIZE'].to_s)
+  span.record_tag('http.status_code', status)
+end
+```
+
+### filter_plugin
+The filter plugin expects a function of the form:
+
+```ruby
+lambda { |env| ... }
+```
+
+The filter plugin allows skipping tracing if the return value is false.
+
+For example:
+
+```ruby
+# don't trace /static/ URIs
+lambda { |env| env['PATH_INFO'] !~ /^\/static\// }
+```
+
+### whitelist_plugin
+The whitelist plugin expects a function of the form:
+
+```ruby
+lambda { |env| ... }
+```
+
+The whitelist plugin allows forcing sampling if the return value is true.
+
+For example:
+
+```ruby
+# sample if request header specifies known device identifier
+lambda { |env| KNOWN_DEVICES.include?(env['HTTP_X_DEVICE_ID']) }
+```
+
+## Development
+
+This project uses Rspec. Make sure your PRs contain proper tests.
+We have two rake tasks to help finding performance issues:
+```
+rake benchmark
+```
+Will run a benchmark testing all the different tracers and giving you
+their relative speed.
+
+```
+rake run_once
+```
+Will run the rack middleware, optionally the faraday middleware. Please
+modify the code to run the middleware you want to test.
+The best way to use this rake test is together with rbtrace.
+First run the task in background:
+```
+rake run_once &
+```
+Take note of the PID that displays in your terminal and run:
+```
+rbtrace -p PID -f
+```
+It will print out the methods used and the time each took.

data/RELEASE.md

@@ -0,0 +1,6 @@
+## Release Process
+
+* tag the commit `git tag -v0.0.0`
+* push tags to origin `git push origin --tags`
+* Travis will automatically build and push to rubygems
+* TODO: have travis push the tag using info from version.rb

data/Rakefile

@@ -0,0 +1,134 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'zipkin-tracer'
+require 'benchmark'
+require 'benchmark/ips'
+require 'faraday'
+require 'rack/mock'
+require 'rbtrace'
+require 'tempfile'
+
+def add_rspec_options(options=[])
+  if RUBY_PLATFORM == 'java'
+    options << '--tag ~platform:mri'
+  else
+    options << '--tag ~platform:java'
+  end
+  return options
+end
+
+RSpec::Core::RakeTask.new(:spec) do |r|
+  r.rspec_opts = add_rspec_options
+end
+
+task :default => :spec
+
+
+# Used to test a completely minimum middleware, no zipkin.
+class EmptyMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    if @app.respond_to?(:call)
+      status, headers, body = @app.call(env)
+    else
+      [200, {}, 'Hello world']
+    end
+  end
+end
+
+
+# Used to mock a middleware which uses Faraday.
+# Note that we are creating fake objects pretending to be Faraday for speed.
+class FaradayMiddleware
+  def initialize
+    response_env = { status: 200 }
+    @env = {
+        method: :post,
+        url: 'http://www.this_is_not_really_called.com',
+        body: 'majere',
+        request_headers: Faraday::Utils::Headers.new({}),
+      }
+      @app = lambda { |env| ResponseObject.new(@env, response_env) }
+      @middleware = ZipkinTracer::FaradayHandler.new(@app)
+  end
+
+  def call(_env)
+    @middleware.call(@env)
+  end
+
+  private
+
+  class ResponseObject
+    attr_reader :env
+
+    def initialize(env, response_env)
+      @env = env
+      @response_env = response_env
+    end
+
+    def on_complete
+      yield @response_env
+      self
+    end
+  end
+end
+
+desc "Runs a zipkin middleware once."
+task :run_once do
+  empty_app = EmptyMiddleware.new(nil)
+  app = FaradayMiddleware.new
+
+  logger = Logger.new(Tempfile.new('fakelog'))
+  null_configuration = { logger: logger, sample_rate: 1}
+  null_tracer_rack = ZipkinTracer::RackHandler.new(app, null_configuration)
+  env = Rack::MockRequest.env_for('/path', {})
+
+  sleep(10)
+  null_tracer_rack.call(env)
+end
+
+# This task is used to help development of ZipkinTracer.
+# It benchmark the relative performance of the different tracers.
+desc "Runs benchmarks for ZipkinTracer."
+task :benchmark do
+  logger = Logger.new(Tempfile.new('fakelog'))
+  fake_url = 'http://www.google.com' #resolve but unable to send I hope!
+
+  empty_app = EmptyMiddleware.new(nil)
+
+  null_configuration = { sample_rate: 1 }
+  json_configuration = null_configuration.merge(json_api_host: fake_url)
+  logger_configuration = null_configuration.merge(logger: logger)
+
+  # We create a different faraday middleware per rack middleware below because
+  # both middlewares share the same tracer. So they need to be created in pairs.
+  empty_rack = EmptyMiddleware.new(empty_app)
+  null_tracer_rack = ZipkinTracer::RackHandler.new(empty_app, null_configuration)
+  null_faraday_app = FaradayMiddleware.new
+  null_tracer_faraday_rack = ZipkinTracer::RackHandler.new(null_faraday_app, null_configuration)
+  json_tracer_rack = ZipkinTracer::RackHandler.new(empty_app, json_configuration)
+  json_faraday_app = FaradayMiddleware.new
+  json_tracer_faraday_rack = ZipkinTracer::RackHandler.new(json_faraday_app, json_configuration)
+  logger_tracer_rack = ZipkinTracer::RackHandler.new(empty_app, logger_configuration)
+  log_faraday_app = FaradayMiddleware.new
+  logger_tracer_faraday_rack = ZipkinTracer::RackHandler.new(log_faraday_app, logger_configuration)
+
+  env = Rack::MockRequest.env_for('/path', {})
+
+  Benchmark.ips do |bm|
+  # bm.report("No rack middleware") { empty_rack.call(env) } # Uncomment if curious
+    bm.report("NullTracer") { null_tracer_rack.call(env) }
+    bm.report("NullTracer + Faraday") { null_tracer_faraday_rack.call(env) }
+    bm.report("JSONTracer") { json_tracer_rack.call(env) }
+    bm.report("JSONTracer + Faraday") { json_tracer_faraday_rack.call(env) }
+    bm.report("Logging Tracer") { logger_tracer_rack.call(env) }
+    bm.report("Logging Tracer + Faraday") { logger_tracer_faraday_rack.call(env) }
+    bm.compare!
+  end
+
+  puts "i/s means the number of times the middleware can be called per second"
+
+end

data/lib/zipkin-tracer/version.rb

@@ -1,3 +1,3 @@
 module ZipkinTracer
-  VERSION = '0.36.1'.freeze
+  VERSION = '0.36.2'.freeze
 end

data/zipkin-tracer.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zipkin-tracer/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'zipkin-tracer'
+  s.version     = ZipkinTracer::VERSION
+  s.authors     = ['Franklin Hu', 'R Tyler Croy', 'James Way', 'Jordi Polo', 'Julien Feltesse', 'Scott Steeg', 'Yohei Kitamura']
+  s.email       = ['franklin@twitter.com', 'tyler@monkeypox.org', 'jamescway@gmail.com', 'jcarres@medidata.com', 'jfeltesse@medidata.com', 'ssteeg@medidata.com', 'ykitamura@medidata.com']
+  s.summary     = 'Ruby tracing via Zipkin'
+  s.description = 'Adds tracing instrumentation for ruby applications'
+  s.license     = 'Apache-2.0'
+  s.metadata    = {
+    'homepage_uri'  => 'https://github.com/openzipkin/zipkin-ruby',
+    'changelog_uri' => 'https://github.com/openzipkin/zipkin-ruby/blob/master/CHANGELOG.md'
+  }
+
+  s.required_ruby_version = '>= 2.3.0'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.require_paths = ['lib']
+
+  s.add_dependency 'faraday', '~> 0.8'
+  s.add_dependency 'rack', '>= 1.0'
+  s.add_dependency 'sucker_punch', '~> 2.0'
+
+  s.add_development_dependency 'aws-sdk-sqs', '~> 1.0'
+  s.add_development_dependency 'excon', '~> 0.53'
+  s.add_development_dependency 'rspec', '~> 3.8'
+  s.add_development_dependency 'rack-test', '~> 1.1'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'timecop', '~> 0.8'
+  s.add_development_dependency 'webmock', '~> 3.0'
+  s.add_development_dependency 'simplecov', '~> 0.16'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.36.1
+  version: 0.36.2
 platform: ruby
 authors:
 - Franklin Hu
@@ -10,10 +10,11 @@ authors:
 - Jordi Polo
 - Julien Feltesse
 - Scott Steeg
+- Yohei Kitamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-15 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -174,13 +175,24 @@ email:
 - franklin@twitter.com
 - tyler@monkeypox.org
 - jamescway@gmail.com
-- jcarres@mdsol.com
-- jfeltesse@mdsol.com
-- ssteeg@mdsol.com
+- jcarres@medidata.com
+- jfeltesse@medidata.com
+- ssteeg@medidata.com
+- ykitamura@medidata.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- NOTICE.md
+- README.md
+- RELEASE.md
+- Rakefile
 - lib/zipkin-tracer.rb
 - lib/zipkin-tracer/application.rb
 - lib/zipkin-tracer/config.rb
@@ -202,10 +214,13 @@ files:
 - lib/zipkin-tracer/zipkin_null_sender.rb
 - lib/zipkin-tracer/zipkin_sender_base.rb
 - lib/zipkin-tracer/zipkin_sqs_sender.rb
-homepage: https://github.com/openzipkin/zipkin-tracer
+- zipkin-tracer.gemspec
+homepage: 
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/openzipkin/zipkin-ruby
+  changelog_uri: https://github.com/openzipkin/zipkin-ruby/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -219,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.5
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: