zipkin-tracer 0.45.0 → 0.47.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d468909c2b28497b50dba2901e92f651ec45b555cca6fc1453258140e996f0d
-  data.tar.gz: 79508ca6c29d18906610ddf0950e33951e05f5db185e169af895a3982df3c40d
+  metadata.gz: 853e0ae1f408f68a420193b5deb379ab1acbd697b75f98bfbd9115071eb62902
+  data.tar.gz: 960b5be09c3c54a38ea23596a6e085a4d5beb9908ab2309c36027dbc6fe3933a
 SHA512:
-  metadata.gz: e3f979dfa0f2be704ab85940dd4e6d6738fd9c587750b04929304eb72b55b122375a7e1c3e8ac2b8fac238aa8c154d24a8dae86e07bdf36f1d0e974a604cdbf5
-  data.tar.gz: 8bc0b4f4b2ee75570563d0a4aaba3823a8f6b6a8ccb1c99c0063e38726e9cedf749ab9722be3eb3837db0947e8f43b2ee44c47df6a8e6f378815adf7a6ceca58
+  metadata.gz: 9b11d82d1c20be368f1b0ec44c98d53648f9bba071880b65e4a37f455d529014d693a0a8808cb46e4aa661375b40ecc9725aa267f177a322297d6f74be0166a8
+  data.tar.gz: 3a9650a7b7a9e926af207c1064f5e45206545c879f8b00625d83dc020e82dbc388e5574dea1974697cd46a301e78730198d660095b862e01e539300a18c5556c

data/.github/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing to Zipkin
+
+If you would like to contribute code, fork this GitHub repository and
+send a pull request (on a branch other than `master` or `gh-pages`).
+
+## License
+
+By contributing your code, you agree to license your contribution under
+the terms of the [APLv2](../LICENSE).
+
+All files are copyright "The OpenZipkin Authors" and released with the Apache 2.0 license.

data/.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,15 @@
+---
+name: Bug
+about: If you’ve found a bug, spend the time to write a failing test. Bugs with tests get fixed and stay fixed. If you have a solution in mind, skip raising an issue and open a pull request instead.
+labels: bug
+---
+## Describe the Bug
+A clear and concise description of what the bug is. If you have a solution in mind, skip raising an issue and open a pull request instead.
+
+Regardless, the best is to spend some time to write a failing test. Bugs with tests get fixed and stay fixed.
+
+## Steps to Reproduce
+Steps to reproduce the behavior:
+
+## Expected Behaviour
+Suggest what you think correct behaviour should be. Note, it may be solved differently depending on the problem.

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Question
+    url: https://gitter.im/openzipkin/zipkin
+    about: Please ask questions about how to do something or to understand why something isn't working on our Gitter chat - we'll be happy to respond there in detail. This issue tracker is not for questions.

data/.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,19 @@
+---
+name: Feature Request
+about: Please first, look at existing issues to see if the feature has been requested before.
+labels: enhancement
+---
+Please first, look at [existing issues](https://github.com/openzipkin/zipkin-ruby/issues) to see if the feature has been requested before. If you don't find anything tell us what problem you’re trying to solve. Often a solution already exists! Don’t send pull requests to implement new features without first getting our support. Sometimes we leave features out on purpose to keep the project small.
+
+## Feature
+Description of the feature
+
+## Rationale
+Why would this feature help others besides me?
+
+## Example Scenario
+What kind of use cases would benefit from this feature?
+
+## Prior Art
+* Links to prior art
+* More links

data/.github/workflows/deploy.yml

@@ -0,0 +1,34 @@
+# yamllint --format github .github/workflows/deploy.yml
+---
+name: deploy
+
+# We deploy on a release versions, regardless of if the commit is documentation-only or not.
+#
+# See https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet
+on:
+  push:
+    tags: '[0-9]+.[0-9]+.[0-9]+**'  # Ex. 1.2.3
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04  # newest available distribution, aka focal
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1  # full history is not needed
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: Deploy
+        env:
+          # RUBYGEMS_API_KEY=<hex token value>
+          #   - needs to own the gem
+          #   - generated at https://rubygems.org/settings/edit
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          BUNDLE_GEMFILE: gemfiles/faraday_1.x.gemfile
+        run: |  # GITHUB_REF will be refs/tags/MAJOR.MINOR.PATCH
+          build-bin/configure_deploy &&
+          build-bin/deploy $(echo ${GITHUB_REF} | cut -d/ -f 3)

data/.github/workflows/test.yml

@@ -0,0 +1,40 @@
+# yamllint --format github .github/workflows/test.yml
+---
+name: test
+
+# We don't test documentation-only commits.
+on:
+  # We run tests on non-tagged pushes to master
+  push:
+    tags: ''
+    branches: master
+    paths-ignore: '**/*.md'
+  # We also run tests on pull requests targeted at the master branch.
+  pull_request:
+    branches: master
+    paths-ignore: '**/*.md'
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04  # newest available distribution, aka focal
+    strategy:
+      fail-fast: false
+      matrix:  # https://github.com/ruby/setup-ruby/blob/master/README.md#supported-versions
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, jruby-9.1, jruby-9.2]
+        gemfile:
+          - gemfiles/faraday_0.x.gemfile
+          - gemfiles/faraday_1.x.gemfile
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1  # full history is not needed
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Test
+        run: build-bin/configure_test && build-bin/test
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}

data/.gitignore

@@ -33,3 +33,7 @@
 Gemfile.lock
 
 .byebug_history
+
+# IntelliJ
+.idea
+*.iml

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.47.3
+* Moved CI to [GitHub Actions](https://github.com/openzipkin/zipkin-ruby/workflows).
+
+# 0.47.2
+* Fix to not flush local component span when a server span or a consumer span is in the stack.
+
+# 0.47.1
+* Fix to set `SERVER` span kind at the beginning to avoid being flushed before closing.
+
+# 0.47.0
+* Add a `check_routes` option to make the routable request check optional.
+
+# 0.46.0
+* Add Amazon SQS tracer.
+
 # 0.45.0
 * Add a `trace_context` option to the TraceWrapper utility class to retrieve trace data.
 

data/README.md

@@ -1,6 +1,8 @@
 # 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)
+[![Gitter chat](http://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/openzipkin/zipkin)
+[![Build Status](https://github.com/openzipkin/zipkin-ruby/workflows/test/badge.svg)](https://github.com/openzipkin/zipkin-ruby/actions?query=workflow%3Atest)
+[![Gem Version](https://badge.fury.io/rb/zipkin-tracer.svg)](https://badge.fury.io/rb/zipkin-tracer)
 
 Rack and Faraday integration middlewares for Zipkin tracing.
 
@@ -21,6 +23,7 @@ use ZipkinTracer::RackHandler, config
 * `: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
 * `: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.
+* `:check_routes` - When set to `true`, only routable requests are sampled. Defaults to `false`.
 * `: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)
 * `:async` - By default senders will flush traces asynchronously. Set to `false` to make that process synchronous. Only supported by the HTTP, RabbitMQ, and SQS senders.
 * `:logger` - The default logger for Rails apps is `Rails.logger`, else it is `STDOUT`. Use this option to pass a custom logger.
@@ -81,6 +84,38 @@ 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]).
 
+### Tracing Amazon SQS messages
+
+Amazon SQS tracing can be turned on by requiring [zipkin-tracer/sqs/adapter](lib/zipkin-tracer/sqs/adapter.rb):
+```ruby
+require 'zipkin-tracer/sqs/adapter'
+```
+
+This SQS adapter overrides the `send_message` and `send_message_batch` methods to add trace data as message attributes and to generate a producer span when the methods are called. Since all SQS messages are affected, it is not recommended to use this feature with the [SQS sender](lib/zipkin-tracer/zipkin_sqs_sender.rb).
+
+When receiving messages, you need to pass the `message_attribute_names: ['All']` option to retrive message attributes:
+```ruby
+resp = sqs.receive_message(
+  queue_url: queue_url,
+  message_attribute_names: ['All']
+)
+```
+
+Then you can utilize the [TraceWrapper](#tracewrapper) class to generate a consumer span:
+```ruby
+msg = resp.messages.first
+trace_context = msg.message_attributes.each_with_object({}) { |(key, value), hsh| hsh[key.to_sym] = value.string_value }
+
+TraceWrapper.wrap_in_custom_span(config, 'receive_message',
+  span_kind: Trace::Span::Kind::CONSUMER,
+  trace_context: trace_context
+) do |span|
+  span.remote_endpoint = Trace::Endpoint.remote_endpoint(nil, 'amazon-sqs')
+  span.record_tag('queue.url', queue_url)
+  :
+end
+```
+
 ### Local tracing
 
 `ZipkinTracer::TraceClient` provides an API to record local traces in your application.

data/RELEASE.md

@@ -1,6 +1,44 @@
-## Release Process
+# OpenZipkin 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
+This repo uses semantic versions. Please keep this in mind when choosing version numbers.
+
+1. **Alert others you are releasing**
+
+   There should be no commits made to master while the release is in progress (about 10 minutes). Before you start
+   a release, alert others on [gitter](https://gitter.im/openzipkin/zipkin) so that they don't accidentally merge
+   anything. If they do, and the build fails because of that, you'll have to recreate the release tag described below.
+
+1. **Push a git tag**
+
+   The tag should formatted `MAJOR.MINOR.PATCH`, ex `git tag 1.18.1 && git push origin 1.18.1`.
+
+1. **Wait for CI**
+
+   The `MAJOR.MINOR.PATCH` tag triggers [`build-bin/deploy`](build-bin/deploy), which does the following:
+     * https://rubygems.org/gems/zipkin-tracer [`build-bin/gem/gem_push`](build-bin/gem/gem_push)
+
+## Credentials
+
+The release process uses various credentials. If you notice something failing due to unauthorized,
+look at the notes in [.github/workflows/deploy.yml] and check the [org secrets](https://github.com/organizations/openzipkin/settings/secrets/actions).
+
+## Manually releasing
+
+If for some reason, you lost access to CI or otherwise cannot get automation to work, bear in mind
+this is a normal ruby project, and can be released accordingly.
+
+```bash
+# First, set variable according to your personal credentials. These would normally be assigned as
+# org secrets: https://github.com/organizations/openzipkin/settings/secrets/actions
+export RUBYGEMS_API_KEY=your_api_key
+release_version=xx-version-to-release-xx
+
+# now from latest master, create the MAJOR.MINOR.PATCH tag
+git tag ${release_version}
+
+# Run the deploy using the version you added as a tag
+./build-bin/deploy ${release_version}
+
+# Finally, push the tag
+git push origin ${release_version}
+```

data/build-bin/README.md

@@ -0,0 +1,203 @@
+# Test and Deploy scripts
+
+This is a Ruby project, which uses standard conventions for test and deploy.
+
+Test is normal, except there's a matrix in [CI setup](../.github/workflows/test.yml).
+
+To create a release, push a MAJOR.MINOR.PATCH tag (ex `0.47.2`). Below are details about the deployment process.
+
+Notably, the [gem version](../lib/zipkin-tracer/version.rb) is lazy set, defaulting to `0.0.0`. When
+a release MAJOR.MINOR.PATCH tag (ex `0.47.2`) is pushed, this file is overwritten as a side effect of running
+[deploy]. The release version is not written into git history except as a part of [../CHANGELOG.md]. 
+
+[//]: # (Below here should be standard for all projects)
+
+## Build Overview
+`build-bin` holds portable scripts used in CI to test and deploy the project.
+
+The scripts here are portable. They do not include any CI provider-specific logic or ENV variables.
+This helps `.travis.yml` and `test.yml` (GitHub Actions) contain nearly the same contents, even if
+certain OpenZipkin projects need slight adjustments here. Portability has proven necessary, as
+OpenZipkin has had to transition CI providers many times due to feature and quota constraints.
+
+These scripts serve a second purpose, which is to facilitate manual releases, which has also
+happened many times due usually to service outages of CI providers. While tempting to use
+CI-provider specific tools, doing so can easily create a dependency where no one knows how to
+release anymore. Do not use provider-specific mechanisms to implement release flow. Instead,
+automate triggering of the scripts here.
+
+The only scripts that should be modified per project are in the base directory. Those in sub
+directories, such as [docker], should not vary project to project except accident of version drift.
+Intentional changes in sub directories should be relevant and tested on multiple projects to ensure
+they can be blindly copy/pasted.
+
+Conversely, the files in the base directory are project specific entry-points for test and deploy
+actions and are entirely appropriate to vary per project. Here's an overview:
+
+## Test
+
+Test builds and runs any tests of the project, including integration tests. CI providers should be
+configured to run tests on pull requests or pushes to the master branch, notably when the tag is
+blank. Tests should not run on documentation-only commits. Tests must not depend on authenticated
+resources, as running tests can leak credentials. Git checkouts should include the full history so
+that license headers or other git analysis can take place.
+
+ * [configure_test] - Sets up build environment for tests.
+ * [test] - Builds and runs tests for this project.
+
+### Example GitHub Actions setup
+
+A simplest GitHub Actions `test.yml` runs tests after configuring them, but only on relevant event
+conditions. The name `test.yml` and job `test` allows easy references to status badges and parity of
+the scripts it uses.
+
+The `on:` section obviates job creation and resource usage for irrelevant events. Notably, GitHub
+Actions includes the ability to skip documentation-only jobs.
+
+Combine [configure_test] and [test] into the same `run:` when `configure_test` primes file system
+cache.
+
+Here's a partial `test.yml` including only the aspects mentioned above.
+```yaml
+on:
+  push:
+    tags: ''
+    branches: master
+    paths-ignore: '**/*.md'
+  pull_request:
+    branches: master
+    paths-ignore: '**/*.md'
+
+jobs:
+  test:
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # full git history
+      - name: Test
+        run: build-bin/configure_test && build-bin/test
+```
+
+### Example Travis setup
+`.travis.yml` is a monolithic configuration file broken into stages, of which the default is "test".
+A simplest Travis `test` job configures tests in `install` and runs them as `script`, but only on
+relevant event conditions.
+
+The `if:` section obviates job creation and resource usage for irrelevant events. Travis does not
+support file conditions. A `before_install` step to skip documentation-only commits will likely
+complete in less than a minute (10 credit cost).
+
+Here's a partial `.travis.yml` including only the aspects mentioned above.
+```yaml
+git:
+  depth: false  # full git history for license check, and doc-only skipping
+
+jobs:
+  include:
+    - stage: test
+      if: branch = master AND tag IS blank AND type IN (push, pull_request)
+      name: Run unit and integration tests
+      before_install: |
+        if [ -n "${TRAVIS_COMMIT_RANGE}" ] && ! git diff --name-only "${TRAVIS_COMMIT_RANGE}" -- | grep -qv '\.md$'; then
+          echo "Stopping job as changes only affect documentation (ex. README.md)"
+          travis_terminate 0
+        fi
+      install: ./build-bin/configure_test
+      script: ./build-bin/test
+```
+
+## Deploy
+
+Deploy builds and pushes artifacts to a remote repository for master and release commits on it. CI
+providers deploy pushes to master on when the tag is blank, but not on documentation-only commits.
+Releases should deploy on version tags (ex `/^[0-9]+\.[0-9]+\.[0-9]+/`), without consideration of if
+the commit is documentation only or not.
+
+ * [configure_deploy] - Sets up environment and logs in, assuming [configure_test] was not called.
+ * [deploy] - deploys the project, with arg0 being "master" or a release commit like "1.2.3"
+
+### Example GitHub Actions setup
+
+A simplest GitHub Actions `deploy.yml` deploys after logging in, but only on relevant event
+conditions. The name `deploy.yml` and job `deploy` allows easy references to status badges and
+parity of the scripts it uses.
+
+The `on:` section obviates job creation and resource usage for irrelevant events. GitHub Actions
+cannot implement "master, except documentation only-commits" in the same file. Hence, deployments of
+master will happen even on README change.
+
+Combine [configure_deploy] and [deploy] into the same `run:` when `configure_deploy` primes file
+system cache.
+
+Here's a partial `deploy.yml` including only the aspects mentioned above. Notice env variables are
+explicitly defined and `on.tags` is a [glob pattern](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet).
+```yaml
+on:
+  push:
+    tags: '[0-9]+.[0-9]+.[0-9]+**'  # Ex. 8.272.10 or 15.0.1_p9
+    branches: master
+
+jobs:
+  deploy:
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1  # only needed to get the sha label
+      - name: Deploy
+        env:
+          GH_USER: ${{ secrets.GH_USER }}
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        run: |  # GITHUB_REF will be refs/heads/master or refs/tags/MAJOR.MINOR.PATCH
+          build-bin/configure_deploy &&
+          build-bin/deploy $(echo ${GITHUB_REF} | cut -d/ -f 3)
+```
+
+### Example Travis setup
+`.travis.yml` is a monolithic configuration file broken into stages. This means `test` and `deploy`
+are in the same file. A simplest Travis `deploy` stage has two jobs: one for master pushes and
+another for version tags. These jobs are controlled by event conditions.
+
+The `if:` section obviates job creation and resource usage for irrelevant events. Travis does not
+support file conditions. A `before_install` step to skip documentation-only commits will likely
+complete in less than a minute (10 credit cost).
+
+As billing is by the minute, it is most cost effective to combine test and deploy on master push.
+
+Here's a partial `.travis.yml` including only the aspects mentioned above. Notice YAML anchors work
+in Travis and `tag =~` [condition](https://github.com/travis-ci/travis-conditions) is a regular
+expression.
+```yaml
+git:
+  depth: false  # full git history for license check, and doc-only skipping
+
+_terminate_if_only_docs: &terminate_if_only_docs |
+  if [ -n "${TRAVIS_COMMIT_RANGE}" ] && ! git diff --name-only "${TRAVIS_COMMIT_RANGE}" -- | grep -qv '\.md$'; then
+    echo "Stopping job as changes only affect documentation (ex. README.md)"
+    travis_terminate 0
+  fi
+
+jobs:
+  include:
+    - stage: test
+      if: branch = master AND tag IS blank AND type IN (push, pull_request)
+      before_install: *terminate_if_only_docs
+      install: |
+        if [ "${TRAVIS_SECURE_ENV_VARS}" = "true" ] && [ "${TRAVIS_PULL_REQUEST}" = "false" ]; then
+          export SHOULD_DEPLOY=true
+          ./build-bin/configure_deploy
+        else
+          export SHOULD_DEPLOY=false
+          ./build-bin/configure_test
+        fi
+      script:
+        - ./build-bin/test || travis_terminate 1
+        - if [ "${SHOULD_DEPLOY}" != "true" ]; then travis_terminate 0; fi
+        - travis_wait ./build-bin/deploy master
+    - stage: deploy
+      # Ex. 8.272.10 or 15.0.1_p9
+      if: tag =~ /^[0-9]+\.[0-9]+\.[0-9]+/ AND type = push AND env(GH_TOKEN) IS present
+      install: ./build-bin/configure_deploy
+      script: ./build-bin/deploy ${TRAVIS_TAG}
+```

data/build-bin/configure_deploy

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -ue
+
+# This script sets up anything needed for `./deploy`. Do not assume `configure_test` was called.
+#
+# See [README.md] for an explanation of this and how CI should use it.
+build-bin/gem/configure_gem_credentials
+build-bin/gem/bundle_install

data/build-bin/configure_test

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -ue
+
+# This script sets up anything needed for `./test`. This should not login to anything, as that
+# should be done in `configure_deploy`.
+#
+# See [README.md] for an explanation of this and how CI should use it.
+build-bin/gem/bundle_install

data/build-bin/deploy

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+set -ue
+
+# This script deploys a release version.
+#
+# See [README.md] for an explanation of this and how CI should use it.
+version=${1?version is required. ex 0.2.3}
+
+export BUNDLE_GEMFILE=gemfiles/faraday_1.x.gemfile
+build-bin/gem/gem_push zipkin-tracer ZipkinTracer ${version}

data/build-bin/gem/bundle_install

@@ -0,0 +1,20 @@
+#!/bin/sh
+#
+# Copyright 2014-2020 The OpenZipkin Authors
+#
+# 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.
+#
+
+set -ue
+
+# This script ensures bundler is setup and install is run
+gem install bundler
+bundle install

data/build-bin/gem/configure_gem_credentials

@@ -0,0 +1,26 @@
+#!/bin/sh
+#
+# Copyright 2014-2020 The OpenZipkin Authors
+#
+# 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.
+#
+
+set -ue
+
+# This script configures rubygems_api_key needed to for gem-push
+
+credentials_file="${HOME}/.gem/credentials"
+mkdir -p "$(dirname "${credentials_file}")"
+cat > "${credentials_file}" <<-EOF
+---
+:rubygems_api_key: ${RUBYGEMS_API_KEY}
+EOF
+chmod 0600 "${credentials_file}"

data/build-bin/gem/gem_push

@@ -0,0 +1,39 @@
+#!/bin/sh
+#
+# Copyright 2014-2020 The OpenZipkin Authors
+#
+# 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.
+#
+
+set -ue
+
+# This script pushes a gem version, updating version.rb if out-of-date.
+#
+# This assumes `configure_gem_credentials` and `bundle_install` were invoked.
+gem=${1?gem is required. ex zipkin-tracer}
+module=${2?module is required. ex ZipkinTracer}
+version=${3?version is required. ex 0.2.3}
+
+current_version=$(ruby -r ./lib/${gem}/version.rb -e "puts ${module}::VERSION")
+
+if [ "${current_version}" != "${version}" ]; then
+  echo "Updating ${module}::VERSION from ${current_version} to ${version}"
+  cat > lib/${gem}/version.rb <<-EOF
+# frozen_string_literal: true
+
+module ${module}
+  VERSION = '${version}'
+end
+EOF
+fi
+
+bundle exec rake build
+gem push pkg/${gem}-${version}.gem

data/build-bin/test

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+set -ue
+
+# This script runs the tests of the project.
+#
+# See [README.md] for an explanation of this and how CI should use it.
+bundle exec rspec

data/lib/zipkin-tracer/config.rb

@@ -5,7 +5,7 @@ require 'zipkin-tracer/rack/zipkin-tracer'
 module ZipkinTracer
   # Configuration of this gem. It reads the configuration and provides default values
   class Config
-    attr_reader :service_name, :sample_rate, :sampled_as_boolean, :trace_id_128bit, :async, :logger,
+    attr_reader :service_name, :sample_rate, :sampled_as_boolean, :check_routes, :trace_id_128bit, :async, :logger,
       :json_api_host, :zookeeper, :kafka_producer, :kafka_topic, :sqs_queue_name, :sqs_region, :log_tracing,
       :annotate_plugin, :filter_plugin, :whitelist_plugin, :rabbit_mq_connection, :rabbit_mq_exchange,
       :rabbit_mq_routing_key, :write_b3_single_format
@@ -47,6 +47,8 @@ module ZipkinTracer
       if @sampled_as_boolean
         @logger && @logger.warn("Using a boolean in the Sampled header is deprecated. Consider setting sampled_as_boolean to false")
       end
+      # When set to true, only routable requests are sampled
+      @check_routes      = config[:check_routes].nil? ? DEFAULTS[:check_routes] : config[:check_routes]
 
       # 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.
@@ -95,6 +97,7 @@ module ZipkinTracer
     DEFAULTS = {
       sample_rate: 0.1,
       sampled_as_boolean: true,
+      check_routes: false,
       trace_id_128bit: false,
       write_b3_single_format: false
     }

data/lib/zipkin-tracer/hostname_resolver.rb

@@ -11,15 +11,17 @@ module ZipkinTracer
 
       each_endpoint(spans) do |endpoint|
         hostname = endpoint.ipv4
-        unless resolved_ip_address?(hostname.to_s)
-          endpoint.ipv4 = resolved_hosts[hostname]
-        end
+        next unless hostname
+        next if resolved_ip_address?(hostname.to_s)
+
+        endpoint.ipv4 = resolved_hosts[hostname]
       end
     end
 
     private
+
     LOCALHOST = '127.0.0.1'.freeze
-    LOCALHOST_I32 = 0x7f000001.freeze
+    LOCALHOST_I32 = 0x7f000001
     MAX_I32 = ((2 ** 31) - 1)
     MASK = (2 ** 32) - 1
     IP_FIELD = 3
@@ -49,10 +51,9 @@ module ZipkinTracer
     end
 
     def resolve(hosts, ip_format)
-      hosts.inject({}) do |host_map, host|
+      hosts.each_with_object({}) do |host, host_map|
         hostname = host.ipv4  # This field has been temporarly used to store the hostname.
-        host_map[hostname]  = host_to_format(hostname, ip_format)
-        host_map
+        host_map[hostname] = host_to_format(hostname, ip_format) if hostname
       end
     end
 

data/lib/zipkin-tracer/rack/zipkin-tracer.rb

@@ -25,6 +25,7 @@ module ZipkinTracer
           @app.call(env)
         else
           @tracer.with_new_span(trace_id, span_name(env)) do |span|
+            span.kind = Trace::Span::Kind::SERVER
             trace!(span, zipkin_env) { @app.call(env) }
           end
         end
@@ -55,7 +56,6 @@ module ZipkinTracer
     end
 
     def trace_server_information(span, zipkin_env, status)
-      span.kind = Trace::Span::Kind::SERVER
       span.record_status(status)
       SERVER_RECV_TAGS.each { |annotation_key, env_key| span.record_tag(annotation_key, zipkin_env.env[env_key]) }
     end

data/lib/zipkin-tracer/rack/zipkin_env.rb

@@ -71,7 +71,7 @@ module ZipkinTracer
       if parent_trace_sampled # A service upstream decided this goes in all the way
         parent_trace_sampled
       else
-        new_sampled_header_value(force_sample? || current_trace_sampled? && !filtered? && routable_request?)
+        new_sampled_header_value(force_sample? || current_trace_sampled? && !filtered? && traceable_request?)
       end
     end
 
@@ -83,9 +83,10 @@ module ZipkinTracer
       @config.filter_plugin && !@config.filter_plugin.call(@env)
     end
 
-    def routable_request?
+    def traceable_request?
+      return true unless @config.check_routes
+
       Application.routable_request?(@env)
     end
-
   end
 end

data/lib/zipkin-tracer/sqs/adapter.rb

@@ -0,0 +1,4 @@
+require 'aws-sdk-sqs'
+require 'zipkin-tracer/sqs/zipkin-tracer'
+
+Aws::SQS::Client.prepend(ZipkinTracer::SqsHandler)

data/lib/zipkin-tracer/sqs/zipkin-tracer.rb

@@ -0,0 +1,57 @@
+module ZipkinTracer
+  # This module is designed to prepend to the SQS client to add trace data as message attributes.
+  # https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sdk-sqs/lib/aws-sdk-sqs/client.rb
+  module SqsHandler
+    def send_message(params = {}, options = {})
+      zipkin_sqs_trace_wrapper(params, __method__) { |params_with_trace| super(params_with_trace, options) }
+    end
+
+    def send_message_batch(params = {}, options = {})
+      zipkin_sqs_trace_wrapper(params, __method__) { |params_with_trace| super(params_with_trace, options) }
+    end
+
+    private
+
+    ZIPKIN_KEYS = %i[trace_id parent_id span_id sampled].freeze
+    ZIPKIN_REMOTE_ENDPOINT_SQS = Trace::Endpoint.remote_endpoint(nil, 'amazon-sqs')
+
+    def zipkin_sqs_trace_wrapper(params, method_name)
+      trace_id = TraceGenerator.new.next_trace_id
+      zipkin_set_message_attributes(params, method_name, trace_id)
+
+      TraceContainer.with_trace_id(trace_id) do
+        if Trace.tracer && trace_id.sampled?
+          Trace.tracer.with_new_span(trace_id, method_name) do |span|
+            span.kind = Trace::Span::Kind::PRODUCER
+            span.remote_endpoint = ZIPKIN_REMOTE_ENDPOINT_SQS
+            span.record_tag('queue.url', params[:queue_url])
+            yield(params)
+          end
+        else
+          yield(params)
+        end
+      end
+    end
+
+    def zipkin_set_message_attributes(params, method_name, trace_id)
+      attributes = zipkin_message_attributes(trace_id)
+      case method_name
+      when :send_message
+        params[:message_attributes] = attributes.merge(params[:message_attributes] || {})
+      when :send_message_batch
+        params[:entries].each do |entry|
+          entry[:message_attributes] = attributes.merge(entry[:message_attributes] || {})
+        end
+      end
+    end
+
+    def zipkin_message_attributes(trace_id)
+      ZIPKIN_KEYS.each_with_object({}) do |zipkin_key, message_attributes|
+        zipkin_value = trace_id.send(zipkin_key)
+        next unless zipkin_value
+
+        message_attributes[zipkin_key] = { string_value: zipkin_value.to_s, data_type: 'String' }
+      end
+    end
+  end
+end

data/lib/zipkin-tracer/trace.rb

@@ -277,8 +277,8 @@ module Trace
     end
 
     def self.remote_endpoint(url, remote_service_name)
-      service_name = remote_service_name || url.host.split('.').first || UNKNOWN_URL # default to url-derived service name
-      Endpoint.new(url.host, url.port, service_name)
+      service_name = remote_service_name || url&.host&.split('.')&.first || UNKNOWN_URL # default to url-derived service name
+      Endpoint.new(url&.host, url&.port, service_name)
     end
 
     def to_h

data/lib/zipkin-tracer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipkinTracer
-  VERSION = '0.45.0'
+  VERSION = '0.47.3'
 end

data/lib/zipkin-tracer/zipkin_sender_base.rb

@@ -7,8 +7,7 @@ module Trace
   # Senders dealing with zipkin should inherit from this class and implement the
   # flush! method which actually sends the information
   class ZipkinSenderBase
-
-    def initialize(options={})
+    def initialize(options = {})
       @options = options
       reset
     end
@@ -39,8 +38,9 @@ module Trace
     end
 
     def skip_flush?(span)
-      return true if span.kind == Trace::Span::Kind::CLIENT && span.has_parent_span?
-      return true if span.kind == Trace::Span::Kind::PRODUCER && spans.any? { |s| s.kind == Trace::Span::Kind::SERVER }
+      return false if span.kind == Trace::Span::Kind::SERVER || span.kind == Trace::Span::Kind::CONSUMER
+
+      spans.any? { |s| s.kind == Trace::Span::Kind::SERVER || s.kind == Trace::Span::Kind::CONSUMER }
     end
 
     def flush!
@@ -62,6 +62,5 @@ module Trace
     def reset
       Thread.current[THREAD_KEY] = []
     end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.45.0
+  version: 0.47.3
 platform: ruby
 authors:
 - Franklin Hu
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -217,9 +217,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE/bug.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/feature.md"
+- ".github/workflows/deploy.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -230,6 +235,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- build-bin/README.md
+- build-bin/configure_deploy
+- build-bin/configure_test
+- build-bin/deploy
+- build-bin/gem/bundle_install
+- build-bin/gem/configure_gem_credentials
+- build-bin/gem/gem_push
+- build-bin/test
 - gemfiles/faraday_0.x.gemfile
 - gemfiles/faraday_1.x.gemfile
 - lib/zipkin-tracer.rb
@@ -241,6 +254,8 @@ files:
 - lib/zipkin-tracer/rack/zipkin-tracer.rb
 - lib/zipkin-tracer/rack/zipkin_env.rb
 - lib/zipkin-tracer/sidekiq/middleware.rb
+- lib/zipkin-tracer/sqs/adapter.rb
+- lib/zipkin-tracer/sqs/zipkin-tracer.rb
 - lib/zipkin-tracer/trace.rb
 - lib/zipkin-tracer/trace_client.rb
 - lib/zipkin-tracer/trace_container.rb
@@ -279,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby tracing via Zipkin

data/.travis.yml

@@ -1,36 +0,0 @@
-language: ruby
-dist: bionic
-jdk: openjdk11
-
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby-9.1
-  - jruby-9.2
-
-gemfile:
-  - gemfiles/faraday_0.x.gemfile
-  - gemfiles/faraday_1.x.gemfile
-
-script: bundle exec rspec
-
-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.7 && $BUNDLE_GEMFILE == $TRAVIS_BUILD_DIR/gemfiles/faraday_1.x.gemfile
-
-notifications:
-  webhooks:
-    urls:
-      - https://webhooks.gitter.im/e/ead3c37d57527214e9f2
-      - https://webhooks.gitter.im/e/e57478303f87ecd7bffc
-    on_success: change
-    on_failure: always