zipkin 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +12 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +41 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/zipkin/carrier.rb +25 -0
- data/lib/zipkin/span.rb +60 -0
- data/lib/zipkin/span_context.rb +26 -0
- data/lib/zipkin/trace_id.rb +9 -0
- data/lib/zipkin/tracer.rb +71 -0
- data/lib/zipkin.rb +8 -0
- data/zipkin.gemspec +27 -0
- metadata +116 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 8361e78533130479672a85ad8d5273035cdd261d
|
4
|
+
data.tar.gz: 21ec14ab24345d5f4a320efa33570df8bee51b4a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b63f0b37631dea5cd999f24c83ce688946244bd6b5e5aebf1201d75ea3e3d050a3f1daa0d46d8253ed2c4e314c9c1aa98707e32b03b26bf0a17cf4fe903c477f
|
7
|
+
data.tar.gz: ca8ae8cfff2d1b302967652e57c7c1d0039d035c3e006a8e004e30eef3505c4409407c224af3c9f992567106b147570eea2a7b092e0ef8855edf8817a1ee6198
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 Indrek Juhkam
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
# Zipkin
|
2
|
+
|
3
|
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zipkin`. To experiment with that code, run `bin/console` for an interactive prompt.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'zipkin'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install zipkin
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
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.
|
30
|
+
|
31
|
+
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).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/Indrek Juhkam/zipkin.
|
36
|
+
|
37
|
+
|
38
|
+
## License
|
39
|
+
|
40
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
41
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "zipkin"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
module Zipkin
|
2
|
+
# Carriers are used for inject and extract operations. A carrier should be a
|
3
|
+
# Hash or hash-like object. At a minimum, it should implement `[]`, `[]=`, and
|
4
|
+
# `each` shown here.
|
5
|
+
class Carrier
|
6
|
+
# [] retrieves a value by the given key
|
7
|
+
# @param key [String] key to retrieve the value
|
8
|
+
# @return [String] the desired value
|
9
|
+
def [](key)
|
10
|
+
end
|
11
|
+
|
12
|
+
# []= sets the value for the given key
|
13
|
+
# @param key [String] key to set
|
14
|
+
# @param value [String] value to set
|
15
|
+
def []=(key, value)
|
16
|
+
end
|
17
|
+
|
18
|
+
# each iterates over every key-value pair in the carrier
|
19
|
+
# @yield [key, value]
|
20
|
+
# @yieldparam key [String] the key of the tuple
|
21
|
+
# @yieldparam value [String] the value of the tuple
|
22
|
+
def each(&block)
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
data/lib/zipkin/span.rb
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
module Zipkin
|
2
|
+
class Span
|
3
|
+
attr_accessor :operation_name
|
4
|
+
|
5
|
+
attr_reader :context
|
6
|
+
|
7
|
+
# Creates a new {Span}
|
8
|
+
#
|
9
|
+
# @param tracer [Tracer] the tracer that created this span
|
10
|
+
# @param context [SpanContext] the context of the span
|
11
|
+
#
|
12
|
+
# @return [Span] a new Span
|
13
|
+
def initialize(tracer, context)
|
14
|
+
@tracer = tracer
|
15
|
+
@context = context
|
16
|
+
end
|
17
|
+
|
18
|
+
# Set a tag value on this span
|
19
|
+
#
|
20
|
+
# @param key [String] the key of the tag
|
21
|
+
# @param value [String, Numeric, Boolean] the value of the tag. If it's not
|
22
|
+
# a String, Numeric, or Boolean it will be encoded with to_s
|
23
|
+
def set_tag(key, value)
|
24
|
+
self
|
25
|
+
end
|
26
|
+
|
27
|
+
# Set a baggage item on the span
|
28
|
+
#
|
29
|
+
# @param key [String] the key of the baggage item
|
30
|
+
# @param value [String] the value of the baggage item
|
31
|
+
def set_baggage_item(key, value)
|
32
|
+
self
|
33
|
+
end
|
34
|
+
|
35
|
+
# Get a baggage item
|
36
|
+
#
|
37
|
+
# @param key [String] the key of the baggage item
|
38
|
+
#
|
39
|
+
# @return Value of the baggage item
|
40
|
+
def get_baggage_item(key)
|
41
|
+
nil
|
42
|
+
end
|
43
|
+
|
44
|
+
# Add a log entry to this span
|
45
|
+
#
|
46
|
+
# @param event [String] event name for the log
|
47
|
+
# @param timestamp [Time] time of the log
|
48
|
+
# @param fields [Hash] Additional information to log
|
49
|
+
def log(event: nil, timestamp: Time.now, **fields)
|
50
|
+
nil
|
51
|
+
end
|
52
|
+
|
53
|
+
# Finish the {Span}
|
54
|
+
#
|
55
|
+
# @param end_time [Time] custom end time, if not now
|
56
|
+
def finish(end_time: Time.now)
|
57
|
+
nil
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
module Zipkin
|
2
|
+
# SpanContext holds the data for a span that gets inherited to child spans
|
3
|
+
class SpanContext
|
4
|
+
def self.create_parent_context
|
5
|
+
span_id = TraceId.generate
|
6
|
+
trace_id = span_id
|
7
|
+
new(span_id: span_id, trace_id: trace_id)
|
8
|
+
end
|
9
|
+
|
10
|
+
def self.create_from_parent(parent_span)
|
11
|
+
trace_id = parent_span.context.trace_id
|
12
|
+
parent_id = parent_span.context.span_id
|
13
|
+
span_id = TraceId.generate
|
14
|
+
new(span_id: span_id, parent_id: parent_id, trace_id: trace_id)
|
15
|
+
end
|
16
|
+
|
17
|
+
attr_reader :span_id, :parent_id, :trace_id, :baggage
|
18
|
+
|
19
|
+
def initialize(span_id:, parent_id: nil, trace_id:, baggage: {})
|
20
|
+
@span_id = span_id
|
21
|
+
@parent_id = parent_id
|
22
|
+
@trace_id = trace_id
|
23
|
+
@baggage = baggage
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,71 @@
|
|
1
|
+
module Zipkin
|
2
|
+
class Tracer
|
3
|
+
def self.build(host:, port:, service_name:)
|
4
|
+
end
|
5
|
+
|
6
|
+
def initialize(client)
|
7
|
+
@client = client
|
8
|
+
end
|
9
|
+
|
10
|
+
# Start a new span
|
11
|
+
#
|
12
|
+
# @param operation_name [String]
|
13
|
+
# The operation name for the Span
|
14
|
+
# @param child_of [SpanContext]
|
15
|
+
# SpanContext that acts as a parent to the newly-started Span. If a Span
|
16
|
+
# instance is provided, its #context is automatically substituted.
|
17
|
+
# @param start_time [Time]
|
18
|
+
# The time when the Span started, if not now
|
19
|
+
# @param tags [Hash]
|
20
|
+
# Tags to assign to the Span at start time
|
21
|
+
#
|
22
|
+
# @return [Span]
|
23
|
+
# The newly-started Span
|
24
|
+
def start_span(operation_name, child_of: nil, start_time: Time.now, tags: nil)
|
25
|
+
context =
|
26
|
+
if child_of
|
27
|
+
SpanContext.create_from_parent(child_of)
|
28
|
+
else
|
29
|
+
SpanContext.create_parent_context
|
30
|
+
end
|
31
|
+
span = Span.new(self, context)
|
32
|
+
span.operation_name = operation_name
|
33
|
+
span
|
34
|
+
end
|
35
|
+
|
36
|
+
# Inject a SpanContext into the given carrier
|
37
|
+
#
|
38
|
+
# @param span_context [SpanContext]
|
39
|
+
# @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
|
40
|
+
#
|
41
|
+
# @param carrier [Carrier]
|
42
|
+
# A carrier object of the type dictated by the specified `format`
|
43
|
+
def inject(span_context, format, carrier)
|
44
|
+
case format
|
45
|
+
when OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK
|
46
|
+
return nil
|
47
|
+
else
|
48
|
+
warn 'Unknown inject format'
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
# Extract a SpanContext in the given format from the given carrier.
|
53
|
+
#
|
54
|
+
# @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
|
55
|
+
# @param carrier [Carrier]
|
56
|
+
# A carrier object of the type dictated by the specified `format`
|
57
|
+
#
|
58
|
+
# @return [SpanContext]
|
59
|
+
# the extracted SpanContext or nil if none could be found
|
60
|
+
def extract(format, carrier)
|
61
|
+
case format
|
62
|
+
when OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK
|
63
|
+
return SpanContext::NOOP_INSTANCE
|
64
|
+
else
|
65
|
+
warn 'Unknown extract format'
|
66
|
+
nil
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
end
|
71
|
+
end
|
data/lib/zipkin.rb
ADDED
data/zipkin.gemspec
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = 'zipkin'
|
7
|
+
spec.version = '0.1.0'
|
8
|
+
spec.authors = ['SaleMove TechMovers']
|
9
|
+
spec.email = ['techmovers@salemove.com']
|
10
|
+
|
11
|
+
spec.summary = %q{OpenTracing Tracer implementation for Zipkin in Ruby}
|
12
|
+
spec.description = %q{}
|
13
|
+
spec.homepage = ''
|
14
|
+
spec.license = 'MIT'
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
17
|
+
f.match(%r{^(test|spec|features)/})
|
18
|
+
end
|
19
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
20
|
+
spec.require_paths = ['lib']
|
21
|
+
|
22
|
+
spec.add_development_dependency 'bundler', '~> 1.14'
|
23
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
24
|
+
spec.add_development_dependency 'rspec', '~> 3.0'
|
25
|
+
|
26
|
+
spec.add_dependency 'opentracing', '~> 0.3'
|
27
|
+
end
|
metadata
ADDED
@@ -0,0 +1,116 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: zipkin
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- SaleMove TechMovers
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-03-04 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.14'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.14'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: opentracing
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0.3'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0.3'
|
69
|
+
description: ''
|
70
|
+
email:
|
71
|
+
- techmovers@salemove.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- ".travis.yml"
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE.txt
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- bin/console
|
84
|
+
- bin/setup
|
85
|
+
- lib/zipkin.rb
|
86
|
+
- lib/zipkin/carrier.rb
|
87
|
+
- lib/zipkin/span.rb
|
88
|
+
- lib/zipkin/span_context.rb
|
89
|
+
- lib/zipkin/trace_id.rb
|
90
|
+
- lib/zipkin/tracer.rb
|
91
|
+
- zipkin.gemspec
|
92
|
+
homepage: ''
|
93
|
+
licenses:
|
94
|
+
- MIT
|
95
|
+
metadata: {}
|
96
|
+
post_install_message:
|
97
|
+
rdoc_options: []
|
98
|
+
require_paths:
|
99
|
+
- lib
|
100
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
101
|
+
requirements:
|
102
|
+
- - ">="
|
103
|
+
- !ruby/object:Gem::Version
|
104
|
+
version: '0'
|
105
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '0'
|
110
|
+
requirements: []
|
111
|
+
rubyforge_project:
|
112
|
+
rubygems_version: 2.6.8
|
113
|
+
signing_key:
|
114
|
+
specification_version: 4
|
115
|
+
summary: OpenTracing Tracer implementation for Zipkin in Ruby
|
116
|
+
test_files: []
|