lookout-zipkin-tracer 0.4.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d590ed9849cf8a45bc1346e7be7f14de75257715
+  data.tar.gz: a81d55e21d250d3fc2470676ef45290a94e2d342
+SHA512:
+  metadata.gz: 4491283ce8e1d5ec5d7cb4bb7008b38246df809ebe1ec6efc4df8091adfc70386c7189547ee6c2b41a545f49806df764deb84f91df3427f3033f41efcb02a9cc
+  data.tar.gz: b37e411569e345294bdabf78be543de197707b3aacd8871b328736a5df48e1241506aa5cc8868a7dc582fb6afd39d2e3a269c72c85b5c1c0e77269421b07cc38

data/lib/zipkin-tracer/careless_scribe.rb

@@ -0,0 +1,35 @@
+# Copyright 2012 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.
+
+class CarelessScribe
+  def initialize(scribe)
+    @scribe = scribe
+  end
+
+  def log(*args)
+    @scribe.log(*args)
+  rescue ThriftClient::NoServersAvailable, Thrift::Exception
+    # I couldn't care less
+  end
+
+  def batch(&block)
+    @scribe.batch(&block)
+  rescue ThriftClient::NoServersAvailable, Thrift::Exception
+    # I couldn't care less
+  end
+
+  def method_missing(name, *args)
+    @scribe.send(name, *args)
+  end
+end

data/lib/zipkin-tracer/version.rb

@@ -0,0 +1,17 @@
+# Copyright 2012 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.
+module ZipkinTracer
+  VERSION = "0.4.0"
+end
+

data/lib/zipkin-tracer/zipkin_kafka_tracer.rb

@@ -0,0 +1,65 @@
+require 'finagle-thrift'
+require 'finagle-thrift/tracer'
+require 'hermann/producer'
+require 'hermann/discovery/zookeeper'
+
+module Trace
+  class ZipkinKafkaTracer < Tracer
+    TRACER_CATEGORY = "zipkin".freeze
+    DEFAULT_KAFKA_TOPIC = "zipkin_kafka".freeze
+
+    def initialize(opts={})
+      @logger = opts[:logger]
+      @topic  = opts[:topic] || DEFAULT_KAFKA_TOPIC
+      reset
+    end
+
+    # need to connect after initialization
+    def connect(zookeepers)
+      broker_ids = Hermann::Discovery::Zookeeper.new(zookeepers).get_brokers
+      @producer  = Hermann::Producer.new(nil, broker_ids)
+    end
+
+    def record(id, annotation)
+      return unless id.sampled?
+      span = get_span_for_id(id)
+
+      case annotation
+      when BinaryAnnotation
+        span.binary_annotations << annotation
+      when Annotation
+        span.annotations << annotation
+      end
+
+      flush!
+    end
+
+    def set_rpc_name(id, name)
+      return unless id.sampled?
+      span = get_span_for_id(id)
+      span.name = name.to_s
+    end
+
+    private
+      def reset
+        @spans = {}
+      end
+
+      def get_span_for_id(id)
+        key = id.span_id.to_s
+        @spans[key] ||= begin
+          Span.new("", id)
+        end
+      end
+
+      def flush!
+        messages = @spans.values.map do |span|
+          buf = ''
+          trans = Thrift::MemoryBufferTransport.new(buf)
+          oprot = Thrift::BinaryProtocol.new(trans)
+          span.to_thrift.write(oprot)
+          @producer.push(buf, :topic => @topic).value!
+        end
+      end
+  end
+end

data/lib/zipkin-tracer.rb

@@ -0,0 +1,111 @@
+# Copyright 2012 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.
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+require 'scribe'
+
+require 'zipkin-tracer/careless_scribe'
+require 'zipkin-tracer/zipkin_kafka_tracer'
+
+module ZipkinTracer extend self
+
+  class RackHandler
+    B3_REQUIRED_HEADERS = %w[HTTP_X_B3_TRACEID HTTP_X_B3_PARENTSPANID HTTP_X_B3_SPANID HTTP_X_B3_SAMPLED]
+    B3_OPT_HEADERS = %w[HTTP_X_B3_FLAGS]
+
+    def initialize(app, config=nil)
+      @app = app
+      @lock = Mutex.new
+
+      config ||= app.config.zipkin_tracer # if not specified, try on app (e.g. Rails 3+)
+      @service_name = config[:service_name]
+      @service_port = config[:service_port]
+
+      if config[:scribe_server]
+        scribe = config[:scribe_server] ? Scribe.new(config[:scribe_server]) : Scribe.new()
+        careless_scribe = CarelessScribe.new(scribe)
+        scribe_max_buffer = config[:scribe_max_buffer] ? config[:scribe_max_buffer] : 10
+        ::Trace.tracer = ::Trace::ZipkinTracer.new(careless_scribe, scribe_max_buffer)
+      elsif config[:zookeeper]
+        ::Trace.tracer = ::Trace::ZipkinKafkaTracer.new(config[:zookeeper])
+      end
+
+      @sample_rate = config[:sample_rate] ? config[:sample_rate] : 0.1
+
+      @annotate_plugin = config[:annotate_plugin]     # call for trace annotation
+      @filter_plugin = config[:filter_plugin]         # skip tracing if returns false
+      @whitelist_plugin = config[:whitelist_plugin]   # force sampling if returns true
+
+
+    end
+
+    def call(env)
+      # skip certain requests
+      return @app.call(env) if filtered?(env)
+
+      ::Trace.default_endpoint = ::Trace.default_endpoint.with_service_name(@service_name).with_port(@service_port)
+      ::Trace.sample_rate=(@sample_rate)
+      whitelisted = force_sample?(env)
+      id = get_or_create_trace_id(env, whitelisted) # note that this depends on the sample rate being set
+      tracing_filter(id, env, whitelisted) { @app.call(env) }
+    end
+
+    private
+    def annotate(env, status, response_headers, response_body)
+      @annotate_plugin.call(env, status, response_headers, response_body) if @annotate_plugin
+    end
+
+    def filtered?(env)
+      @filter_plugin && !@filter_plugin.call(env)
+    end
+
+    def force_sample?(env)
+      @whitelist_plugin && @whitelist_plugin.call(env)
+    end
+
+    def tracing_filter(trace_id, env, whitelisted=false)
+      @lock.synchronize do
+        ::Trace.push(trace_id)
+        ::Trace.set_rpc_name(env["REQUEST_METHOD"]) # get/post and all that jazz
+        ::Trace.record(::Trace::BinaryAnnotation.new("http.uri", env["PATH_INFO"], "STRING", ::Trace.default_endpoint))
+        ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_RECV, ::Trace.default_endpoint))
+        ::Trace.record(::Trace::Annotation.new('whitelisted', ::Trace.default_endpoint)) if whitelisted
+      end
+      status, headers, body = yield if block_given?
+    ensure
+      @lock.synchronize do
+        ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::SERVER_SEND, ::Trace.default_endpoint))
+        annotate(env, status, headers, body)
+        ::Trace.pop
+      end
+    end
+
+    private
+    def get_or_create_trace_id(env, whitelisted, default_flags = ::Trace::Flags::EMPTY)
+      trace_parameters = if B3_REQUIRED_HEADERS.all? { |key| env.has_key?(key) }
+                           env.values_at(*B3_REQUIRED_HEADERS)
+                         else
+                           new_id = Trace.generate_id
+                           [new_id, nil, new_id, ("true" if whitelisted || Trace.should_sample?)]
+                         end
+      trace_parameters[3] = (trace_parameters[3] == "true")
+
+      trace_parameters += env.values_at(*B3_OPT_HEADERS) # always check flags
+      trace_parameters[4] = (trace_parameters[4] || default_flags).to_i
+
+      Trace::TraceId.new(*trace_parameters)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: lookout-zipkin-tracer
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: java
+authors:
+- Ariel Salomon, Franklin Hu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: finagle-thrift
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: scribe
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rack
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: hermann
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.20.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.20.1
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: Adds tracing instrumentation for ruby applications
+email:
+- ariel@lookout.com, franklin@twitter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zipkin-tracer.rb
+- lib/zipkin-tracer/careless_scribe.rb
+- lib/zipkin-tracer/version.rb
+- lib/zipkin-tracer/zipkin_kafka_tracer.rb
+homepage: https://github.com/lookout/zipkin
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: Ruby tracing via Zipkin
+test_files: []