spanmanager 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +12 -0
- data/.rspec +2 -0
- data/.travis.yml +6 -0
- data/Gemfile +10 -0
- data/LICENSE +201 -0
- data/README.md +87 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/spanmanager/managed_span.rb +41 -0
- data/lib/spanmanager/managed_span_source.rb +28 -0
- data/lib/spanmanager/managed_span_sources/thread_local_managed_span_source.rb +38 -0
- data/lib/spanmanager/tracer.rb +42 -0
- data/lib/spanmanager/version.rb +3 -0
- data/lib/spanmanager.rb +10 -0
- data/spanmanager.gemspec +31 -0
- metadata +143 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b592565ae3373476590bc5f750dfc9dda88dce54
|
4
|
+
data.tar.gz: f64cbde23b1b36fb99956267f6467d3f995f2038
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7e9d0bc43d2ef85c0a09c9b576e0f535248bf728d654839968c5e060626ce7aaa345682dd6c8d6c5bafdddc1b28c321d95ccd1b8b3889eebba85291e26332d3c
|
7
|
+
data.tar.gz: 57da76e4b9b9705632314cea9aede17fde808c40f62ca345898ec1ac60f4668e6fa7988deb7fcd6a759c25328d4fb1bc835f8f4856e0d7e404db967d9423087a
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,87 @@
|
|
1
|
+
[![Build Status](https://travis-ci.org/iaintshine/ruby-spanmanager.svg?branch=master)](https://travis-ci.org/iaintshine/ruby-spanmanager)
|
2
|
+
|
3
|
+
# SpanManager
|
4
|
+
|
5
|
+
Current span management for OpenTracing in Ruby.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'spanmanager'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install spanmanager
|
22
|
+
|
23
|
+
|
24
|
+
## ManagedSpanSource
|
25
|
+
|
26
|
+
`ManagedSpanSource` is a pluggable class that keeps track of the current active span. It relieves application developers from passing the current span around through their code. Application developers won't need to interact with a `ManagedSpanSource` reference directly, only implicitly through `SpanManager::Tracer`.
|
27
|
+
|
28
|
+
`ManagedSpanSource` provides the following methods:
|
29
|
+
|
30
|
+
1. `make_active(span)` wraps and makes the given span active.
|
31
|
+
2. `active_span` returns the current active span.
|
32
|
+
3. `clear` unconditionally cleans up all manages spans.
|
33
|
+
|
34
|
+
## ThreadLocalManagedSpanSource
|
35
|
+
|
36
|
+
`ThreadLocalManagedSpanSource` is an actual implementation of `ManagedSpanSource`. Allows an application access and manipulation of the current span state on per thread basis. Maintains a stack-like thread-local storage of managed spans.
|
37
|
+
|
38
|
+
## ManagedSpan
|
39
|
+
|
40
|
+
`ManagedSpan` is a wrapper that forwards all calls to another `OpenTracing::Span` and layers on an in-process propagation capabilities.
|
41
|
+
The behaviour of `finish` method is changed. In addition to calling finish on wrapped span, if not yet deactivated, marks the end of active period for the span.
|
42
|
+
|
43
|
+
Provides the following additional methods:
|
44
|
+
|
45
|
+
1. `deactivate` marks the end of active period for the current span.
|
46
|
+
2. `active?` returns whether the span is active or not.
|
47
|
+
|
48
|
+
## SpanManager::Tracer
|
49
|
+
|
50
|
+
The library exposes a convenience `OpenTracing::Tracer` that automates managing current span.
|
51
|
+
|
52
|
+
It's a wrapper that forwards all calls to another `OpenTracing::Tracer` implementation e.g. Lightstep, Jaeger etc.
|
53
|
+
Spans which you will create through this tracer will be automatically activated when started, and
|
54
|
+
deactivated when they finish.
|
55
|
+
|
56
|
+
## Usage
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
require 'spanmanager'
|
60
|
+
|
61
|
+
OpenTracing.global_tracer = SpanManager::Tracer.new(Jaeger::Client.build, SpanManager::ThreadLocalManagedSpanSource.new)
|
62
|
+
```
|
63
|
+
|
64
|
+
To start a new active span, use the regular and known `start_span` method. If you use the default argument for `child_of` argument
|
65
|
+
then the currently active span becomes an implicit parent of a newly-started span. It means that you no longer have to
|
66
|
+
pass the current span through the code.
|
67
|
+
|
68
|
+
When you finish the span, and if not yet deactivated, marks the end of the active period for the span. For `ThreadLocalManagedSpanSource`
|
69
|
+
it means it's removed from the top of the stack on a per-thread basis.
|
70
|
+
|
71
|
+
```ruby
|
72
|
+
rack_span = tracer.start_span("/GET users")
|
73
|
+
db_span = tracer.start_span("GetUsers") # rack_span became an implicit parent of db_span
|
74
|
+
db_span.finish
|
75
|
+
rack_span.finish
|
76
|
+
```
|
77
|
+
|
78
|
+
## Development
|
79
|
+
|
80
|
+
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.
|
81
|
+
|
82
|
+
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).
|
83
|
+
|
84
|
+
## Contributing
|
85
|
+
|
86
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/iaintshine/ruby-spanmanager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
87
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "activespan"
|
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,41 @@
|
|
1
|
+
module SpanManager
|
2
|
+
# The [SpanManager::ManagedSpan] inherits all of the OpenTracing funcionality and layers on
|
3
|
+
# in-process propagation capabilities.
|
4
|
+
class ManagedSpan < OpenTracing::Span
|
5
|
+
extend Forwardable
|
6
|
+
|
7
|
+
def_delegators :@span, :context, :operation_name=, :set_tag, :set_baggage_item, :get_baggage_item, :log, :finish
|
8
|
+
|
9
|
+
# Initializes a new active span. It's ManagedSpanSource responsibility to activate the span.
|
10
|
+
#
|
11
|
+
# @param span [OpenTracing::Span] the span to wrap
|
12
|
+
# @param deactivate [Proc] the current span deactivation supplier. The block must return instance of [SpanManager::ManagedSpan]
|
13
|
+
def initialize(span, deactivate)
|
14
|
+
@span = span
|
15
|
+
@deactivate = deactivate.respond_to?(:call) ? deactivate : nil
|
16
|
+
@active = true
|
17
|
+
end
|
18
|
+
|
19
|
+
# @return [Boolean] whether the span is active or not
|
20
|
+
def active?
|
21
|
+
@active
|
22
|
+
end
|
23
|
+
|
24
|
+
# Mark the end of active period for the current span in this asynchronus executor and/or thread.
|
25
|
+
# It's safe to call the method multiple times.
|
26
|
+
def deactivate
|
27
|
+
if @active && @deactivate
|
28
|
+
deactivated_span = @deactivate.call
|
29
|
+
warn "ActiveSpan::SpanSource inconsistency found during deactivation" unless deactivated_span == self
|
30
|
+
@active = false
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
# Finishes the current span, and if not yet deactivated marks the end of the active period for the span.
|
35
|
+
# @param end_time [Time] custom end time, if not now
|
36
|
+
def finish(end_time: Time.now)
|
37
|
+
deactivate
|
38
|
+
@span.finish(end_time: end_time)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,28 @@
|
|
1
|
+
module SpanManager
|
2
|
+
# ManagedSpanSource is an interface for a pluggable class that keeps track of the current active Span.
|
3
|
+
# It must be used as a base class for a specific implementation.
|
4
|
+
class ManagedSpanSource
|
5
|
+
# Wrap and "make active" the span by encapsulating it in a new [SpanManager::ManagedSpan]
|
6
|
+
#
|
7
|
+
# The actived span becomes an implicit parent of a newly-created
|
8
|
+
# span at [SpanManager::Tracer#start_span] time.
|
9
|
+
#
|
10
|
+
# @param span [OpenTracing::Span] the Span to wrap in [SpanManager::ManagedSpan].
|
11
|
+
# @return [SpanManager::ManagedSpan] an active span that encapsulates the given span.
|
12
|
+
def make_active(span)
|
13
|
+
end
|
14
|
+
|
15
|
+
# Retrieves the current active span.
|
16
|
+
#
|
17
|
+
# If there is an active span, it becomes an implicit parent of a newly-created
|
18
|
+
# span at [SpanManager::Tracer#start_span] time.
|
19
|
+
#
|
20
|
+
# @return [SpanManager::ManagedSpan] returns the current active span, or null if none could be found.
|
21
|
+
def active_span
|
22
|
+
end
|
23
|
+
|
24
|
+
# Unconditionally cleans up all managed spans.
|
25
|
+
def clear
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
@@ -0,0 +1,38 @@
|
|
1
|
+
module SpanManager
|
2
|
+
# ThreadLocalManagedSpanSource allows an application access and manipulation of the current span state on per thread basis.
|
3
|
+
class ThreadLocalManagedSpanSource < ManagedSpanSource
|
4
|
+
def make_active(span)
|
5
|
+
active_span = ManagedSpan.new(span, method(:pop))
|
6
|
+
push(active_span)
|
7
|
+
active_span
|
8
|
+
end
|
9
|
+
|
10
|
+
def active_span
|
11
|
+
local_stack.last
|
12
|
+
end
|
13
|
+
|
14
|
+
def clear
|
15
|
+
local_stack.clear
|
16
|
+
end
|
17
|
+
|
18
|
+
private
|
19
|
+
# Adds the given span to the stack
|
20
|
+
#
|
21
|
+
# @param span [Span] The span to be pushed
|
22
|
+
def push(span)
|
23
|
+
local_stack << span
|
24
|
+
end
|
25
|
+
|
26
|
+
# Removes a span from the stack
|
27
|
+
#
|
28
|
+
# @return [Span] returns and removes the current span from the top of the stack
|
29
|
+
def pop
|
30
|
+
local_stack.pop
|
31
|
+
end
|
32
|
+
|
33
|
+
# @return [Array] return a per thread basis stack of spans.
|
34
|
+
def local_stack
|
35
|
+
Thread.current[:__active_span__] ||= []
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,42 @@
|
|
1
|
+
module SpanManager
|
2
|
+
# Convenience [OpenTracing::Tracer] that automates managing current span.
|
3
|
+
#
|
4
|
+
# It's a wrapper that forwards all calls to another [OpenTracing::Tracer] implementation.
|
5
|
+
# Spans created with this tracer are automatically activated when started,
|
6
|
+
# and deactivated when they finish.
|
7
|
+
class Tracer < OpenTracing::Tracer
|
8
|
+
extend Forwardable
|
9
|
+
def_delegators :@tracer, :inject, :extract
|
10
|
+
|
11
|
+
# @return [SpanManager::ManagedSpanSource] returns the active span source
|
12
|
+
attr_reader :managed_span_source
|
13
|
+
|
14
|
+
# @param tracer [OpenTracing::Tracer] the tracer to be wrapped.
|
15
|
+
# @param active_span_source [SpanManager::ManagedSpanSource] the span source that keeps track of the current active span.
|
16
|
+
def initialize(tracer, managed_span_source = ThreadLocalManagedSpanSource.new)
|
17
|
+
@tracer = tracer
|
18
|
+
@managed_span_source = managed_span_source
|
19
|
+
end
|
20
|
+
|
21
|
+
# Retrieves the current active span.
|
22
|
+
#
|
23
|
+
# @return [SpanManager::ManagedSpan] returns the current active span, or null if none could be found.
|
24
|
+
def active_span
|
25
|
+
managed_span_source.active_span
|
26
|
+
end
|
27
|
+
|
28
|
+
# Starts a new active span.
|
29
|
+
#
|
30
|
+
# @param operation_name [String] The operation name for the Span
|
31
|
+
#
|
32
|
+
# @param child_of [SpanContext, Span] SpanContext that acts as a parent to
|
33
|
+
# the newly-started Span. If default argument is used then the currently
|
34
|
+
# active span becomes an implicit parent of a newly-started span.
|
35
|
+
#
|
36
|
+
# @return [SpanManager::ManagedSpan] The newly-started active Span
|
37
|
+
def start_span(operation_name, child_of: active_span, **args)
|
38
|
+
span = @tracer.start_span(operation_name, child_of: child_of, **args)
|
39
|
+
@managed_span_source.make_active(span)
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
data/lib/spanmanager.rb
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
require "opentracing"
|
2
|
+
|
3
|
+
require "spanmanager/version"
|
4
|
+
require "spanmanager/managed_span"
|
5
|
+
require "spanmanager/managed_span_source"
|
6
|
+
require "spanmanager/tracer"
|
7
|
+
require "spanmanager/managed_span_sources/thread_local_managed_span_source"
|
8
|
+
|
9
|
+
module SpanManager
|
10
|
+
end
|
data/spanmanager.gemspec
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "spanmanager/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "spanmanager"
|
8
|
+
spec.version = SpanManager::VERSION
|
9
|
+
spec.authors = ["iaintshine"]
|
10
|
+
spec.email = ["bodziomista@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{Current span managemt for OpenTracing}
|
13
|
+
spec.description = %q{}
|
14
|
+
spec.homepage = "https://github.com/iaintshine/ruby-activespan"
|
15
|
+
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
19
|
+
end
|
20
|
+
spec.bindir = "exe"
|
21
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
22
|
+
spec.require_paths = ["lib"]
|
23
|
+
|
24
|
+
spec.add_dependency 'opentracing'
|
25
|
+
|
26
|
+
spec.add_development_dependency "bundler", "~> 1.15"
|
27
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
28
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
29
|
+
spec.add_development_dependency "simplecov"
|
30
|
+
spec.add_development_dependency "simplecov-console"
|
31
|
+
end
|
metadata
ADDED
@@ -0,0 +1,143 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: spanmanager
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- iaintshine
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-08-04 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: opentracing
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.15'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.15'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: simplecov
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: simplecov-console
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
description: ''
|
98
|
+
email:
|
99
|
+
- bodziomista@gmail.com
|
100
|
+
executables: []
|
101
|
+
extensions: []
|
102
|
+
extra_rdoc_files: []
|
103
|
+
files:
|
104
|
+
- ".gitignore"
|
105
|
+
- ".rspec"
|
106
|
+
- ".travis.yml"
|
107
|
+
- Gemfile
|
108
|
+
- LICENSE
|
109
|
+
- README.md
|
110
|
+
- Rakefile
|
111
|
+
- bin/console
|
112
|
+
- bin/setup
|
113
|
+
- lib/spanmanager.rb
|
114
|
+
- lib/spanmanager/managed_span.rb
|
115
|
+
- lib/spanmanager/managed_span_source.rb
|
116
|
+
- lib/spanmanager/managed_span_sources/thread_local_managed_span_source.rb
|
117
|
+
- lib/spanmanager/tracer.rb
|
118
|
+
- lib/spanmanager/version.rb
|
119
|
+
- spanmanager.gemspec
|
120
|
+
homepage: https://github.com/iaintshine/ruby-activespan
|
121
|
+
licenses: []
|
122
|
+
metadata: {}
|
123
|
+
post_install_message:
|
124
|
+
rdoc_options: []
|
125
|
+
require_paths:
|
126
|
+
- lib
|
127
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0'
|
132
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
133
|
+
requirements:
|
134
|
+
- - ">="
|
135
|
+
- !ruby/object:Gem::Version
|
136
|
+
version: '0'
|
137
|
+
requirements: []
|
138
|
+
rubyforge_project:
|
139
|
+
rubygems_version: 2.6.12
|
140
|
+
signing_key:
|
141
|
+
specification_version: 4
|
142
|
+
summary: Current span managemt for OpenTracing
|
143
|
+
test_files: []
|