Skip to content

Commit 09064e8

Browse files
authored
fix: deprecate api rack env getter (#1042)
* fix: deprecate api rack env getter * fix: reduce spam level of deprecation warning
1 parent dce5b58 commit 09064e8

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

api/lib/opentelemetry/context/propagation.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,13 @@ def text_map_setter
6767
TEXT_MAP_SETTER
6868
end
6969

70+
# @deprecated Use the rack env getter found in the
71+
# opentelemetry-common gem instead.
7072
# Returns a {RackEnvGetter} instance suitable for reading values from a
7173
# Rack environment.
7274
def rack_env_getter
75+
OpenTelemetry.logger.warn('OpenTelemetry::Context::Propagation.rack_env_getter has been deprecated \
76+
use OpenTelemetry::Common::Propagation.rack_env_getter from the opentelemetry-common gem instead.')
7377
RACK_ENV_GETTER
7478
end
7579
end

api/lib/opentelemetry/context/propagation/rack_env_getter.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
module OpenTelemetry
88
class Context
99
module Propagation
10+
# @deprecated Use the rack env getter found in the
11+
# opentelemetry-common gem instead.
12+
1013
# The RackEnvGetter class provides a common methods for reading
1114
# keys from a rack environment. It abstracts away the rack-normalization
1215
# process so that keys can be looked up without having to transform them

propagator/jaeger/test/text_map_propagator_test.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ def extracted_context_must_equal_parent_context(header)
132132
context = propagator.extract(
133133
carrier,
134134
context: parent_context,
135-
getter: OpenTelemetry::Context::Propagation.rack_env_getter
135+
getter: OpenTelemetry::Common::Propagation.rack_env_getter
136136
)
137137
span_context = OpenTelemetry::Trace.current_span(context).context
138138
_(span_context.hex_trace_id).must_equal('80f198ee56343ba864fe8b2a57d3eff7')

0 commit comments

Comments
 (0)