Class: OpenTracing::Instrumentation::Common::ErrorWriter

Inherits:
Object
  • Object
show all
Defined in:
lib/opentracing/instrumentation/common/error_writer.rb

Overview

ErrorWriter can be used to write error tag and log to span

Constant Summary collapse

LOG_ERROR_EVENT = 
'error'
ERROR_TAG = 
'error'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(set_error_tag: true, log_error_event: true) ⇒ ErrorWriter

Returns a new instance of ErrorWriter.

Parameters:

  • set_error_tag (TrueClass, ErrorClass) (defaults to: true) —

    enable set error tag

  • log_error_event (TrueClass, ErrorClass) (defaults to: true) —

    enable log exception



18
19
20
21
22
23
24
 
# File 'lib/opentracing/instrumentation/common/error_writer.rb', line 18

def initialize(
  set_error_tag: true,
  log_error_event: true
)
  @set_error_tag = set_error_tag
  @log_error_event = log_error_event
end

Instance Attribute Details

#log_error_event ⇒ Object (readonly)

Returns the value of attribute log_error_event.



13
14
15
 
# File 'lib/opentracing/instrumentation/common/error_writer.rb', line 13

def log_error_event
  @log_error_event
end

#set_error_tag ⇒ Object (readonly)

Returns the value of attribute set_error_tag.



13
14
15
 
# File 'lib/opentracing/instrumentation/common/error_writer.rb', line 13

def set_error_tag
  @set_error_tag
end

Instance Method Details

#==(other) ⇒ Object 



35
36
37
38
 
# File 'lib/opentracing/instrumentation/common/error_writer.rb', line 35

def ==(other)
  set_error_tag == other.set_error_tag &&
    log_error_event == other.log_error_event
end

#write_error(span, exception, event: LOG_ERROR_EVENT) ⇒ Object

Write error tag and log error event

Parameters:

  • span (OpenTracing::Span) —

    target for tag and log

  • exception (Exception) —

    logged to tag



29
30
31
32
33
 
# File 'lib/opentracing/instrumentation/common/error_writer.rb', line 29

def write_error(span, exception, event: LOG_ERROR_EVENT)
  tag_error(span)

  log_error(span, exception, event)
end