module OpenTelemetry

Overview

## Global Trace Provider
----------------------------------------------------------------

OpenTelemetry.configure do |config|
  config.service_name = "my_app_or_library"
  config.service_version = "1.1.1"
  config.exporter = OpenTelemetry::Exporter.new(variant: :stdout)
end

trace = OpenTelemetry.trace_provider("my_app_or_library", "1.1.1").trace
trace = OpenTelemetry.trace_provider do |provider|
  provider.service_name = "my_app_or_library"
  provider.service_version = "1.1.1"
end.trace

## Trace Providers as Objects With Unique Configuration
----------------------------------------------------------------

provider_a = OpenTelemetry::TraceProvider.new("my_app_or_library", "1.1.1")
provider_a.exporter = OpenTelemetry::Exporter.new(variant: :stdout)

provider_b = OpenTelementry::TraceProvider.new do |config|
  config.service_name = "my_app_or_library"
  config.service_version = "1.1.1"
  config.exporter = OpenTelemetry::Exporter.new(variant: :stdout)
end

## Getting a Trace From a Provider Object
----------------------------------------------------------------

trace = provider_a.trace # Inherit all configuration from the Provider Object

trace = provider_a.trace("microservice foo", "1.2.3") # Override the configuration

trace = provider_a.trace do |provider|
  provider.service_name = "microservice foo"
  provider.service_version = "1.2.3"
end.trace

## Creating Spans Using a Trace
----------------------------------------------------------------

trace.in_span("request") do |span|
  span.set_attribute("verb", "GET")
  span.set_attribute("url", "http://example.com/foo")
  span.add_event("dispatching to handler")
  trace.in_span("handler") do |child_span|
    child_span.add_event("handling request")
    trace.in_span("db") do |child_span|
      child_span.add_event("querying database")
    end
  end
end

Defined in:

Constant Summary

INSTANCE_ID = CSUUID.unique.to_s

NAME = "OpenTelemetry Crystal"

VERSION = SDK::VERSION

Class Method Summary

• .clock : Clock

  .clock class property allows alternative implementations for testing or simulations

• .clock=(clock : Clock)

  .clock class property allows alternative implementations for testing or simulations

• .config : TraceProvider::Configuration

  The .config class property provides direct access to the global default TracerProvider configuration.

• .config=(config : TraceProvider::Configuration)

  The .config class property provides direct access to the global default TracerProvider configuration.

• .configure(&block : TraceProvider::Configuration::Factory -> )

  Use this method to configure the global trace provider.

• .configure

  Calling .configure with no block results in a global TracerProvider being configured with the default configuration.

• .current_span

  Returns the current active Span in the current fiber, or nil if there is no currently active Span.

• .handle_error(error)
• .instrumentation_library
• .instrumentation_scope
• .provider : TraceProvider

  .provider class property provides direct access to the global default Tracerprovider instance.

• .provider=(provider : TraceProvider)

  .provider class property provides direct access to the global default Tracerprovider instance.

• .trace

  Returns the currently active Tracer in the current fiber.

• .trace(&)

  Invokes the provided block with either the currently active Tracer, if one exists, or a new Tracer, if there isn't one currently active.

• .trace_provider(service_name : String | Nil = nil, service_version : String | Nil = nil, exporter = nil)

  Configure and return a new TracerProvider instance, using the method arguments.

• .trace_provider(&block : TraceProvider::Configuration::Factory -> )

  Configure and return a new TracerProvider instance, using the provided block.

• .tracer

  Alias.

• .tracer(&)

  Alias.

• .tracer_provider(service_name : String | Nil = nil, service_version : String | Nil = nil, exporter = nil)

  Alias.

• .tracer_provider(&block : TraceProvider::Configuration::Factory -> )

  Alias.

• .with_clock(clock : Clock, &)

Macro Summary

• close_span
• in_span(span_name, &block)

Class Method Detail

# Depend on SDK environment variables ([https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md))
# for all configuration.
OpenTelememtry.configure

Macro Detail