opentelemetry-instrumentation-sidekiq 0.25.1 → 0.25.2
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
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 643b9d07b7c13baf54e233a7632a9ed5d48bef886f348b98c28861bd0c750283
|
|
4
|
+
data.tar.gz: 285b0d852bb7d5fd09a71ab1eedc1ca07fe0a4079d780718c61c078489106786
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 60978f2e9a2921e131ceda564fc3aea92b218964fb7f44b9626cd3b28143341bdc73c75077a03039acfcbd303327aaf4e3f353c92bb10bb5024f2c293eeaa8fb
|
|
7
|
+
data.tar.gz: 5834c8414812a44ff6680f54914aaad6e4cd917f996280c50b9eb293c5516023fb0a9289d931496de01ae79b25d0d38de69070bd5795c9f7aee86b76bde3399b
|
data/CHANGELOG.md
CHANGED
|
@@ -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,7 +1,7 @@
|
|
|
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.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenTelemetry Authors
|
|
@@ -245,10 +245,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
|
|
|
245
245
|
licenses:
|
|
246
246
|
- Apache-2.0
|
|
247
247
|
metadata:
|
|
248
|
-
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.
|
|
248
|
+
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.2/file/CHANGELOG.md
|
|
249
249
|
source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/sidekiq
|
|
250
250
|
bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
|
|
251
|
-
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.
|
|
251
|
+
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/0.25.2
|
|
252
252
|
post_install_message:
|
|
253
253
|
rdoc_options: []
|
|
254
254
|
require_paths:
|