Class: OpenTelemetry::Instrumentation::Trilogy::Instrumentation

Inherits:
Base
  • Object
show all
Defined in:
lib/opentelemetry/instrumentation/trilogy/instrumentation.rb

Overview

The Instrumentation class contains logic to detect and install the Trilogy instrumentation

Installation and configuration of this instrumentation is done within the OpenTelemetry::SDK#configure block, calling use() or use_all().

Configuration keys and options

:db_statement

Controls how SQL queries appear in spans.

  • :obfuscate (default) - Replaces literal values with ? to prevent sensitive data from being recorded.
  • :include - Records the raw SQL query as-is.
  • :omit - Excludes the SQL query attribute entirely.

:obfuscation_limit

Maximum length of the obfuscated SQL statement. Statements exceeding this limit are truncated. Default is 2000.

:peer_service

Sets the peer.service attribute on spans. Default is nil. Only applies when using old semantic conventions. Deprecated with no replacement.

:propagator

Propagator for injecting trace context into SQL comments.

  • 'none' (default) - Disables trace context propagation.
  • 'tracecontext' - Uses W3C Trace Context format via SQL comments.
  • 'vitess' - Uses Vitess-style propagation. Requires the opentelemetry-propagator-vitess gem.

:record_exception

Records exceptions as span events when an error occurs. Default is true.

:span_name

Controls how span names are generated. Only applies when using old semantic conventions; ignored for stable semantic conventions.

  • :statement_type (default) - Uses the SQL operation (e.g., SELECT).
  • :db_name - Uses the database name.
  • :db_operation_and_name - Combines the operation and database name.

Examples:

An explicit default configuration

OpenTelemetry::SDK.configure do |c|
  c.use_all({
    'OpenTelemetry::Instrumentation::Trilogy' => {
      db_statement: :obfuscate,
      obfuscation_limit: 2000,
      peer_service: nil,
      propagator: 'none',
      record_exception: true,
      span_name: :statement_type,
    },
  })
end

Instance Attribute Summary collapse

Instance Attribute Details

#propagator ⇒ Object (readonly)

Returns the value of attribute propagator.



96
97
98
 
# File 'lib/opentelemetry/instrumentation/trilogy/instrumentation.rb', line 96

def propagator
  @propagator
end

#semconv ⇒ Object (readonly)

Returns the value of attribute semconv.



96
97
98
 
# File 'lib/opentelemetry/instrumentation/trilogy/instrumentation.rb', line 96

def semconv
  @semconv
end