boost-jaeger-client 0.7.0

data/thrift/gen-rb/jaeger/thrift/zipkin/zipkin_collector.rb

@@ -0,0 +1,84 @@
+#
+# Autogenerated by Thrift Compiler (0.10.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+require 'jaeger/thrift/zipkin/zipkincore_types'
+
+module Jaeger
+  module Thrift
+    module Zipkin
+      module ZipkinCollector
+        class Client
+          include ::Thrift::Client
+
+          def submitZipkinBatch(spans)
+            send_submitZipkinBatch(spans)
+            return recv_submitZipkinBatch()
+          end
+
+          def send_submitZipkinBatch(spans)
+            send_message('submitZipkinBatch', SubmitZipkinBatch_args, :spans => spans)
+          end
+
+          def recv_submitZipkinBatch()
+            result = receive_message(SubmitZipkinBatch_result)
+            return result.success unless result.success.nil?
+            raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'submitZipkinBatch failed: unknown result')
+          end
+
+        end
+
+        class Processor
+          include ::Thrift::Processor
+
+          def process_submitZipkinBatch(seqid, iprot, oprot)
+            args = read_args(iprot, SubmitZipkinBatch_args)
+            result = SubmitZipkinBatch_result.new()
+            result.success = @handler.submitZipkinBatch(args.spans)
+            write_result(result, oprot, 'submitZipkinBatch', seqid)
+          end
+
+        end
+
+        # HELPER FUNCTIONS AND STRUCTURES
+
+        class SubmitZipkinBatch_args
+          include ::Thrift::Struct, ::Thrift::Struct_Union
+          SPANS = 1
+
+          FIELDS = {
+            SPANS => {:type => ::Thrift::Types::LIST, :name => 'spans', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Jaeger::Thrift::Zipkin::Span}}
+          }
+
+          def struct_fields; FIELDS; end
+
+          def validate
+          end
+
+          ::Thrift::Struct.generate_accessors self
+        end
+
+        class SubmitZipkinBatch_result
+          include ::Thrift::Struct, ::Thrift::Struct_Union
+          SUCCESS = 0
+
+          FIELDS = {
+            SUCCESS => {:type => ::Thrift::Types::LIST, :name => 'success', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Jaeger::Thrift::Zipkin::Response}}
+          }
+
+          def struct_fields; FIELDS; end
+
+          def validate
+          end
+
+          ::Thrift::Struct.generate_accessors self
+        end
+
+      end
+
+    end
+  end
+end

data/thrift/gen-rb/jaeger/thrift/zipkin/zipkincore_constants.rb

@@ -0,0 +1,41 @@
+#
+# Autogenerated by Thrift Compiler (0.10.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+require 'jaeger/thrift/zipkin/zipkincore_types'
+
+module Jaeger
+  module Thrift
+    module Zipkin
+      CLIENT_SEND = %q"cs"
+
+      CLIENT_RECV = %q"cr"
+
+      SERVER_SEND = %q"ss"
+
+      SERVER_RECV = %q"sr"
+
+      WIRE_SEND = %q"ws"
+
+      WIRE_RECV = %q"wr"
+
+      CLIENT_SEND_FRAGMENT = %q"csf"
+
+      CLIENT_RECV_FRAGMENT = %q"crf"
+
+      SERVER_SEND_FRAGMENT = %q"ssf"
+
+      SERVER_RECV_FRAGMENT = %q"srf"
+
+      LOCAL_COMPONENT = %q"lc"
+
+      CLIENT_ADDR = %q"ca"
+
+      SERVER_ADDR = %q"sa"
+
+    end
+  end
+end

data/thrift/gen-rb/jaeger/thrift/zipkin/zipkincore_types.rb

@@ -0,0 +1,220 @@
+#
+# Autogenerated by Thrift Compiler (0.10.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+
+module Jaeger
+  module Thrift
+    module Zipkin
+      module AnnotationType
+        BOOL = 0
+        BYTES = 1
+        I16 = 2
+        I32 = 3
+        I64 = 4
+        DOUBLE = 5
+        STRING = 6
+        VALUE_MAP = {0 => "BOOL", 1 => "BYTES", 2 => "I16", 3 => "I32", 4 => "I64", 5 => "DOUBLE", 6 => "STRING"}
+        VALID_VALUES = Set.new([BOOL, BYTES, I16, I32, I64, DOUBLE, STRING]).freeze
+      end
+
+      # Indicates the network context of a service recording an annotation with two
+# exceptions.
+# 
+# When a BinaryAnnotation, and key is CLIENT_ADDR or SERVER_ADDR,
+# the endpoint indicates the source or destination of an RPC. This exception
+# allows zipkin to display network context of uninstrumented services, or
+# clients such as web browsers.
+      class Endpoint
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        IPV4 = 1
+        PORT = 2
+        SERVICE_NAME = 3
+
+        FIELDS = {
+          # IPv4 host address packed into 4 bytes.
+# 
+# Ex for the ip 1.2.3.4, it would be (1 << 24) | (2 << 16) | (3 << 8) | 4
+          IPV4 => {:type => ::Thrift::Types::I32, :name => 'ipv4'},
+          # IPv4 port
+# 
+# Note: this is to be treated as an unsigned integer, so watch for negatives.
+# 
+# Conventionally, when the port isn't known, port = 0.
+          PORT => {:type => ::Thrift::Types::I16, :name => 'port'},
+          # Service name in lowercase, such as "memcache" or "zipkin-web"
+# 
+# Conventionally, when the service name isn't known, service_name = "unknown".
+          SERVICE_NAME => {:type => ::Thrift::Types::STRING, :name => 'service_name'}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      # An annotation is similar to a log statement. It includes a host field which
+# allows these events to be attributed properly, and also aggregatable.
+      class Annotation
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        TIMESTAMP = 1
+        VALUE = 2
+        HOST = 3
+
+        FIELDS = {
+          # Microseconds from epoch.
+# 
+# This value should use the most precise value possible. For example,
+# gettimeofday or syncing nanoTime against a tick of currentTimeMillis.
+          TIMESTAMP => {:type => ::Thrift::Types::I64, :name => 'timestamp'},
+          VALUE => {:type => ::Thrift::Types::STRING, :name => 'value'},
+          # Always the host that recorded the event. By specifying the host you allow
+# rollup of all events (such as client requests to a service) by IP address.
+          HOST => {:type => ::Thrift::Types::STRUCT, :name => 'host', :class => ::Jaeger::Thrift::Zipkin::Endpoint, :optional => true}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      # Binary annotations are tags applied to a Span to give it context. For
+# example, a binary annotation of "http.uri" could the path to a resource in a
+# RPC call.
+# 
+# Binary annotations of type STRING are always queryable, though more a
+# historical implementation detail than a structural concern.
+# 
+# Binary annotations can repeat, and vary on the host. Similar to Annotation,
+# the host indicates who logged the event. This allows you to tell the
+# difference between the client and server side of the same key. For example,
+# the key "http.uri" might be different on the client and server side due to
+# rewriting, like "/api/v1/myresource" vs "/myresource. Via the host field,
+# you can see the different points of view, which often help in debugging.
+      class BinaryAnnotation
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        KEY = 1
+        VALUE = 2
+        ANNOTATION_TYPE = 3
+        HOST = 4
+
+        FIELDS = {
+          KEY => {:type => ::Thrift::Types::STRING, :name => 'key'},
+          VALUE => {:type => ::Thrift::Types::STRING, :name => 'value', :binary => true},
+          ANNOTATION_TYPE => {:type => ::Thrift::Types::I32, :name => 'annotation_type', :enum_class => ::Jaeger::Thrift::Zipkin::AnnotationType},
+          # The host that recorded tag, which allows you to differentiate between
+# multiple tags with the same key. There are two exceptions to this.
+# 
+# When the key is CLIENT_ADDR or SERVER_ADDR, host indicates the source or
+# destination of an RPC. This exception allows zipkin to display network
+# context of uninstrumented services, or clients such as web browsers.
+          HOST => {:type => ::Thrift::Types::STRUCT, :name => 'host', :class => ::Jaeger::Thrift::Zipkin::Endpoint, :optional => true}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+          unless @annotation_type.nil? || ::Jaeger::Thrift::Zipkin::AnnotationType::VALID_VALUES.include?(@annotation_type)
+            raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Invalid value of field annotation_type!')
+          end
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      # A trace is a series of spans (often RPC calls) which form a latency tree.
+# 
+# The root span is where trace_id = id and parent_id = Nil. The root span is
+# usually the longest interval in the trace, starting with a SERVER_RECV
+# annotation and ending with a SERVER_SEND.
+      class Span
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        TRACE_ID = 1
+        NAME = 3
+        ID = 4
+        PARENT_ID = 5
+        ANNOTATIONS = 6
+        BINARY_ANNOTATIONS = 8
+        DEBUG = 9
+        TIMESTAMP = 10
+        DURATION = 11
+
+        FIELDS = {
+          TRACE_ID => {:type => ::Thrift::Types::I64, :name => 'trace_id'},
+          # Span name in lowercase, rpc method for example
+# 
+# Conventionally, when the span name isn't known, name = "unknown".
+          NAME => {:type => ::Thrift::Types::STRING, :name => 'name'},
+          ID => {:type => ::Thrift::Types::I64, :name => 'id'},
+          PARENT_ID => {:type => ::Thrift::Types::I64, :name => 'parent_id', :optional => true},
+          ANNOTATIONS => {:type => ::Thrift::Types::LIST, :name => 'annotations', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Jaeger::Thrift::Zipkin::Annotation}},
+          BINARY_ANNOTATIONS => {:type => ::Thrift::Types::LIST, :name => 'binary_annotations', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Jaeger::Thrift::Zipkin::BinaryAnnotation}},
+          DEBUG => {:type => ::Thrift::Types::BOOL, :name => 'debug', :default => false, :optional => true},
+          # Microseconds from epoch of the creation of this span.
+# 
+# This value should be set directly by instrumentation, using the most
+# precise value possible. For example, gettimeofday or syncing nanoTime
+# against a tick of currentTimeMillis.
+# 
+# For compatibilty with instrumentation that precede this field, collectors
+# or span stores can derive this via Annotation.timestamp.
+# For example, SERVER_RECV.timestamp or CLIENT_SEND.timestamp.
+# 
+# This field is optional for compatibility with old data: first-party span
+# stores are expected to support this at time of introduction.
+          TIMESTAMP => {:type => ::Thrift::Types::I64, :name => 'timestamp', :optional => true},
+          # Measurement of duration in microseconds, used to support queries.
+# 
+# This value should be set directly, where possible. Doing so encourages
+# precise measurement decoupled from problems of clocks, such as skew or NTP
+# updates causing time to move backwards.
+# 
+# For compatibilty with instrumentation that precede this field, collectors
+# or span stores can derive this by subtracting Annotation.timestamp.
+# For example, SERVER_SEND.timestamp - SERVER_RECV.timestamp.
+# 
+# If this field is persisted as unset, zipkin will continue to work, except
+# duration query support will be implementation-specific. Similarly, setting
+# this field non-atomically is implementation-specific.
+# 
+# This field is i64 vs i32 to support spans longer than 35 minutes.
+          DURATION => {:type => ::Thrift::Types::I64, :name => 'duration', :optional => true}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class Response
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        OK = 1
+
+        FIELDS = {
+          OK => {:type => ::Thrift::Types::BOOL, :name => 'ok'}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+          raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field ok is unset!') if @ok.nil?
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+    end
+  end
+end

data/thrift/jaeger.thrift

@@ -0,0 +1,88 @@
+# Copyright (c) 2016 Uber Technologies, Inc.
+#
+# 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.
+
+namespace java com.uber.jaeger.thriftjava
+namespace rb Jaeger.Thrift
+
+# TagType denotes the type of a Tag's value.
+enum TagType { STRING, DOUBLE, BOOL, LONG, BINARY }
+
+# Tag is a basic strongly typed key/value pair. It has been flattened to reduce the use of pointers in golang
+struct Tag {
+  1: required string  key
+  2: required TagType vType
+  3: optional string  vStr
+  4: optional double  vDouble
+  5: optional bool    vBool
+  6: optional i64     vLong
+  7: optional binary  vBinary
+}
+
+# Log is a timed even with an arbitrary set of tags.
+struct Log {
+  1: required i64       timestamp
+  2: required list<Tag> fields
+}
+
+enum SpanRefType { CHILD_OF, FOLLOWS_FROM }
+
+# SpanRef describes causal relationship of the current span to another span (e.g. 'child-of')
+struct SpanRef {
+  1: required SpanRefType refType
+  2: required i64         traceIdLow
+  3: required i64         traceIdHigh
+  4: required i64         spanId
+}
+
+# Span represents a named unit of work performed by a service.
+struct Span {
+  1:  required i64           traceIdLow   # the least significant 64 bits of a traceID
+  2:  required i64           traceIdHigh  # the most significant 64 bits of a traceID; 0 when only 64bit IDs are used
+  3:  required i64           spanId       # unique span id (only unique within a given trace)
+  4:  required i64           parentSpanId # since nearly all spans will have parents spans, CHILD_OF refs do not have to be explicit
+  5:  required string        operationName
+  6:  optional list<SpanRef> references   # causal references to other spans
+  7:  required i32           flags        # tbd
+  8:  required i64           startTime
+  9:  required i64           duration
+  10: optional list<Tag>     tags
+  11: optional list<Log>     logs
+}
+
+# Process describes the traced process/service that emits spans.
+struct Process {
+  1: required string    serviceName
+  2: optional list<Tag> tags
+}
+
+# Batch is a collection of spans reported out of process.
+struct Batch {
+  1: required Process    process
+  2: required list<Span> spans
+}
+
+# BatchSubmitResponse is the response on submitting a batch. 
+struct BatchSubmitResponse {
+    1: required bool ok   # The Collector's client is expected to only log (or emit a counter) when not ok equals false
+}
+
+service Collector  {
+    list<BatchSubmitResponse> submitBatches(1: list<Batch> batches)
+}