instatus-otel 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/LICENSE +21 -0
- data/README.md +257 -0
- data/lib/instatus/otel/attributes.rb +155 -0
- data/lib/instatus/otel/client.rb +108 -0
- data/lib/instatus/otel/configuration.rb +32 -0
- data/lib/instatus/otel/dedupe.rb +41 -0
- data/lib/instatus/otel/event.rb +51 -0
- data/lib/instatus/otel/exports.rb +59 -0
- data/lib/instatus/otel/logger.rb +77 -0
- data/lib/instatus/otel/providers.rb +135 -0
- data/lib/instatus/otel/rack.rb +43 -0
- data/lib/instatus/otel/rails.rb +15 -0
- data/lib/instatus/otel/rails_error_subscriber.rb +21 -0
- data/lib/instatus/otel/rate_cap.rb +30 -0
- data/lib/instatus/otel/resource.rb +50 -0
- data/lib/instatus/otel/scope.rb +92 -0
- data/lib/instatus/otel/scrub.rb +85 -0
- data/lib/instatus/otel/version.rb +8 -0
- data/lib/instatus/otel.rb +184 -0
- metadata +177 -0
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "otel/version"
|
|
4
|
+
require_relative "otel/scrub"
|
|
5
|
+
require_relative "otel/event"
|
|
6
|
+
require_relative "otel/scope"
|
|
7
|
+
require_relative "otel/attributes"
|
|
8
|
+
require_relative "otel/dedupe"
|
|
9
|
+
require_relative "otel/rate_cap"
|
|
10
|
+
require_relative "otel/configuration"
|
|
11
|
+
require_relative "otel/exports"
|
|
12
|
+
require_relative "otel/resource"
|
|
13
|
+
require_relative "otel/providers"
|
|
14
|
+
require_relative "otel/client"
|
|
15
|
+
require_relative "otel/logger"
|
|
16
|
+
require_relative "otel/rack"
|
|
17
|
+
require_relative "otel/rails_error_subscriber"
|
|
18
|
+
|
|
19
|
+
module Instatus
|
|
20
|
+
SCOPE_KEY = OpenTelemetry::Context.create_key("instatus-scope")
|
|
21
|
+
THREAD_SCOPE = :__instatus_scope
|
|
22
|
+
UNCAUGHT_EXCLUDED = [SystemExit, SignalException].freeze
|
|
23
|
+
|
|
24
|
+
@mutex = Mutex.new
|
|
25
|
+
@global_scope = Scope.new
|
|
26
|
+
@client = nil
|
|
27
|
+
@last_event_id = nil
|
|
28
|
+
|
|
29
|
+
class << self
|
|
30
|
+
attr_reader :client, :global_scope, :last_event_id
|
|
31
|
+
|
|
32
|
+
def init(**options)
|
|
33
|
+
config = Configuration.new
|
|
34
|
+
options.each { |key, value| config.public_send(:"#{key}=", value) }
|
|
35
|
+
yield config if block_given?
|
|
36
|
+
|
|
37
|
+
@mutex.synchronize do
|
|
38
|
+
return @client if @client
|
|
39
|
+
|
|
40
|
+
providers = Otel::Providers.new(config).install
|
|
41
|
+
@client = Otel::Client.new(config, sink: providers)
|
|
42
|
+
install_at_exit
|
|
43
|
+
@client
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
def initialized?
|
|
48
|
+
!@client.nil?
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# with_scope keeps its copy in the OpenTelemetry context, which is per fiber.
|
|
52
|
+
def current_scope
|
|
53
|
+
OpenTelemetry::Context.current.value(SCOPE_KEY) || thread_scope
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
def with_scope
|
|
57
|
+
scope = current_scope.dup
|
|
58
|
+
OpenTelemetry::Context.with_value(SCOPE_KEY, scope) { yield scope }
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
def capture_exception(error, **context, &block)
|
|
62
|
+
capture_with_mechanism(error, handled: true, mechanism: "generic", **context, &block)
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
def capture_with_mechanism(error, handled:, mechanism:, **context, &block)
|
|
66
|
+
event = Event.from_exception(error, handled: handled, mechanism: mechanism)
|
|
67
|
+
capture(event, { exception: error }, scope_for(context, &block))
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
def capture_message(message, level: :info, **context, &block)
|
|
71
|
+
event = Event.from_message(message, level)
|
|
72
|
+
capture(event, {}, scope_for(context, &block))
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
def set_user(user)
|
|
76
|
+
current_scope.set_user(user)
|
|
77
|
+
span = OpenTelemetry::Trace.current_span
|
|
78
|
+
return unless user && span.recording?
|
|
79
|
+
|
|
80
|
+
user = user.to_h.transform_keys(&:to_s)
|
|
81
|
+
id = user["id"] || user["email"] || user["username"]
|
|
82
|
+
span.set_attribute("enduser.id", id.to_s) unless id.nil?
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
def set_tag(key, value)
|
|
86
|
+
current_scope.set_tag(key, value)
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
def set_tags(tags)
|
|
90
|
+
current_scope.set_tags(tags)
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
def set_context(name, context)
|
|
94
|
+
current_scope.set_context(name, context)
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
def set_extra(key, value)
|
|
98
|
+
current_scope.set_extra(key, value)
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
def set_extras(extras)
|
|
102
|
+
current_scope.set_extras(extras)
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
def start_span(name, attributes: nil, op: nil, kind: :internal)
|
|
106
|
+
attributes = (attributes || {}).merge("sentry.op" => op.to_s) if op
|
|
107
|
+
span = tracer.start_span(name.to_s, attributes: attributes, kind: kind)
|
|
108
|
+
OpenTelemetry::Trace.with_span(span) { yield span }
|
|
109
|
+
rescue Exception => e
|
|
110
|
+
span&.status = OpenTelemetry::Trace::Status.error(Otel::Scrub.scrub_text(e.message))
|
|
111
|
+
raise
|
|
112
|
+
ensure
|
|
113
|
+
span&.finish
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
def active_span
|
|
117
|
+
OpenTelemetry::Trace.current_span
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
def flush(timeout = Configuration::DEFAULT_SHUTDOWN_TIMEOUT)
|
|
121
|
+
return true unless @client
|
|
122
|
+
|
|
123
|
+
@client.flush(timeout)
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
def close(timeout = Configuration::DEFAULT_SHUTDOWN_TIMEOUT)
|
|
127
|
+
client = @mutex.synchronize { @client.tap { @client = nil } }
|
|
128
|
+
return true unless client
|
|
129
|
+
|
|
130
|
+
client.close(timeout)
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
def logger
|
|
134
|
+
@logger ||= Otel::Logger.new
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
def tracer
|
|
138
|
+
OpenTelemetry.tracer_provider.tracer(Otel::SDK_NAME, Otel::VERSION)
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
private
|
|
142
|
+
|
|
143
|
+
def thread_scope
|
|
144
|
+
return @global_scope if Thread.current == Thread.main
|
|
145
|
+
|
|
146
|
+
Thread.current[THREAD_SCOPE] ||= @global_scope.dup
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
def scope_for(context)
|
|
150
|
+
return current_scope if context.empty? && !block_given?
|
|
151
|
+
|
|
152
|
+
scope = current_scope.dup.update(**context)
|
|
153
|
+
yield scope if block_given?
|
|
154
|
+
scope
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
def capture(event, hint, scope)
|
|
158
|
+
scope.apply(event)
|
|
159
|
+
return event.event_id unless @client
|
|
160
|
+
|
|
161
|
+
@last_event_id = @client.capture_event(event, hint)
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
def install_at_exit
|
|
165
|
+
return if @at_exit_installed
|
|
166
|
+
|
|
167
|
+
@at_exit_installed = true
|
|
168
|
+
at_exit { report_exit($!) }
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Ruby prints the error and exits after at_exit handlers, so its behaviour is unchanged.
|
|
172
|
+
def report_exit(error)
|
|
173
|
+
timeout = @client&.config&.shutdown_timeout || Configuration::DEFAULT_SHUTDOWN_TIMEOUT
|
|
174
|
+
if error && UNCAUGHT_EXCLUDED.none? { |type| error.is_a?(type) }
|
|
175
|
+
capture_with_mechanism(error, handled: false, mechanism: "at_exit", level: :fatal)
|
|
176
|
+
end
|
|
177
|
+
close(timeout)
|
|
178
|
+
rescue StandardError
|
|
179
|
+
nil
|
|
180
|
+
end
|
|
181
|
+
end
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
require_relative "otel/rails" if defined?(::Rails::Railtie)
|
metadata
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: instatus-otel
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Instatus
|
|
8
|
+
bindir: bin
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: opentelemetry-exporter-otlp
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - ">="
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '0.30'
|
|
19
|
+
- - "<"
|
|
20
|
+
- !ruby/object:Gem::Version
|
|
21
|
+
version: '1'
|
|
22
|
+
type: :runtime
|
|
23
|
+
prerelease: false
|
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
25
|
+
requirements:
|
|
26
|
+
- - ">="
|
|
27
|
+
- !ruby/object:Gem::Version
|
|
28
|
+
version: '0.30'
|
|
29
|
+
- - "<"
|
|
30
|
+
- !ruby/object:Gem::Version
|
|
31
|
+
version: '1'
|
|
32
|
+
- !ruby/object:Gem::Dependency
|
|
33
|
+
name: opentelemetry-exporter-otlp-logs
|
|
34
|
+
requirement: !ruby/object:Gem::Requirement
|
|
35
|
+
requirements:
|
|
36
|
+
- - ">="
|
|
37
|
+
- !ruby/object:Gem::Version
|
|
38
|
+
version: '0.2'
|
|
39
|
+
- - "<"
|
|
40
|
+
- !ruby/object:Gem::Version
|
|
41
|
+
version: '1'
|
|
42
|
+
type: :runtime
|
|
43
|
+
prerelease: false
|
|
44
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
45
|
+
requirements:
|
|
46
|
+
- - ">="
|
|
47
|
+
- !ruby/object:Gem::Version
|
|
48
|
+
version: '0.2'
|
|
49
|
+
- - "<"
|
|
50
|
+
- !ruby/object:Gem::Version
|
|
51
|
+
version: '1'
|
|
52
|
+
- !ruby/object:Gem::Dependency
|
|
53
|
+
name: opentelemetry-exporter-otlp-metrics
|
|
54
|
+
requirement: !ruby/object:Gem::Requirement
|
|
55
|
+
requirements:
|
|
56
|
+
- - ">="
|
|
57
|
+
- !ruby/object:Gem::Version
|
|
58
|
+
version: '0.4'
|
|
59
|
+
- - "<"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '1'
|
|
62
|
+
type: :runtime
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - ">="
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '0.4'
|
|
69
|
+
- - "<"
|
|
70
|
+
- !ruby/object:Gem::Version
|
|
71
|
+
version: '1'
|
|
72
|
+
- !ruby/object:Gem::Dependency
|
|
73
|
+
name: opentelemetry-logs-sdk
|
|
74
|
+
requirement: !ruby/object:Gem::Requirement
|
|
75
|
+
requirements:
|
|
76
|
+
- - ">="
|
|
77
|
+
- !ruby/object:Gem::Version
|
|
78
|
+
version: '0.2'
|
|
79
|
+
- - "<"
|
|
80
|
+
- !ruby/object:Gem::Version
|
|
81
|
+
version: '1'
|
|
82
|
+
type: :runtime
|
|
83
|
+
prerelease: false
|
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - ">="
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '0.2'
|
|
89
|
+
- - "<"
|
|
90
|
+
- !ruby/object:Gem::Version
|
|
91
|
+
version: '1'
|
|
92
|
+
- !ruby/object:Gem::Dependency
|
|
93
|
+
name: opentelemetry-metrics-sdk
|
|
94
|
+
requirement: !ruby/object:Gem::Requirement
|
|
95
|
+
requirements:
|
|
96
|
+
- - ">="
|
|
97
|
+
- !ruby/object:Gem::Version
|
|
98
|
+
version: '0.6'
|
|
99
|
+
- - "<"
|
|
100
|
+
- !ruby/object:Gem::Version
|
|
101
|
+
version: '1'
|
|
102
|
+
type: :runtime
|
|
103
|
+
prerelease: false
|
|
104
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
105
|
+
requirements:
|
|
106
|
+
- - ">="
|
|
107
|
+
- !ruby/object:Gem::Version
|
|
108
|
+
version: '0.6'
|
|
109
|
+
- - "<"
|
|
110
|
+
- !ruby/object:Gem::Version
|
|
111
|
+
version: '1'
|
|
112
|
+
- !ruby/object:Gem::Dependency
|
|
113
|
+
name: opentelemetry-sdk
|
|
114
|
+
requirement: !ruby/object:Gem::Requirement
|
|
115
|
+
requirements:
|
|
116
|
+
- - "~>"
|
|
117
|
+
- !ruby/object:Gem::Version
|
|
118
|
+
version: '1.8'
|
|
119
|
+
type: :runtime
|
|
120
|
+
prerelease: false
|
|
121
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
122
|
+
requirements:
|
|
123
|
+
- - "~>"
|
|
124
|
+
- !ruby/object:Gem::Version
|
|
125
|
+
version: '1.8'
|
|
126
|
+
description: An OpenTelemetry distro for Ruby that sends errors, logs, traces and
|
|
127
|
+
metrics to Instatus. Errors are OpenTelemetry log records, captured with Sentry-style
|
|
128
|
+
functions.
|
|
129
|
+
executables: []
|
|
130
|
+
extensions: []
|
|
131
|
+
extra_rdoc_files: []
|
|
132
|
+
files:
|
|
133
|
+
- LICENSE
|
|
134
|
+
- README.md
|
|
135
|
+
- lib/instatus/otel.rb
|
|
136
|
+
- lib/instatus/otel/attributes.rb
|
|
137
|
+
- lib/instatus/otel/client.rb
|
|
138
|
+
- lib/instatus/otel/configuration.rb
|
|
139
|
+
- lib/instatus/otel/dedupe.rb
|
|
140
|
+
- lib/instatus/otel/event.rb
|
|
141
|
+
- lib/instatus/otel/exports.rb
|
|
142
|
+
- lib/instatus/otel/logger.rb
|
|
143
|
+
- lib/instatus/otel/providers.rb
|
|
144
|
+
- lib/instatus/otel/rack.rb
|
|
145
|
+
- lib/instatus/otel/rails.rb
|
|
146
|
+
- lib/instatus/otel/rails_error_subscriber.rb
|
|
147
|
+
- lib/instatus/otel/rate_cap.rb
|
|
148
|
+
- lib/instatus/otel/resource.rb
|
|
149
|
+
- lib/instatus/otel/scope.rb
|
|
150
|
+
- lib/instatus/otel/scrub.rb
|
|
151
|
+
- lib/instatus/otel/version.rb
|
|
152
|
+
homepage: https://github.com/instatushq/otel
|
|
153
|
+
licenses:
|
|
154
|
+
- MIT
|
|
155
|
+
metadata:
|
|
156
|
+
homepage_uri: https://github.com/instatushq/otel
|
|
157
|
+
source_code_uri: https://github.com/instatushq/otel/tree/main/ruby
|
|
158
|
+
bug_tracker_uri: https://github.com/instatushq/otel/issues
|
|
159
|
+
rubygems_mfa_required: 'true'
|
|
160
|
+
rdoc_options: []
|
|
161
|
+
require_paths:
|
|
162
|
+
- lib
|
|
163
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
164
|
+
requirements:
|
|
165
|
+
- - ">="
|
|
166
|
+
- !ruby/object:Gem::Version
|
|
167
|
+
version: '3.1'
|
|
168
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
169
|
+
requirements:
|
|
170
|
+
- - ">="
|
|
171
|
+
- !ruby/object:Gem::Version
|
|
172
|
+
version: '0'
|
|
173
|
+
requirements: []
|
|
174
|
+
rubygems_version: 4.0.20
|
|
175
|
+
specification_version: 4
|
|
176
|
+
summary: Error tracking on OpenTelemetry, with the Sentry SDK's API.
|
|
177
|
+
test_files: []
|