opentelemetry-instrumentation-sidekiq 0.25.1 → 0.25.3
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 884a7151fa22eedeaab4073d2cd15501f731fee774ddaa05472255f72535e236
|
4
|
+
data.tar.gz: 9d2ac60a934127bd337c0c81b33905972c8b02c4e0aa5303d7fdd0c322650046
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ecffe49166efebdd7575407a2e5ef3fe2d59bc41fa88365992c7c8e772a77b2b2a0ba36fb08586d6fa0cadd1b4f3dafbc584d464f7076f4f9d0c7c96b56ba173
|
7
|
+
data.tar.gz: 021d55abc2a150be11b6b525da359fbfd7dadb6b084da0798ce0c2e49207548fa64f60bf2950236331d7ce54f6d1d6a8ec2926a7bae4acc5dda226ff3e0377a4
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release History: opentelemetry-instrumentation-sidekiq
|
2
2
|
|
3
|
+
### v0.25.3 / 2024-04-30
|
4
|
+
|
5
|
+
* FIXED: Bundler conflict warnings
|
6
|
+
|
7
|
+
### v0.25.2 / 2024-02-08
|
8
|
+
|
9
|
+
* DOCS: Fix doc for sidekiq options.
|
10
|
+
|
3
11
|
### v0.25.1 / 2024-02-08
|
4
12
|
|
5
13
|
* DOCS: ✏️ Sidekiq instrumentation options
|
@@ -7,8 +7,81 @@
|
|
7
7
|
module OpenTelemetry
|
8
8
|
module Instrumentation
|
9
9
|
module Sidekiq
|
10
|
-
# The Instrumentation class contains logic to detect and install the Sidekiq
|
11
|
-
#
|
10
|
+
# The `OpenTelemetry::Instrumentation::Sidekiq::Instrumentation` class contains logic to detect and install the Sidekiq instrumentation
|
11
|
+
#
|
12
|
+
# Installation and configuration of this instrumentation is done within the
|
13
|
+
# {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry/SDK#configure-instance_method OpenTelemetry::SDK#configure}
|
14
|
+
# block, calling {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use use()}
|
15
|
+
# or {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use_all use_all()}.
|
16
|
+
#
|
17
|
+
# ## Configuration keys and options
|
18
|
+
#
|
19
|
+
# ### `:span_naming`
|
20
|
+
#
|
21
|
+
# Specifies how the span names are set. Can be one of:
|
22
|
+
#
|
23
|
+
# - `:queue` **(default)** - The job span name will appear as '<destination / queue name> <operation>',
|
24
|
+
# for example `default process`.
|
25
|
+
# - `:job_class` - The job span name will appear as '<job class name> <operation>',
|
26
|
+
# for example `SimpleJob process`.
|
27
|
+
#
|
28
|
+
# ### `:propagation_style`
|
29
|
+
#
|
30
|
+
# Specifies how the job's execution is traced and related to the trace where the job was enqueued.
|
31
|
+
#
|
32
|
+
# - `:link` **(default)** - The job will be represented by a separate trace from the span that enqueued the job.
|
33
|
+
# - The initial span of the job trace will be associated with the span that enqueued the job, via a
|
34
|
+
# {https://opentelemetry.io/docs/concepts/signals/traces/#span-links Span Link}.
|
35
|
+
# - `:child` - The job will be represented within the same logical trace, as a direct
|
36
|
+
# child of the span that enqueued the job.
|
37
|
+
# - `:none` - The job will be represented by a separate trace from the span that enqueued the job.
|
38
|
+
# There will be no explicit relationship between the job trace and the trace containing the span that
|
39
|
+
# enqueued the job.
|
40
|
+
#
|
41
|
+
# ### `:trace_launcher_heartbeat`
|
42
|
+
#
|
43
|
+
# Allows tracing Sidekiq::Launcher#heartbeat.
|
44
|
+
#
|
45
|
+
# - `false` **(default)** - Sidekiq::Launcher#heartbeat will not be traced.
|
46
|
+
# - `true` - Sidekiq::Launcher#heartbeat will be traced.
|
47
|
+
#
|
48
|
+
# ### `:trace_poller_enqueue`
|
49
|
+
#
|
50
|
+
# Allows tracing Sidekiq::Scheduled#enqueue.
|
51
|
+
#
|
52
|
+
# - `false` **(default)** - Sidekiq::Scheduled#enqueue will not be traced.
|
53
|
+
# - `true` - Sidekiq::Scheduled#enqueue will be traced.
|
54
|
+
#
|
55
|
+
# ### `:trace_poller_wait`
|
56
|
+
#
|
57
|
+
# Allows tracing Sidekiq::Scheduled#wait.
|
58
|
+
#
|
59
|
+
# - `false` **(default)** - Sidekiq::Scheduled#wait will not be traced.
|
60
|
+
# - `true` - Sidekiq::Scheduled#wait will be traced.
|
61
|
+
#
|
62
|
+
# ### `:trace_processor_process_one`
|
63
|
+
#
|
64
|
+
# Allows tracing Sidekiq::Processor#process_one.
|
65
|
+
#
|
66
|
+
# - `false` **(default)** - Sidekiq::Processor#process_one will not be traced.
|
67
|
+
# - `true` - Sidekiq::Processor#process_one will be traced.
|
68
|
+
#
|
69
|
+
# ### `:peer_service`
|
70
|
+
#
|
71
|
+
# Sets service name of the remote service.
|
72
|
+
#
|
73
|
+
# - `nil` **(default)**
|
74
|
+
#
|
75
|
+
# @example An explicit default configuration
|
76
|
+
# OpenTelemetry::SDK.configure do |c|
|
77
|
+
# c.use_all({
|
78
|
+
# 'OpenTelemetry::Instrumentation::Sidekiq' => {
|
79
|
+
# span_naming: :queue,
|
80
|
+
# propagation_style: :link,
|
81
|
+
# trace_launcher_heartbeat: true,
|
82
|
+
# },
|
83
|
+
# })
|
84
|
+
# end
|
12
85
|
class Instrumentation < OpenTelemetry::Instrumentation::Base
|
13
86
|
MINIMUM_VERSION = Gem::Version.new('4.2.10')
|
14
87
|
|
@@ -27,59 +100,13 @@ module OpenTelemetry
|
|
27
100
|
gem_version >= MINIMUM_VERSION
|
28
101
|
end
|
29
102
|
|
30
|
-
# @!group Instrumentation Options
|
31
|
-
# @!macro
|
32
|
-
# @!method $1
|
33
|
-
# @instrumentation_option_default `:$2`
|
34
|
-
# @!scope class
|
35
|
-
#
|
36
|
-
# Specify how the span names are set. Can be one of:
|
37
|
-
#
|
38
|
-
# - `:queue` - the span names will be set to '<destination / queue name> <operation>'.
|
39
|
-
# - `:job_class` - the span names will be set to '<job class name> <operation>'.
|
40
103
|
option :span_naming, default: :queue, validate: %I[job_class queue]
|
41
|
-
# Controls how the job's execution is traced and related
|
42
|
-
# to the trace where the job was enqueued. Can be one of:
|
43
|
-
#
|
44
|
-
# - `:link` - the job will be executed in a separate trace. The
|
45
|
-
# initial span of the execution trace will be linked to the span that
|
46
|
-
# enqueued the job, via a Span Link.
|
47
|
-
# - `:child` - the job will be executed in the same logical trace, as a direct
|
48
|
-
# child of the span that enqueued the job.
|
49
|
-
# - `:none` - the job's execution will not be explicitly linked to the span that
|
50
|
-
# enqueued the job.
|
51
104
|
option :propagation_style, default: :link, validate: %i[link child none]
|
52
|
-
# @!macro
|
53
|
-
# @!method $1
|
54
|
-
# @instrumentation_option_default `:$2`
|
55
|
-
# @!scope class
|
56
|
-
# Allows tracing Sidekiq::Launcher#heartbeat.
|
57
105
|
option :trace_launcher_heartbeat, default: false, validate: :boolean
|
58
|
-
# @!macro
|
59
|
-
# @!method $1
|
60
|
-
# @instrumentation_option_default $2
|
61
|
-
# @!scope class
|
62
|
-
# Allows tracing Sidekiq::Scheduled#enqueue.
|
63
106
|
option :trace_poller_enqueue, default: false, validate: :boolean
|
64
|
-
# @!macro
|
65
|
-
# @!method $1
|
66
|
-
# @instrumentation_option_default $2
|
67
|
-
# @!scope class
|
68
|
-
# Allows trasing Sidekiq::Scheduled#wait
|
69
107
|
option :trace_poller_wait, default: false, validate: :boolean
|
70
|
-
# @!macro
|
71
|
-
# @!method $1
|
72
|
-
# @instrumentation_option_default $2
|
73
|
-
# @!scope class
|
74
|
-
# Allows tracing Sidekiq::Processor#process_one.
|
75
108
|
option :trace_processor_process_one, default: false, validate: :boolean
|
76
|
-
# @!macro
|
77
|
-
# @!method $1
|
78
|
-
# @instrumentation_option_default $2
|
79
|
-
# @!scope class
|
80
|
-
# Sets service name of the remote service.
|
81
109
|
option :peer_service, default: nil, validate: :string
|
82
|
-
# @!endgroup
|
83
110
|
|
84
111
|
private
|
85
112
|
|
@@ -9,7 +9,7 @@ require 'opentelemetry-instrumentation-base'
|
|
9
9
|
|
10
10
|
module OpenTelemetry
|
11
11
|
module Instrumentation
|
12
|
-
#
|
12
|
+
# (see {OpenTelemetry::Instrumentation::Sidekiq::Instrumentation})
|
13
13
|
module Sidekiq
|
14
14
|
end
|
15
15
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: opentelemetry-instrumentation-sidekiq
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.25.
|
4
|
+
version: 0.25.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- OpenTelemetry Authors
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-04-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: opentelemetry-api
|
@@ -156,14 +156,14 @@ dependencies:
|
|
156
156
|
requirements:
|
157
157
|
- - "~>"
|
158
158
|
- !ruby/object:Gem::Version
|
159
|
-
version: 1.
|
159
|
+
version: '1.62'
|
160
160
|
type: :development
|
161
161
|
prerelease: false
|
162
162
|
version_requirements: !ruby/object:Gem::Requirement
|
163
163
|
requirements:
|
164
164
|
- - "~>"
|
165
165
|
- !ruby/object:Gem::Version
|
166
|
-
version: 1.
|
166
|
+
version: '1.62'
|
167
167
|
- !ruby/object:Gem::Dependency
|
168
168
|
name: rubocop-performance
|
169
169
|
requirement: !ruby/object:Gem::Requirement
|
@@ -178,20 +178,6 @@ dependencies:
|
|
178
178
|
- - "~>"
|
179
179
|
- !ruby/object:Gem::Version
|
180
180
|
version: '1.20'
|
181
|
-
- !ruby/object:Gem::Dependency
|
182
|
-
name: sidekiq
|
183
|
-
requirement: !ruby/object:Gem::Requirement
|
184
|
-
requirements:
|
185
|
-
- - ">="
|
186
|
-
- !ruby/object:Gem::Version
|
187
|
-
version: '0'
|
188
|
-
type: :development
|
189
|
-
prerelease: false
|
190
|
-
version_requirements: !ruby/object:Gem::Requirement
|
191
|
-
requirements:
|
192
|
-
- - ">="
|
193
|
-
- !ruby/object:Gem::Version
|
194
|
-
version: '0'
|
195
181
|
- !ruby/object:Gem::Dependency
|
196
182
|
name: simplecov
|
197
183
|
requirement: !ruby/object:Gem::Requirement
|
@@ -245,10 +231,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
|
|
245
231
|
licenses:
|
246
232
|
- Apache-2.0
|
247
233
|
metadata:
|
248
|
-
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.
|
234
|
+
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.3/file/CHANGELOG.md
|
249
235
|
source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/sidekiq
|
250
236
|
bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
|
251
|
-
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.
|
237
|
+
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.3
|
252
238
|
post_install_message:
|
253
239
|
rdoc_options: []
|
254
240
|
require_paths:
|