OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
+
+
The OpenTelemetry module provides global accessors for telemetry objects.
Used to chain modifications to baggage. The result is a context with an updated baggage. If only a single modification is being made to baggage, use the other methods on Baggage, if multiple modifications are being made, use this one.
This is here to store properties received from other W3C Baggage impelmentations but is not exposed in OpenTelemetry. This is condsidered private API and not for use by end-users.
This is here to store properties received from other W3C Baggage impelmentations but is not exposed in OpenTelemetry. This is condsidered private API and not for use by end-users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+27
+28
+29
+
+
+
# File 'lib/opentelemetry/baggage/builder.rb', line 27
+
+defset_value(key,value,metadata:nil)
+ @entries[key]=OpenTelemetry::Baggage::Entry.new(value,metadata)
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/opentelemetry-api/v1.3.0/OpenTelemetry/Baggage/Entry.html b/opentelemetry-api/v1.3.0/OpenTelemetry/Baggage/Entry.html
new file mode 100644
index 000000000..6f0ae9d2e
--- /dev/null
+++ b/opentelemetry-api/v1.3.0/OpenTelemetry/Baggage/Entry.html
@@ -0,0 +1,370 @@
+
+
+
+
+
+
+ Class: OpenTelemetry::Baggage::Entry
+
+ — OpenTelemetry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/opentelemetry/baggage/propagation/text_map_propagator.rb', line 54
+
+defextract(carrier,context:Context.current,getter:Context::Propagation.text_map_getter)
+ header=getter.get(carrier,BAGGAGE_KEY)
+ returncontextifheader.nil?||header.empty?
+
+ entries=header.gsub(/\s/,'').split(',')
+
+ OpenTelemetry::Baggage.build(context:context)do|builder|
+ entries.eachdo|entry|
+ # Note metadata is currently unused in OpenTelemetry, but is part
+# the W3C spec where it's referred to as properties. We preserve
+# the properties (as-is) so that they can be propagated elsewhere.
+kv,meta=entry.split(';',2)
+ k,v=kv.split('=').map!(&CGI.method(:unescape))
+ builder.set_value(k,v,metadata:meta)
+ end
+ end
+rescueStandardError=>e
+ OpenTelemetry.logger.debug"Error extracting W3C baggage: #{e.message}"
+ context
+end
+
+
+
+
+
+
+
+
+ #fields ⇒ Array<String>
+
+
+
+
+
+
+
+
+
Returns the predefined propagation fields. If your carrier is reused, you should delete the fields returned by this method before calling inject.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Array<String>)
+
+
+
+ —
+
+
a list of fields that will be used by this propagator.
+
+
+
+
+
+
+
+
+
+
+
+
+79
+80
+81
+
+
+
# File 'lib/opentelemetry/baggage/propagation/text_map_propagator.rb', line 79
+
+deffields
+ FIELDS
+end
Clears the fiber-local Context stack. This allocates a new array for the stack, which is important in some use-cases to avoid sharing the backing array between fibers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+119
+120
+121
+
+
+
# File 'lib/opentelemetry/context.rb', line 119
+
+defclear
+ Thread.current[STACK_KEY]=[]
+end
# File 'lib/opentelemetry/context.rb', line 31
+
+defcurrent
+ stack.last||ROOT
+end
+
+
+
+
+
+
+
+
+ .detach(token) ⇒ Boolean
+
+
+
+
+
+
+
+
+
Restores the previous Context associated with the current Fiber. The supplied token is used to check if the call to detach is balanced with a corresponding attach call. A warning is logged if the calls are unbalanced.
+
+
+
+
+
+
Parameters:
+
+
+
+
+ token
+
+
+ (Object)
+
+
+
+ —
+
+
The token provided by the matching call to attach
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Boolean)
+
+
+
+ —
+
+
True if the calls matched, false otherwise
+
+
+
+
+
+
+
+
+
+
+
+
+55
+56
+57
+58
+59
+60
+61
+62
+
+
+
# File 'lib/opentelemetry/context.rb', line 55
+
+defdetach(token)
+ s=stack
+ calls_matched=(token==s.size)
+ OpenTelemetry.handle_error(exception:DetachError.new('calls to detach should match corresponding calls to attach.'))unlesscalls_matched
+
+ s.pop
+ calls_matched
+end
+
+
+
+
+
+
+
+
+ .empty ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
+123
+124
+125
+
+
+
# File 'lib/opentelemetry/context.rb', line 123
+
+defempty
+ new(EMPTY_ENTRIES)
+end
+
+
+
+
+
+
+
+
+ .value(key) ⇒ Object
+
+
+
+
+
+
+
+
+
Returns the value associated with key in the current context
+
+
+
+
+
+
Parameters:
+
+
+
+
+ key
+
+
+ (String)
+
+
+
+ —
+
+
The lookup key
+
+
+
+
+
+
+
+
+
+
+
+
+
+112
+113
+114
+
+
+
# File 'lib/opentelemetry/context.rb', line 112
+
+defvalue(key)
+ current.value(key)
+end
The propagation module contains APIs and utilities to interact with context and propagate across process boundaries.
+
+
The API implicitly defines 3 interfaces: TextMapPropagator, TextMapInjector and TextMapExtractor. Concrete implementations of TextMapPropagator are provided. Custom text map propagators can leverage these implementations or simply implement the expected interface. The interfaces are described below.
The API provides 3 TextMapPropagator implementations: - A default NoopTextMapPropagator that implements inject and extract methods as no-ops. Its fields method returns an empty list. - A TextMapPropagator that composes an Injector and an Extractor. Its fields method delegates to the provided Injector. - A CompositeTextMapPropagator that wraps either a list of text map propagators or a list of Injectors and a list of Extractors. Its fields method returns the union of fields returned by the Injectors it wraps.
Returns a TextMapSetter instance suitable for writing values into a hash-like carrier.
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Details
+
+
+
+
+
+ #rack_env_getter ⇒ Object
+
+
+
+
+
+
+
+
Deprecated.
+
Use the rack env getter found in the
+
+
+
opentelemetry-common gem instead. Returns a RackEnvGetter instance suitable for reading values from a Rack environment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+74
+75
+76
+77
+78
+
+
+
# File 'lib/opentelemetry/context/propagation.rb', line 74
+
+defrack_env_getter
+ OpenTelemetry.logger.warn('OpenTelemetry::Context::Propagation.rack_env_getter has been deprecated \
+ use OpenTelemetry::Common::Propagation.rack_env_getter from the opentelemetry-common gem instead.')
+ RACK_ENV_GETTER
+end
+
+
+
+
+
+
+
+
+ #text_map_getter ⇒ Object
+
+
+
+
+
+
+
+
+
Returns a TextMapGetter instance suitable for reading values from a hash-like carrier
+
+
+
+
+
+
+
+
+
+
+
+
+
+60
+61
+62
+
+
+
# File 'lib/opentelemetry/context/propagation.rb', line 60
+
+deftext_map_getter
+ TEXT_MAP_GETTER
+end
+
+
+
+
+
+
+
+
+ #text_map_setter ⇒ Object
+
+
+
+
+
+
+
+
+
Returns a TextMapSetter instance suitable for writing values into a hash-like carrier
+
+
+
+
+
+
+
+
+
+
+
+
+
+66
+67
+68
+
+
+
# File 'lib/opentelemetry/context/propagation.rb', line 66
+
+deftext_map_setter
+ TEXT_MAP_SETTER
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/opentelemetry-api/v1.3.0/OpenTelemetry/Context/Propagation/CompositeTextMapPropagator.html b/opentelemetry-api/v1.3.0/OpenTelemetry/Context/Propagation/CompositeTextMapPropagator.html
new file mode 100644
index 000000000..7a1fec0a9
--- /dev/null
+++ b/opentelemetry-api/v1.3.0/OpenTelemetry/Context/Propagation/CompositeTextMapPropagator.html
@@ -0,0 +1,836 @@
+
+
+
+
+
+
+ Class: OpenTelemetry::Context::Propagation::CompositeTextMapPropagator
+
+ — OpenTelemetry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A composite text map propagator either composes a list of injectors and a list of extractors, or wraps a list of propagators, into a single interface exposing inject and extract methods. Injection and extraction will preserve the order of the injectors and extractors (or propagators) passed in during initialization.
# File 'lib/opentelemetry/context/propagation/composite_text_map_propagator.rb', line 24
+
+defcompose(injectors:,extractors:)
+ raiseArgumentError,'injectors and extractors must both be non-nil arrays'unlessinjectors.is_a?(Array)&&extractors.is_a?(Array)
+
+ new(injectors:injectors,extractors:extractors)
+end
Runs extractors or propagators in order and returns a Context updated with the results of each extraction. If an extraction fails, a warning will be logged and remaining extractors will continue to be executed. Always returns a valid context.
a new context updated with state extracted from the carrier
+
+
+
+
+
+
+
+
+
+
+
+
+83
+84
+85
+86
+87
+88
+89
+90
+91
+
+
+
# File 'lib/opentelemetry/context/propagation/composite_text_map_propagator.rb', line 83
+
+defextract(carrier,context:Context.current,getter:Context::Propagation.text_map_getter)
+ extractors=@extractors||@propagators
+ extractors.inject(context)do|ctx,extractor|
+ extractor.extract(carrier,context:ctx,getter:getter)
+ rescueStandardError=>e
+ OpenTelemetry.logger.warn"Error in CompositePropagator#extract #{e.message}"
+ ctx
+ end
+end
+
+
+
+
+
+
+
+
+ #fields ⇒ Array<String>
+
+
+
+
+
+
+
+
+
Returns the union of the propagation fields returned by the composed injectors or propagators. If your carrier is reused, you should delete the fields returned by this method before calling inject.
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (Array<String>)
+
+
+
+ —
+
+
a list of fields that will be used by this propagator.
The RackEnvGetter class provides a common methods for reading keys from a rack environment. It abstracts away the rack-normalization process so that keys can be looked up without having to transform them first. With this class you can get traceparent instead of HTTP_TRACEPARENT
Reads all keys from a carrier and converts them from the rack-normalized form to the original.
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Details
+
+
+
+
+
+ #get(carrier, key) ⇒ Object
+
+
+
+
+
+
+
+
+
Converts key into a rack-normalized key and reads it from the carrier. Useful for extract operations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+21
+22
+23
+
+
+
# File 'lib/opentelemetry/context/propagation/rack_env_getter.rb', line 21
+
+defget(carrier,key)
+ carrier[to_rack_key(key)]||carrier[key]
+end
+
+
+
+
+
+
+
+
+ #keys(carrier) ⇒ Object
+
+
+
+
+
+
+
+
+
Reads all keys from a carrier and converts them from the rack-normalized form to the original. The resulting keys will be lowercase and underscores will be replaced with dashes.
+
+
+
+
+
+
+
+
+
+
+
+
+
+28
+29
+30
+
+
+
# File 'lib/opentelemetry/context/propagation/rack_env_getter.rb', line 28
+
+defkeys(carrier)
+ carrier.keys.map(&method(:from_rack_key))
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/opentelemetry-api/v1.3.0/OpenTelemetry/Context/Propagation/TextMapGetter.html b/opentelemetry-api/v1.3.0/OpenTelemetry/Context/Propagation/TextMapGetter.html
new file mode 100644
index 000000000..b65618bd6
--- /dev/null
+++ b/opentelemetry-api/v1.3.0/OpenTelemetry/Context/Propagation/TextMapGetter.html
@@ -0,0 +1,279 @@
+
+
+
+
+
+
+ Class: OpenTelemetry::Context::Propagation::TextMapGetter
+
+ — OpenTelemetry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/opentelemetry/context/propagation/text_map_propagator.rb', line 18
+
+definitialize(injector,extractor)
+ raiseArgumentError,'injector and extractor must both be non-nil'ifinjector.nil?||extractor.nil?
+
+ @injector=injector
+ @extractor=extractor
+end
+ This class is part of a private API.
+ You should avoid using this class if possible, as it may be removed or be changed in the future.
+
+
+
ProxyTracer is an implementation of Trace::Tracer. It is returned from the ProxyTracerProvider until a delegate tracer provider is installed. After the delegate tracer provider is installed, the ProxyTracer will delegate to the corresponding “real” tracer.
+ This class is part of a private API.
+ You should avoid using this class if possible, as it may be removed or be changed in the future.
+
+
+
ProxyTracerProvider is an implementation of Trace::TracerProvider. It is the default global tracer provider returned by OpenTelemetry.tracer_provider. It delegates to a “real” TracerProvider after the global tracer provider is registered. It returns ProxyTracer instances until the delegate is installed.
The Trace API allows recording a set of events, triggered as a result of a single logical operation, consolidated across various components of an application.
Wraps a SpanContext with an object implementing the Span interface. This is done in order to expose a SpanContext as a Span in operations such as in-process Span propagation.
A link to a Span. Used (for example) in batching operations, where a single batch handler processes multiple requests from different traces. A Link can be also used to reference spans from the same trace. A Link and its attributes are immutable.
Span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency and, optionally, one or more sub-spans for its sub-operations.
+
+
Once Span is created - Span operations can be used to add additional properties to it like attributes, links, events, name and resulting status. Span cannot be used to retrieve these properties. This prevents the mis-use of spans as an in-process information propagation mechanism.
Values must be non-nil and (array of) string, boolean or numeric type. Array values must not contain nil elements and all elements must be of the same basic type (string, numeric, boolean).
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (self)
+
+
+
+ —
+
+
returns itself
+
+
+
+
+
+
+
+
+
+
+
+
+77
+78
+79
+
+
+
# File 'lib/opentelemetry/trace/span.rb', line 77
+
+defadd_attributes(attributes)
+ self
+end
Adding links at span creation using the links option is preferred to calling add_link later, because head sampling decisions can only consider information present during span creation.
Implementations MUST ignore all subsequent calls to #finish (there might be exceptions when Tracer is streaming event and has no mutable state associated with the Span).
+
+
Call to #finish MUST not have any effects on child spans. Those may still be running and can be ended later.
Values must be non-nil and (array of) string, boolean or numeric type. Array values must not contain nil elements and all elements must be of the same basic type (string, numeric, boolean).
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (self)
+
+
+
+ —
+
+
returns itself
+
+
+
+
+
+
+
+
+
+
+
+
+59
+60
+61
+
+
+
# File 'lib/opentelemetry/trace/span.rb', line 59
+
+defset_attribute(key,value)
+ self
+end
+
+
+
+
+
+
+
+
+ #status=(status) ⇒ void
+
+
+
+
+
+
+
+
This method returns an undefined value.
+
Sets the Status to the Span
+
+
If used, this will override the default Span status. Default status is unset.
+
+
Only the value of the last call will be recorded, and implementations are free to ignore previous calls.
A SpanContext contains the state that must propagate to child Spans and across process boundaries. It contains the identifiers (a trace ID and span ID) associated with the Span, a set of TraceFlags, a system-specific tracestate, and a boolean indicating that the SpanContext was extracted from the wire.
Type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship. For API ergonomics, use of the symbols rather than the constants may be preferred. For example:
Default value. Indicates that the span is used internally.
+
+
+
+
+
+
+
+
+
+
:internal
+
+
SERVER =
+
+
+
+
Indicates that the span covers server-side handling of an RPC or other remote request.
+
+
+
+
+
+
+
+
+
+
:server
+
+
CLIENT =
+
+
+
+
Indicates that the span covers the client-side wrapper around an RPC or other remote request.
+
+
+
+
+
+
+
+
+
+
:client
+
+
PRODUCER =
+
+
+
+
Indicates that the span describes producer sending a message to a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.
+
+
+
+
+
+
+
+
+
+
:producer
+
+
CONSUMER =
+
+
+
+
Indicates that the span describes consumer recieving a message from a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.
+
+
+
+
+
+
+
+
+
+
:consumer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/opentelemetry-api/v1.3.0/OpenTelemetry/Trace/Status.html b/opentelemetry-api/v1.3.0/OpenTelemetry/Trace/Status.html
new file mode 100644
index 000000000..7cf54bae2
--- /dev/null
+++ b/opentelemetry-api/v1.3.0/OpenTelemetry/Trace/Status.html
@@ -0,0 +1,876 @@
+
+
+
+
+
+
+ Class: OpenTelemetry::Trace::Status
+
+ — OpenTelemetry
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
The constructor is private and only for use internally by the class. Users should use the unset, error, or ok factory methods to obtain a OpenTelemetry::Trace::Status instance.
TraceFlags contain details about the trace. Unlike Tracestate values, TraceFlags are present in all traces. Currently, the only TraceFlag is a boolean #sampled?flag.
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
The constructor is private and only for use internally by the class. Users should use the from_byte factory method to obtain a OpenTelemetry::Trace::TraceFlags instance.
+
+
+
+
+
+
Parameters:
+
+
+
+
+ flags
+
+
+ (Integer)
+
+
+
+ —
+
+
8-bit byte of bit flags
+
+
+
+
+
+
+
+
+
+
+
+
+
+34
+35
+36
+
+
+
# File 'lib/opentelemetry/trace/trace_flags.rb', line 34
+
+definitialize(flags)
+ @flags=flags
+end
This is a helper for the default use-case of extending the current trace with a span.
+
+
With this helper:
+
+
OpenTelemetry.tracer.in_span('do-the-thing') do … end
+
+
Equivalent without helper:
+
+
OpenTelemetry::Trace.with_span(tracer.start_span('do-the-thing')) do … end
+
+
On exit, the Span that was active before calling this method will be reactivated. If an exception occurs during the execution of the provided block, it will be recorded on the span and reraised.
Tracestate is a part of SpanContext, represented by an immutable list of string key/value pairs and formally defined by the W3C Trace Context specification www.w3.org/TR/trace-context/
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
Returns a new Tracestate created from the Hash provided. This skips validation of the keys and values, assuming they are already valid. This method is intended only for the use of instance methods in this class.
+
+
+
+
+
+
+
+
+
+
+
+
+
+59
+60
+61
+
+
+
# File 'lib/opentelemetry/trace/tracestate.rb', line 59
+
+defcreate(hash)
+ new(hash)
+end
Key-value pairs to store in the Tracestate. Keys and values are validated against the W3C Trace Context specification, and any invalid members are logged at DEBUG level and dropped.
Adds a new key/value pair or updates an existing value for a given key. Keys and values are validated against the W3C Trace Context specification, and any invalid members are logged at DEBUG level and ignored.
FIXED: SystemStackError in Composite Text Map Propagator (#1590)
+
+
+
v1.2.3 / 2023-09-18
+
+
FIXED: Optimize span and trace ID generation
+
+
FIXED: Small perf improvement to generate_r
+
+
+
v1.2.2 / 2023-08-15
+
+
FIXED: Patch the issue for frozen string on ruby < 3.0 with string interpolation
+
+
FIXED: Performance regression in_span
+
+
FIXED: In_span performance
+
+
+
v1.2.1 / 2023-07-29
+
+
DOCS: Describe Tracer#in_span arguments
+
+
+
v1.2.0 / 2023-06-08
+
+
BREAKING CHANGE: Remove support for EoL Ruby 2.7
+
+
ADDED: Remove support for EoL Ruby 2.7
+
+
+
v1.1.0 / 2022-09-14
+
+
ADDED: Consistent probability sampler
+
+
FIXED: Get API onto rubocop 1.3
+
+
+
v1.0.2 / 2022-05-02
+
+
FIXED: Text map propagator extraction should use argument context
+
+
+
v1.0.1 / 2021-12-01
+
+
FIXED: Deprecate api rack env getter
+
+
+
v1.0.0 / 2021-09-29
+
+
(No significant changes)
+
+
+
v1.0.0.rc3 / 2021-08-12
+
+
BREAKING CHANGE: Remove optional parent_context from in_span
+
+
BREAKING CHANGE: Refactor Baggage to remove Noop*
+
+
BREAKING CHANGE: Total order constraint on span.status=
+
+
ADDED: Add Tracer.non_recording_span to API
+
+
ADDED: Make API's NoopTextMapPropagator private
+
+
FIXED: Remove optional parent_context from in_span
+
+
FIXED: Reduce span allocation in API
+
+
FIXED: Refactor Baggage to remove Noop*
+
+
FIXED: Total order constraint on span.status=
+
+
FIXED: Return early if carrier is nil
+
+
FIXED: Update context to match spec
+
+
FIXED: Return the original context if the baggage header value is empty
+
+
DOCS: Update docs to rely more on environment variable configuration
+
+
+
v1.0.0.rc2 / 2021-06-23
+
+
BREAKING CHANGE: Remove optional parent_context from in_span 729
+
+
BREAKING CHANGE: Refactor Baggage to remove Noop* 800
+
+
The noop baggage manger has been removed.
+
+
The baggage management methods are now available through OpenTelemetry::Baggage#method, previously OpenTelemetry.baggage#method
+
+
BREAKING CHANGE: Total order constraint on span.status= 805
+
+
The OpenTelemetry::Trace::Util::HttpToStatus module has been removed as it was incorrectly setting the span status to OK for codes codes in the range 100..399
+
+
The HttpToStatus module can be replaced inline as follows span.status = OpenTelemetry::Trace::Status.error unless (100..399).include?(response_code.to_i)
+
+
The Status.new(code, description:) initializer has been hidden in favour of simpler constructors for each status code: Status.ok, Status.error and Status.unset. Each constructor takes an optional description.
The opentelemetry-api gem defines the core OpenTelemetry interfaces for Ruby applications. Using opentelemetry-api, a library or application can code against the OpenTelemetry interfaces to produce telemetry data such as distributed traces and metrics.
+
+
What is OpenTelemetry?
+
+
OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
+
+
OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
+
+
How does this gem fit in?
+
+
The opentelemetry-api gem defines the core OpenTelemetry interfaces in the form of abstract classes and no-op implementations. That is, it defines interfaces and data types sufficient for a library or application to code against to produce telemetry data, but does not actually collect, analyze, or export the data.
+
+
To collect and analyze telemetry data, applications should also install a concrete implementation of the API, such as the opentelemetry-sdk gem. However, libraries that produce telemetry data should depend only on opentelemetry-api, deferring the choise of concrete implementation to the application developer.
+
+
How do I get started?
+
+
Install the gem using:
+
+
geminstallopentelemetry-api
+
+
+
Or, if you use bundler, include opentelemetry-api in your Gemfile.
+
+
Then, use the OpenTelemetry interfaces to produces traces and other telemetry data. Following is a basic example.
+
+
require'opentelemetry'
+
+# Obtain the current default tracer provider
+provider=OpenTelemetry.tracer_provider
+
+# Create a trace
+tracer=provider.tracer('my_app','1.0')
+
+# Record spans
+tracer.in_span('my_task')do|task_span|
+ tracer.in_span('inner')do|inner_span|
+ # Do something here
+end
+end
+
The opentelemetry-api gem source is on github, along with related gems including opentelemetry-sdk.
+
+
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in GitHub Discussions or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.
+
+
License
+
+
The opentelemetry-api gem is distributed under the Apache 2.0 license. See LICENSE for more information.
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/opentelemetry-api/v1.3.0/file_list.html b/opentelemetry-api/v1.3.0/file_list.html
new file mode 100644
index 000000000..18ae61872
--- /dev/null
+++ b/opentelemetry-api/v1.3.0/file_list.html
@@ -0,0 +1,61 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ File List
+
+
+
+
The opentelemetry-api gem defines the core OpenTelemetry interfaces for Ruby applications. Using opentelemetry-api, a library or application can code against the OpenTelemetry interfaces to produce telemetry data such as distributed traces and metrics.
+
+
What is OpenTelemetry?
+
+
OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
+
+
OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
+
+
How does this gem fit in?
+
+
The opentelemetry-api gem defines the core OpenTelemetry interfaces in the form of abstract classes and no-op implementations. That is, it defines interfaces and data types sufficient for a library or application to code against to produce telemetry data, but does not actually collect, analyze, or export the data.
+
+
To collect and analyze telemetry data, applications should also install a concrete implementation of the API, such as the opentelemetry-sdk gem. However, libraries that produce telemetry data should depend only on opentelemetry-api, deferring the choise of concrete implementation to the application developer.
+
+
How do I get started?
+
+
Install the gem using:
+
+
geminstallopentelemetry-api
+
+
+
Or, if you use bundler, include opentelemetry-api in your Gemfile.
+
+
Then, use the OpenTelemetry interfaces to produces traces and other telemetry data. Following is a basic example.
+
+
require'opentelemetry'
+
+# Obtain the current default tracer provider
+provider=OpenTelemetry.tracer_provider
+
+# Create a trace
+tracer=provider.tracer('my_app','1.0')
+
+# Record spans
+tracer.in_span('my_task')do|task_span|
+ tracer.in_span('inner')do|inner_span|
+ # Do something here
+end
+end
+
The opentelemetry-api gem source is on github, along with related gems including opentelemetry-sdk.
+
+
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in GitHub Discussions or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.
+
+
License
+
+
The opentelemetry-api gem is distributed under the Apache 2.0 license. See LICENSE for more information.