dox-jaeger-client 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed0aa9acc366ce81d7dca5190f529328d54f0045799c81b82902fbb56397f49e
+  data.tar.gz: '018c4bb34aec6d30861d6e1d56a7530e1249d04fc72a1f6bc19d530cc7206a90'
+SHA512:
+  metadata.gz: 85e73b523c2882025d566143972d194cbfb78035d472ea9b5a9095b3b68394d1b35097fc4751fddeaf5f42f755611704068b07b212a7b5d30fdca95b722ab4fd
+  data.tar.gz: f98a7b8e25a47ed07ec95ff4464cae1dba6d66feeb5d14c9ad0fdae139fdf6682786fce64d2cfd49c6a7552ef761fe6c0e7b06b987cc65b8b0f142a331eaba33

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: Ruby
+
+on:
+  push:
+  pull_request:
+    branches: [ master ]
+  schedule:
+    # Runs at 00:00 UTC on the 1st of every month.
+    - cron: '0 0 1 * *'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7.2', '3.0', '3.1']
+
+    services:
+      postgres:
+        image: docker
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+    - name: Run crossdock
+      run: make crossdock

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "idl"]
+	path = idl
+	url = https://github.com/jaegertracing/jaeger-idl.git

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,61 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'thrift/**/*'
+    - 'vendor/bundle/**/*'
+  NewCops: enable
+  TargetRubyVersion: '2.7'
+
+Style/Documentation:
+  Enabled: no
+
+Style/IfUnlessModifier:
+  Enabled: no
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/ExampleLength:
+  Enabled: no
+
+RSpec/MultipleExpectations:
+  Enabled: no
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: no
+
+RSpec/MessageSpies:
+  Enabled: no
+
+Metrics/BlockLength:
+  Enabled: no
+
+Metrics/MethodLength:
+  Enabled: no
+
+Metrics/AbcSize:
+  Enabled: no
+
+Metrics/ClassLength:
+  Enabled: no
+
+Metrics/ParameterLists:
+  Enabled: no
+
+Lint/UnusedMethodArgument:
+  Enabled: no
+
+Style/FrozenStringLiteralComment:
+  Enabled: yes
+  EnforcedStyle: always
+  Include:
+    - 'lib/**/*'
+
+Layout/LineLength:
+  Max: 120
+
+Style/SingleLineMethods:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-01-25 17:49:13 UTC using RuboCop version 1.25.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/CollectionCompact:
+  Exclude:
+    - 'lib/jaeger/tracer.rb'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jaeger-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Indrek Juhkam
+
+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.

data/Makefile

@@ -0,0 +1 @@
+-include crossdock/rules.mk

data/README.md

@@ -0,0 +1,210 @@
+Jaeger::Client
+================
+This gem is a basic fork of https://github.com/salemove/jaeger-client-ruby with the ruby version
+relaxed in the gemspec.  We are using it to hold us over as we upgrade to open telemetry.
+
+**This project is not actively maintained. Please consider using [OpenTelemetry](https://opentelemetry.io/)**
+
+OpenTracing Tracer implementation for Jaeger in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jaeger-client'
+```
+
+## Usage
+
+```ruby
+require 'jaeger/client'
+OpenTracing.global_tracer = Jaeger::Client.build(host: 'localhost', port: 6831, 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
+
+# don't kill the program too soon, allow time for the background reporter to send the traces
+sleep 2
+```
+
+See [opentracing-ruby](https://github.com/opentracing/opentracing-ruby) for more examples.
+
+### Reporters
+
+#### RemoteReporter (default)
+
+RemoteReporter buffers spans in memory and sends them out of process using Sender.
+
+There are two senders: `UdpSender` (default) and `HttpSender`.
+
+To use `HttpSender`:
+
+```ruby
+OpenTracing.global_tracer = Jaeger::Client.build(
+  service_name: 'service_name',
+  reporter: Jaeger::Reporters::RemoteReporter.new(
+    sender: Jaeger::HttpSender.new(
+      url: 'http://localhost:14268/api/traces',
+      headers: { 'key' => 'value' }, # headers key is optional
+      encoder: Jaeger::Encoders::ThriftEncoder.new(service_name: 'service_name')
+    ),
+    flush_interval: 10
+  )
+)
+```
+
+#### NullReporter
+
+NullReporter ignores all spans.
+
+```ruby
+OpenTracing.global_tracer = Jaeger::Client.build(
+  service_name: 'service_name',
+  reporter: Jaeger::Reporters::NullReporter.new
+)
+```
+
+#### LoggingReporter
+
+LoggingReporter prints some details about the span using `logger`. This is meant only for debugging. Do not parse and use this information for anything critical. The implemenation can change at any time.
+
+```ruby
+OpenTracing.global_tracer = Jaeger::Client.build(
+  service_name: 'service_name',
+  reporter: Jaeger::Reporters::LoggingReporter.new
+)
+```
+
+LoggingReporter can also use a custom logger. For this provide logger using `logger` keyword argument.
+
+### Samplers
+
+#### Const sampler
+
+`Const` sampler always makes the same decision for new traces depending on the initialization value. Set `sampler` to: `Jaeger::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). This can be enabled by setting `Jaeger::Samplers::Probabilistic.new(rate: 0.1)`
+
+#### RateLimiting sampler
+
+`RateLimiting` sampler samples at most `max_traces_per_second`. The distribution of sampled traces follows burstiness of the service, i.e. a service with uniformly distributed requests will have those requests sampled uniformly as well, but if requests are bursty, especially sub-second, then a number of sequential requests can be sampled each second.
+
+Set `sampler` to `Jaeger::Samplers::RateLimiting.new(max_traces_per_second: 100)`
+
+#### GuaranteedThroughputProbabilistic sampler
+
+`GuaranteedThroughputProbabilistic` is a sampler that guarantees a throughput by using a Probabilistic sampler and RateLimiting sampler The RateLimiting sampler is used to establish a lower_bound so that every operation is sampled at least once in the time interval defined by the lower_bound.
+
+Set `sampler` to `Jaeger::Samplers::GuaranteedThroughputProbabilistic.new(lower_bound: 10, rate: 0.001)`
+
+#### PerOperation sampler
+
+`PerOperation` sampler leverages both Probabilistic sampler and RateLimiting sampler via the GuaranteedThroughputProbabilistic sampler. This sampler keeps track of all operations and delegates calls the the respective GuaranteedThroughputProbabilistic sampler.
+
+Set `sampler` to
+```ruby
+  Jaeger::Samplers::PerOperation.new(
+    strategies: {
+      per_operation_strategies: [
+        { operation: 'GET /articles', probabilistic_sampling: { sampling_rate: 0.5 } },
+        { operation: 'POST /articles', probabilistic_sampling: { sampling_rate: 1.0 } }
+      ],
+      default_sampling_probability: 0.001,
+      default_lower_bound_traces_per_second: 1.0 / (10.0 * 60.0)
+    },
+    max_operations: 1000
+  )
+```
+
+#### RemoteControlled sampler
+
+`RemoteControlled` sampler is a sampler that is controller by jaeger agent. It starts out with `Probabilistic` sampler. It polls the jaeger-agent and changes sampling strategy accordingly. Set `sampler` to `Jaeger::Client::Samplers::RemoteControlled.new(service_name: 'service_name')`.
+
+RemoteControlled sampler options:
+
+| Param             | Required | Description |
+|-------------------|----------|-------------|
+| service_name      | x | name of the current service / application, same as given to Tracer |
+| sampler           |   | initial sampler to use prior to retrieving strategies from Agent |
+| refresh_interval  |   | interval in seconds before sampling strategy refreshes (0 to not refresh, defaults to 60) |
+| host              |   | host for jaeger-agent (defaults to 'localhost') |
+| port              |   | port for jaeger-agent for SamplingManager endpoint (defaults to 5778) |
+| logger            |   | logger for communication between jaeger-agent (default to $stdout logger) |
+
+### TraceContext compatible header propagation
+
+It is possible to use [W3C Trace Context](https://www.w3.org/TR/trace-context/#overview) headers to propagate the tracing information.
+
+To set it up you need to change FORMAT_RACK injector and extractor.
+
+```ruby
+OpenTracing.global_tracer = Jaeger::Client.build(
+  service_name: 'service_name',
+  injectors: {
+    OpenTracing::FORMAT_RACK => [Jaeger::Injectors::TraceContextRackCodec]
+  },
+  extractors: {
+    OpenTracing::FORMAT_RACK => [Jaeger::Extractors::TraceContextRackCodec]
+  }
+)
+```
+
+### Zipkin HTTP B3 compatible header propagation
+
+Jaeger Tracer supports Zipkin B3 Propagation HTTP headers, which are used by a lot of Zipkin tracers. This means that you can use Jaeger in conjunction with OpenZipkin tracers.
+
+To set it up you need to change FORMAT_RACK injector and extractor.
+
+```ruby
+OpenTracing.global_tracer = Jaeger::Client.build(
+  service_name: 'service_name',
+  injectors: {
+    OpenTracing::FORMAT_RACK => [Jaeger::Injectors::B3RackCodec]
+  },
+  extractors: {
+    OpenTracing::FORMAT_RACK => [Jaeger::Extractors::B3RackCodec]
+  }
+)
+```
+
+It's also possible to set up multiple injectors and extractors. Each injector will be called in sequence. Note that if multiple injectors are using the same keys then the values will be overwritten.
+
+If multiple extractors is used then the span context from the first match will be returned.
+
+### Process Tags
+
+Jaeger Tracer allows you to define process level tags. By default the tracer provides `jaeger.version`, `ip` and `hostname`. You may want to overwrite `ip` or `hostname` if the tracer cannot auto-detect them.
+
+```ruby
+OpenTracing.global_tracer = Jaeger::Client.build(
+  service_name: 'service_name',
+  tags: {
+    'hostname' => 'custom-hostname',
+    'custom_tag' => 'custom-tag-value'
+  }
+)
+```
+
+## 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/salemove/jaeger-client-ruby
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jaeger/client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/crossdock/Dockerfile

@@ -0,0 +1,31 @@
+FROM ruby:2.7-alpine
+
+ENV APP_HOME /app
+
+# git is required by bundler to run jaeger gem with local path
+RUN apk add --no-cache git
+
+# Add only files needed for installing gem dependencies. This allows us to
+# change other files without needing to install gems every time when building
+# the docker image.
+ADD Gemfile Gemfile.lock jaeger-client.gemspec $APP_HOME/
+ADD lib/jaeger/client/version.rb $APP_HOME/lib/jaeger/client/
+ADD crossdock/Gemfile crossdock/Gemfile.lock $APP_HOME/crossdock/
+
+RUN gem install bundler -v $(tail -n 1 $APP_HOME/Gemfile.lock | awk '{$1=$1};1')
+
+RUN apk add --no-cache --virtual .app-builddeps build-base \
+  && cd $APP_HOME && bundle install \
+  && cd $APP_HOME/crossdock && bundle install \
+  && apk del .app-builddeps
+
+ADD . $APP_HOME
+
+RUN chown -R nobody:nogroup $APP_HOME
+USER nobody
+
+WORKDIR $APP_HOME/crossdock
+
+CMD ["bundle", "exec", "./server"]
+
+EXPOSE 8080-8082

data/crossdock/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'jaeger-client', path: '../'
+gem 'rack'
+gem 'sinatra'
+gem 'webrick', '~> 1.7'

data/crossdock/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: ..
+  specs:
+    jaeger-client (1.2.0)
+      opentracing (~> 0.3)
+      thrift
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    opentracing (0.5.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    thrift (0.15.0)
+    tilt (2.0.10)
+    webrick (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jaeger-client!
+  rack
+  sinatra
+  webrick (~> 1.7)
+
+BUNDLED WITH
+   2.3.5

data/crossdock/docker-compose.yml

@@ -0,0 +1,68 @@
+version: '2'
+
+services:
+  crossdock:
+    image: crossdock/crossdock
+    links:
+      - test_driver
+      - go
+      - python
+      - java
+      - ruby
+    environment:
+      - WAIT_FOR=test_driver,go,python,java,ruby
+      - WAIT_FOR_TIMEOUT=60s
+
+      - CALL_TIMEOUT=60s
+
+      - AXIS_CLIENT=go
+
+      - AXIS_S1NAME=go,python,java,ruby
+      - AXIS_SAMPLED=true,false
+      - AXIS_S2NAME=go,python,java,ruby
+      - AXIS_S2TRANSPORT=http
+      - AXIS_S3NAME=go,python,java,ruby
+      - AXIS_S3TRANSPORT=http
+
+      - BEHAVIOR_TRACE=client,s1name,sampled,s2name,s2transport,s3name,s3transport
+
+      - AXIS_TESTDRIVER=test_driver
+      - AXIS_SERVICES=ruby
+
+      - BEHAVIOR_ENDTOEND=testdriver,services
+
+      - REPORT=compact
+  go:
+    image: jaegertracing/xdock-go
+    ports:
+      - "8080-8082"
+
+  java:
+    image: jaegertracing/xdock-java
+    depends_on:
+      - jaeger-agent
+    ports:
+      - "8080-8082"
+
+  python:
+    image: jaegertracing/xdock-py
+    depends_on:
+      - jaeger-agent
+    ports:
+      - "8080-8082"
+
+  ruby:
+    build:
+      context: ../.
+      dockerfile: crossdock/Dockerfile
+    ports:
+      - "8080-8082"
+
+  test_driver:
+    image: jaegertracing/test-driver
+    depends_on:
+      - jaeger-query
+      - jaeger-collector
+      - jaeger-agent
+    ports:
+      - "8080"

data/crossdock/jaeger-docker-compose.yml

@@ -0,0 +1,53 @@
+version: '2'
+
+services:
+    jaeger-collector:
+      image: jaegertracing/jaeger-collector
+      command: ["--es.num-shards=1", "--es.num-replicas=0", "--es.server-urls=http://elasticsearch:9200", "--collector.zipkin.host-port=:9411"]
+      ports:
+        - "14269"
+        - "14268:14268"
+        - "14250"
+        - "9411:9411"
+      environment:
+        - SPAN_STORAGE_TYPE=elasticsearch
+        - LOG_LEVEL=debug
+      restart: on-failure
+      depends_on:
+        - elasticsearch
+
+    jaeger-query:
+      image: jaegertracing/jaeger-query
+      command: ["--es.num-shards=1", "--es.num-replicas=0", "--es.server-urls=http://elasticsearch:9200"]
+      ports:
+        - "16686:16686"
+        - "16687"
+      environment:
+        - SPAN_STORAGE_TYPE=elasticsearch
+        - LOG_LEVEL=debug
+      restart: on-failure
+      depends_on:
+        - elasticsearch
+
+    jaeger-agent:
+      image: jaegertracing/jaeger-agent
+      command: ["--reporter.grpc.host-port=jaeger-collector:14250", "--reporter.grpc.retry.max=1000"]
+      ports:
+        - "5775:5775/udp"
+        - "6831:6831/udp"
+        - "6832:6832/udp"
+        - "5778:5778"
+      environment:
+        - LOG_LEVEL=debug
+      restart: on-failure
+      depends_on:
+        - jaeger-collector
+
+    elasticsearch:
+      image: docker.elastic.co/elasticsearch/elasticsearch-oss:6.8.3
+      environment:
+        - discovery.type=single-node
+      ports:
+        - "9200:9200/tcp"
+
+

data/crossdock/rules.mk

@@ -0,0 +1,35 @@
+XDOCK_YAML=crossdock/docker-compose.yml
+TRACETEST_THRIFT=idl/thrift/crossdock/tracetest.thrift
+JAEGER_COMPOSE_URL=https://raw.githubusercontent.com/jaegertracing/jaeger/master/crossdock/jaeger-docker-compose.yml
+XDOCK_JAEGER_YAML=crossdock/jaeger-docker-compose.yml
+
+.PHONY: clean-compile
+clean-compile:
+	find . -name '*.pyc' -exec rm {} \;
+
+.PHONY: docker
+docker: clean-compile crossdock-download-jaeger
+	docker build -f crossdock/Dockerfile -t jaeger-client-ruby .
+
+.PHONY: crossdock
+crossdock: ${TRACETEST_THRIFT} crossdock-download-jaeger
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) kill ruby
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) rm -f ruby
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) build ruby
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) run crossdock
+
+.PHONY: crossdock-fresh
+crossdock-fresh: ${TRACETEST_THRIFT} crossdock-download-jaeger
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) kill
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) rm --force
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) pull
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) build
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) run crossdock
+
+.PHONY: crossdock-logs crossdock-download-jaeger
+crossdock-logs:
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) logs
+
+.PHONY: crossdock-download-jaeger
+crossdock-download-jaeger:
+	curl -o $(XDOCK_JAEGER_YAML) $(JAEGER_COMPOSE_URL)