stackdriver-core 0.21.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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 5cd7e254aea61a27009783146ee707f693738a92
4
+ data.tar.gz: cd3f56cf72c36ebaa39fb2062fadf2e0f3ee7b50
5
+ SHA512:
6
+ metadata.gz: 4ab59a86d910818257c592ab88305f87315ee4776ee3b1619435e06eb1b2bc53e9ceb782b72ccda5a77263c74fd7c18fa0ba1aa527890f21b82d4824e704f50b
7
+ data.tar.gz: ee30b04c5fb76ef428aa50f3e663764e5b7116d5fde3bbc6caf36127214db0e4de012824ad4f1840b3e46c6ab52004e8908ec51baa68190319f4dc4a1a7f3d69
@@ -0,0 +1,7 @@
1
+ --no-private
2
+ --title=Stackdriver Core
3
+ --markup markdown
4
+
5
+ ./lib/**/*.rb
6
+ -
7
+ README.md
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.
@@ -0,0 +1,32 @@
1
+ # stackdriver-core
2
+
3
+ This library contains shared types and utilities for Stackdriver-related libraries. Please see the top-level project [README](../README.md) for general information.
4
+
5
+ - [stackdriver-core API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver-core/master/stackdriver/core)
6
+
7
+ ## Supported Ruby Versions
8
+
9
+ This library is supported on Ruby 2.0+.
10
+
11
+ ## Versioning
12
+
13
+ This library follows [Semantic Versioning](http://semver.org/).
14
+
15
+ It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.
16
+
17
+ ## Contributing
18
+
19
+ Contributions to this library are always welcome and highly encouraged.
20
+
21
+ See the [Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing) for more information on how to get started.
22
+
23
+ Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information.
24
+
25
+ ## License
26
+
27
+ This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
28
+
29
+ ## Support
30
+
31
+ Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues).
32
+ Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,16 @@
1
+ # Copyright 2016 Google Inc. All rights reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+
16
+ require "stackdriver/core"
@@ -0,0 +1,27 @@
1
+ # Copyright 2016 Google Inc. All rights reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+
16
+ require "stackdriver/core/trace_context"
17
+ require "stackdriver/core/version"
18
+
19
+ module Stackdriver
20
+ ##
21
+ # The Stackdriver::Core module is a namespace for common types and shared
22
+ # utilities used by the Google Stackdriver libraries. Most applications will
23
+ # not need to use these classes directly.
24
+ #
25
+ module Core
26
+ end
27
+ end
@@ -0,0 +1,344 @@
1
+ # Copyright 2016 Google Inc. All rights reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+
16
+ module Stackdriver
17
+ module Core
18
+ ##
19
+ # A Stackdriver trace context links the current request into a performance
20
+ # trace, and communicates tracing options between related requests. This
21
+ # functionality is used by the Stackdriver diagnostics libraries
22
+ # (including google-cloud-trace, google-cloud-logging, and other rubygems)
23
+ # that integrate with the tracing service.
24
+ #
25
+ # Most applications will not need to use the TraceContext class directly.
26
+ # The Stackdriver libraries use it internally to store and propagate
27
+ # context information.
28
+ #
29
+ class TraceContext
30
+ ##
31
+ # @private
32
+ HEADER_RACK_KEY = "HTTP_X_CLOUD_TRACE_CONTEXT"
33
+
34
+ ##
35
+ # @private
36
+ MEMO_RACK_KEY = "google.cloud.trace_context"
37
+
38
+ ##
39
+ # @private
40
+ THREAD_KEY = :__stackdriver_trace_context__
41
+
42
+ ##
43
+ # @private
44
+ UNCHANGED = ::Object.new
45
+
46
+ ##
47
+ # Create a new TraceContext instance.
48
+ #
49
+ # @param [String] trace_id The trace ID as a hex string. If nil or
50
+ # omitted, a new random Trace ID will be generated, and this
51
+ # TraceContext will be marked as new.
52
+ # @param [Boolean] is_new Whether this trace context should be flagged
53
+ # as newly created. Optional: if unset, will reflect whether a new
54
+ # trace_id was generated when this object was created.
55
+ # @param [Integer] span_id The context parent span ID as a 64-bit int.
56
+ # If nil or omitted, the context will specify no parent span.
57
+ # @param [Boolean] sampled Whether the context has decided to sample
58
+ # this trace or not, or nil if the context does not specify a
59
+ # sampling decision.
60
+ # @param [Boolean] capture_stack Whether the the context has decided to
61
+ # capture stack traces. Ignored if sampled is not true.
62
+ #
63
+ # @example
64
+ # require "stackdriver/core"
65
+ #
66
+ # trace_id = "0123456789abcdef0123456789abcdef"
67
+ # ctx = Stackdriver::Core::TraceContext.new trace_id: trace_id,
68
+ # sampled: true
69
+ #
70
+ def initialize trace_id: nil, is_new: nil, span_id: nil, sampled: nil,
71
+ capture_stack: false
72
+ @trace_id = trace_id || new_random_trace_id
73
+ if is_new.nil?
74
+ @is_new = !trace_id
75
+ else
76
+ @is_new = is_new ? true : false
77
+ end
78
+ @span_id = span_id ? span_id.to_i : nil
79
+ @sampled = sampled
80
+ if @sampled.nil?
81
+ @capture_stack = nil
82
+ else
83
+ @sampled = @sampled ? true : false
84
+ @capture_stack = capture_stack && @sampled
85
+ end
86
+ end
87
+
88
+ ##
89
+ # The trace ID, as a hex string.
90
+ #
91
+ # @return [String]
92
+ #
93
+ attr_reader :trace_id
94
+
95
+ ##
96
+ # The span ID, as a 64-bit integer, or `nil` if no span ID is present
97
+ # in the context.
98
+ #
99
+ # @return [Integer, nil]
100
+ #
101
+ attr_reader :span_id
102
+
103
+ ##
104
+ # Returns `true` if the context wants to sample, `false` if the context
105
+ # wants explicitly to disable sampling, or `nil` if the context does
106
+ # not specify.
107
+ #
108
+ # @return [Boolean, nil]
109
+ #
110
+ def sampled?
111
+ @sampled
112
+ end
113
+
114
+ ##
115
+ # Returns `true` if the context wants to capture stack traces, `false` if
116
+ # the context does not, or `nil` if the context does not specify a
117
+ # sampling decision.
118
+ #
119
+ # @return [Boolean, nil]
120
+ #
121
+ def capture_stack?
122
+ @capture_stack
123
+ end
124
+
125
+ ##
126
+ # Returns `true` if this trace includes a newly generated trace_id.
127
+ #
128
+ # @return [Boolean]
129
+ #
130
+ def new?
131
+ @is_new
132
+ end
133
+
134
+ ##
135
+ # Standard value equality check for this object.
136
+ #
137
+ # @param [Object] other An object to compare with.
138
+ # @return [Boolean]
139
+ #
140
+ def eql? other
141
+ other.is_a?(TraceContext) &&
142
+ trace_id == other.trace_id &&
143
+ new? == other.new? &&
144
+ span_id == other.span_id &&
145
+ sampled? == other.sampled? &&
146
+ capture_stack? == other.capture_stack?
147
+ end
148
+ alias_method :==, :eql?
149
+
150
+ ##
151
+ # Generate standard hash code for this object.
152
+ #
153
+ # @return [Integer]
154
+ #
155
+ def hash
156
+ @hash ||= @trace_id.hash ^ @is_new.hash ^ @span_id.hash ^
157
+ @sampled.hash ^ @capture_stack.hash
158
+ end
159
+
160
+ ##
161
+ # Returns a new TraceContext instance that is identical to this instance
162
+ # except for the given changes. All parameters are optional. See
163
+ # {TraceContext#initialize} for more details on each parameter.
164
+ #
165
+ # @param [String] trace_id New trace ID.
166
+ # @param [Boolean] is_new New setting for newness indicator.
167
+ # @param [Integer] span_id New parent span ID.
168
+ # @param [Boolean] sampled New sampling decision.
169
+ # @param [Boolean] capture_stack New stack capture decision.
170
+ # @return [TraceContext]
171
+ #
172
+ # @example
173
+ # require "stackdriver/core"
174
+ #
175
+ # trace_id = "0123456789abcdef0123456789abcdef"
176
+ # orig_ctx = Stackdriver::Core::TraceContext.new trace_id: trace_id,
177
+ #
178
+ # sampled_ctx = orig_ctx.with sampled: true
179
+ #
180
+ def with trace_id: UNCHANGED, is_new: UNCHANGED, span_id: UNCHANGED,
181
+ sampled: UNCHANGED, capture_stack: UNCHANGED
182
+ trace_id = @trace_id if trace_id == UNCHANGED
183
+ is_new = @is_new if is_new == UNCHANGED
184
+ span_id = @span_id if span_id == UNCHANGED
185
+ sampled = @sampled if sampled == UNCHANGED
186
+ capture_stack = @capture_stack if capture_stack == UNCHANGED
187
+ TraceContext.new trace_id: trace_id, is_new: is_new, span_id: span_id,
188
+ sampled: sampled, capture_stack: capture_stack
189
+ end
190
+
191
+ ##
192
+ # Returns a string representation of this trace context, in the form
193
+ # `<traceid>[/<spanid>][;o=<options>]`. This form is suitable for
194
+ # setting the trace context header.
195
+ #
196
+ # @return [String]
197
+ #
198
+ def to_string
199
+ str = trace_id
200
+ str += "/#{span_id}" if span_id
201
+ unless sampled?.nil?
202
+ options = 0
203
+ options |= 1 if sampled?
204
+ options |= 2 if capture_stack?
205
+ str += ";o=#{options}"
206
+ end
207
+ str
208
+ end
209
+ alias_method :to_s, :to_string
210
+
211
+ ##
212
+ # Attempts to parse the given string as a trace context representation.
213
+ # Expects the form `<traceid>[/<spanid>][;o=<options>]`, which is the
214
+ # form used in the trace context header. Returns either the parsed
215
+ # trace context, or `nil` if the string was malformed.
216
+ #
217
+ # @param [String] str The string to parse.
218
+ #
219
+ # @return [TraceContext, nil]
220
+ #
221
+ # @example
222
+ # require "stackdriver/core"
223
+ #
224
+ # str = "0123456789abcdef0123456789abcdef/12345;o=1"
225
+ # ctx = Stackdriver::Core::TraceContext.parse_string str
226
+ #
227
+ def self.parse_string str
228
+ match = %r|^(\w{32})(/(\d+))?(;o=(\d+))?|.match str
229
+ if match
230
+ trace_id = match[1]
231
+ span_id = match[3] ? match[3].to_i : nil
232
+ options = match[5] ? match[5].to_i : nil
233
+ if options.nil?
234
+ sampled = capture_stack = nil
235
+ else
236
+ sampled = options & 1 != 0
237
+ capture_stack = options & 2 != 0
238
+ end
239
+ new trace_id: trace_id, span_id: span_id, sampled: sampled,
240
+ capture_stack: capture_stack
241
+ else
242
+ nil
243
+ end
244
+ end
245
+
246
+ ##
247
+ # Obtains a TraceContext from the given Rack environment. This should
248
+ # be used by any service that wants to obtain the TraceContext for a
249
+ # Rack request. If a new trace context is generated in the process, it
250
+ # is memoized into the Rack environment so subsequent services will get
251
+ # the same context.
252
+ #
253
+ # Specifically, the following steps are attempted in order:
254
+ # 1. Attempts to use any memoized context previously obtained.
255
+ # 2. Attempts to parse the trace context header.
256
+ # 3. Creates a new trace context with a random trace ID.
257
+ #
258
+ # Furthermore, if a block is given, it is provided with an opportunity
259
+ # to modify the trace context. The current trace context and the Rack
260
+ # environment is passed to the block, and its result is used as the
261
+ # final trace context. The final context is memoized back into the
262
+ # Rack environment.
263
+ #
264
+ # @param [Hash] env The Rack environment hash
265
+ #
266
+ # @return [TraceContext]
267
+ #
268
+ # @example
269
+ # require "stackdriver/core"
270
+ #
271
+ # class MyMiddleware
272
+ # def initialize app
273
+ # @app = app
274
+ # end
275
+ #
276
+ # def call env
277
+ # ctx = Stackdriver::Core::TraceContext.parse_rack_env env
278
+ # do_something_with ctx
279
+ # @app.call env
280
+ # end
281
+ # end
282
+ #
283
+ def self.parse_rack_env env
284
+ trace_context = env[MEMO_RACK_KEY] ||
285
+ parse_string(env[HEADER_RACK_KEY].to_s) ||
286
+ new
287
+ trace_context = yield trace_context, env if block_given?
288
+ env[MEMO_RACK_KEY] = trace_context
289
+ end
290
+
291
+ ##
292
+ # Set the current thread's trace context, and returns the context.
293
+ #
294
+ # @param [TraceContext, nil] trace_context The trace context to
295
+ # set for the current thread. May be `nil`.
296
+ #
297
+ # @return [TraceContext, nil] The context set.
298
+ #
299
+ # @example
300
+ # require "stackdriver/core"
301
+ #
302
+ # ctx = Stackdriver::Core::TraceContext.new
303
+ # Stackdriver::Core::TraceContext.set ctx
304
+ # same_ctx = Stackdriver::Core::TraceContext.get
305
+ #
306
+ def self.set trace_context
307
+ Thread.current[THREAD_KEY] = trace_context
308
+ trace_context
309
+ end
310
+
311
+ ##
312
+ # Returns the current thread's trace context, or `nil` if no trace
313
+ # context has been set.
314
+ #
315
+ # @return [TraceContext, nil]
316
+ #
317
+ # @example
318
+ # require "stackdriver/core"
319
+ #
320
+ # ctx = Stackdriver::Core::TraceContext.new
321
+ # Stackdriver::Core::TraceContext.set ctx
322
+ # same_ctx = Stackdriver::Core::TraceContext.get
323
+ #
324
+ def self.get
325
+ Thread.current[THREAD_KEY]
326
+ end
327
+
328
+ protected
329
+
330
+ ##
331
+ # Returns a random trace ID (as a random type 4 UUID).
332
+ #
333
+ # @private
334
+ # @return [String]
335
+ #
336
+ def new_random_trace_id
337
+ val = rand 0x100000000000000000000000000000000
338
+ val &= 0xffffffffffff0fffcfffffffffffffff
339
+ val |= 0x00000000000040008000000000000000
340
+ format("%032x", val)
341
+ end
342
+ end
343
+ end
344
+ end
@@ -0,0 +1,20 @@
1
+ # Copyright 2016 Google Inc. All rights reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+
16
+ module Stackdriver
17
+ module Core
18
+ VERSION = "0.21.0".freeze
19
+ end
20
+ end
metadata ADDED
@@ -0,0 +1,178 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: stackdriver-core
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.21.0
5
+ platform: ruby
6
+ authors:
7
+ - Daniel Azuma
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2016-12-22 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: minitest
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '5.9'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '5.9'
27
+ - !ruby/object:Gem::Dependency
28
+ name: minitest-autotest
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest-focus
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.1'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.1'
55
+ - !ruby/object:Gem::Dependency
56
+ name: minitest-rg
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '5.2'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '5.2'
69
+ - !ruby/object:Gem::Dependency
70
+ name: autotest-suffix
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '1.1'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '1.1'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rubocop
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "<="
88
+ - !ruby/object:Gem::Version
89
+ version: 0.35.1
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "<="
95
+ - !ruby/object:Gem::Version
96
+ version: 0.35.1
97
+ - !ruby/object:Gem::Dependency
98
+ name: simplecov
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '0.9'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '0.9'
111
+ - !ruby/object:Gem::Dependency
112
+ name: yard
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '0.9'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '0.9'
125
+ - !ruby/object:Gem::Dependency
126
+ name: yard-doctest
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: 0.1.8
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: 0.1.8
139
+ description: stackdriver-core is an internal shared library for the Ruby Stackdriver
140
+ integration libraries.
141
+ email:
142
+ - dazuma@google.com
143
+ executables: []
144
+ extensions: []
145
+ extra_rdoc_files: []
146
+ files:
147
+ - ".yardopts"
148
+ - LICENSE
149
+ - README.md
150
+ - lib/stackdriver-core.rb
151
+ - lib/stackdriver/core.rb
152
+ - lib/stackdriver/core/trace_context.rb
153
+ - lib/stackdriver/core/version.rb
154
+ homepage: http://googlecloudplatform.github.io/google-cloud-ruby/
155
+ licenses:
156
+ - Apache-2.0
157
+ metadata: {}
158
+ post_install_message:
159
+ rdoc_options: []
160
+ require_paths:
161
+ - lib
162
+ required_ruby_version: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: 2.0.0
167
+ required_rubygems_version: !ruby/object:Gem::Requirement
168
+ requirements:
169
+ - - ">="
170
+ - !ruby/object:Gem::Version
171
+ version: '0'
172
+ requirements: []
173
+ rubyforge_project:
174
+ rubygems_version: 2.6.8
175
+ signing_key:
176
+ specification_version: 4
177
+ summary: Internal shared library for Ruby Stackdriver integration
178
+ test_files: []