Class: LogStruct::Log::Sidekiq::Error

Inherits:
T::Struct
  • Object
show all
Extended by:
T::Sig
Includes:
Interfaces::AdditionalDataField, Interfaces::CommonFields, LogStruct::Log::Shared::MergeAdditionalDataFields, LogStruct::Log::Shared::SerializeCommon
Defined in:
lib/log_struct/log/sidekiq/error.rb

Constant Summary

Constants included from LogStruct::Log::Shared::MergeAdditionalDataFields

LogStruct::Log::Shared::MergeAdditionalDataFields::RESERVED_KEYS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from LogStruct::Log::Shared::SerializeCommon

#as_json, #serialize, #serialize_common

Methods included from Interfaces::CommonFieldBase

#serialize

Methods included from LogStruct::Log::Shared::MergeAdditionalDataFields

#merge_additional_data_fields

Constructor Details

#initialize(source: Source::Sidekiq, event: Event::Error, timestamp:, level: Level::Info, error_class:, message:, backtrace: nil, error_context: nil, queue_name: nil, retry_count: nil, additional_data: nil) ⇒ void

Parameters:

  • source (Source::Sidekiq) (defaults to: Source::Sidekiq) —

    Shared/common fields

  • event (Event) (defaults to: Event::Error)
  • timestamp (Time)
  • level (Level) (defaults to: Level::Info)
  • error_class (T.class_of(Exception)) —

    Event-specific fields

  • message (String)
  • backtrace (Array<String>, nil) (defaults to: nil)
  • error_context (String, nil) (defaults to: nil)
  • queue_name (String, nil) (defaults to: nil)
  • retry_count (Integer, nil) (defaults to: nil)
  • additional_data (Hash{String, Symbol => T.untyped}, nil) (defaults to: nil) 



# File ''

const :source, Source::Sidekiq, default: Source::Sidekiq
const :event, Event, default: Event::Error
const :timestamp, Time, factory: -> { Time.now }
const :level, Level, default: Level::Info
const :error_class, T.class_of(Exception)
const :message, String
const :backtrace, T.nilable(T::Array[String]), default: nil
const :error_context, T.nilable(String), default: nil
const :queue_name, T.nilable(String), default: nil
const :retry_count, T.nilable(Integer), default: nil
const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil

Instance Attribute Details

#additional_data ⇒ Hash{String, Symbol => T.untyped}? (readonly)

Returns the value of prop additional_data.

Returns:

  • (Hash{String, Symbol => T.untyped}, nil) 



# File ''

const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil

#backtrace ⇒ Array<String>? (readonly)

Returns the value of prop backtrace.

Returns:

  • (Array<String>, nil) 



# File ''

const :backtrace, T.nilable(T::Array[String]), default: nil

#error_class ⇒ T.class_of(Exception) (readonly)

Event-specific fields

Returns:

  • (T.class_of(Exception)) 



# File ''

const :error_class, T.class_of(Exception)

#error_context ⇒ String? (readonly)

Returns the value of prop error_context.

Returns:

  • (String, nil) 



# File ''

const :error_context, T.nilable(String), default: nil

#event ⇒ Event (readonly)

Returns the value of prop event.

Returns:




# File ''

const :event, Event, default: Event::Error

#level ⇒ Level (readonly)

Returns the value of prop level.

Returns:




# File ''

const :level, Level, default: Level::Info

#message ⇒ String (readonly)

Returns the value of prop message.

Returns:

  • (String) 



# File ''

const :message, String

#queue_name ⇒ String? (readonly)

Returns the value of prop queue_name.

Returns:

  • (String, nil) 



# File ''

const :queue_name, T.nilable(String), default: nil

#retry_count ⇒ Integer? (readonly)

Returns the value of prop retry_count.

Returns:

  • (Integer, nil) 



# File ''

const :retry_count, T.nilable(Integer), default: nil

#source ⇒ Source::Sidekiq (readonly)

Shared/common fields

Returns:




# File ''

const :source, Source::Sidekiq, default: Source::Sidekiq

#timestamp ⇒ Time (readonly)

Returns the value of prop timestamp.

Returns:

  • (Time) 



# File ''

const :timestamp, Time, factory: -> { Time.now }

Instance Method Details

#to_h ⇒ Hash{LogStruct::LogField => T.untyped}

Returns:



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/log_struct/log/sidekiq/error.rb', line 50

def to_h
  h = T.let({}, T::Hash[LogStruct::LogField, T.untyped])
  h[LogField::ErrorClass] = error_class
  h[LogField::Message] = message
  h[LogField::Backtrace] = backtrace unless backtrace.nil?
  h[LogField::ErrorContext] = error_context unless error_context.nil?
  h[LogField::QueueName] = queue_name unless queue_name.nil?
  h[LogField::RetryCount] = retry_count unless retry_count.nil?
  h
end