class Labkit::Tracing::TracingUtils
Internal methods for tracing. This is not part of the LabKit public API. For internal usage only
Public Class Methods
include_stacktrace?(operation_name)
click to toggle source
# File lib/labkit/tracing/tracing_utils.rb, line 73 def self.include_stacktrace?(operation_name) @include_stacktrace ||= Hash.new do |result, name| result[name] = Tracing.stacktrace_operations.any? { |stacktrace_operation| name.starts_with?(stacktrace_operation) } end @include_stacktrace[operation_name] end
log_common_fields_on_span(span, operation_name)
click to toggle source
Add common fields to a span
# File lib/labkit/tracing/tracing_utils.rb, line 44 def self.log_common_fields_on_span(span, operation_name) correlation_id = Labkit::Correlation::CorrelationId.current_id span.set_tag("correlation_id", correlation_id) if correlation_id span.log_kv(stack: caller.join('\n')) if include_stacktrace?(operation_name) end
log_exception_on_span(span, exception)
click to toggle source
Add exception logging to a span
# File lib/labkit/tracing/tracing_utils.rb, line 51 def self.log_exception_on_span(span, exception) return if exception.blank? span.set_tag("error", true) span.log_kv(**kv_tags_for_exception(exception)) end
postnotify_span(operation_name, start_time, end_time, tags: nil, child_of: nil, exception: nil)
click to toggle source
Generate a span retrospectively
# File lib/labkit/tracing/tracing_utils.rb, line 34 def self.postnotify_span(operation_name, start_time, end_time, tags: nil, child_of: nil, exception: nil) span = OpenTracing.start_span(operation_name, start_time: start_time, tags: tags, child_of: child_of) log_common_fields_on_span(span, operation_name) log_exception_on_span(span, exception) if exception span.finish(end_time: end_time) end
tracer()
click to toggle source
Obtain a tracer instance
# File lib/labkit/tracing/tracing_utils.rb, line 29 def self.tracer OpenTracing.global_tracer end
with_tracing(operation_name:, tags:, child_of: nil) { |span| ... }
click to toggle source
Convience method for running a block with a span
# File lib/labkit/tracing/tracing_utils.rb, line 12 def self.with_tracing(operation_name:, tags:, child_of: nil) scope = tracer.start_active_span(operation_name, child_of: child_of, tags: tags) span = scope.span log_common_fields_on_span(span, operation_name) begin yield span rescue StandardError => e log_exception_on_span(span, e) raise e ensure scope.close end end