Class: LogStruct::Log::GoodJob::Finish

Inherits:
T::Struct
  • Object
show all
Extended by:
T::Sig
Includes:
Interfaces::CommonFields, Shared::SerializeCommon
Defined in:
lib/log_struct/log/good_job/finish.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Shared::SerializeCommon

#as_json, #serialize, #serialize_common

Methods included from Interfaces::CommonFields

#serialize

Constructor Details

#initialize(source: Source::Job, event: Event::Finish, timestamp:, level: Level::Info, job_id: nil, job_class: nil, queue_name: nil, arguments: nil, executions: nil, duration_ms:, finished_at:, process_id:, thread_id:, result: nil) ⇒ void

Parameters:

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

    Shared/common fields

  • event (Event) (defaults to: Event::Finish)
  • timestamp (Time)
  • level (Level) (defaults to: Level::Info)
  • job_id (String, nil) (defaults to: nil)
  • job_class (String, nil) (defaults to: nil)
  • queue_name (Symbol, nil) (defaults to: nil)
  • arguments (Array<T.untyped>, nil) (defaults to: nil)
  • executions (Integer, nil) (defaults to: nil)
  • duration_ms (Float) —

    Event-specific fields

  • finished_at (Time)
  • process_id (Integer)
  • thread_id (String)
  • result (String, nil) (defaults to: nil) 



# File ''

const :source, Source::Job, default: Source::Job
const :event, Event, default: Event::Finish
const :timestamp, Time, factory: -> { Time.now }
const :level, Level, default: Level::Info
const :job_id, T.nilable(String), default: nil
const :job_class, T.nilable(String), default: nil
const :queue_name, T.nilable(Symbol), default: nil
const :arguments, T.nilable(T::Array[T.untyped]), default: nil
const :executions, T.nilable(Integer), default: nil
const :duration_ms, Float
const :finished_at, Time
const :process_id, Integer
const :thread_id, String
const :result, T.nilable(String), default: nil

Instance Attribute Details

#arguments ⇒ Array<T.untyped>? (readonly)

Returns the value of prop arguments.

Returns:

  • (Array<T.untyped>, nil) 



# File ''

const :arguments, T.nilable(T::Array[T.untyped]), default: nil

#duration_ms ⇒ Float (readonly)

Event-specific fields

Returns:

  • (Float) 



# File ''

const :duration_ms, Float

#event ⇒ Event (readonly)

Returns the value of prop event.

Returns:




# File ''

const :event, Event, default: Event::Finish

#executions ⇒ Integer? (readonly)

Returns the value of prop executions.

Returns:

  • (Integer, nil) 



# File ''

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

#finished_at ⇒ Time (readonly)

Returns the value of prop finished_at.

Returns:

  • (Time) 



# File ''

const :finished_at, Time

#job_class ⇒ String? (readonly)

Returns the value of prop job_class.

Returns:

  • (String, nil) 



# File ''

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

#job_id ⇒ String? (readonly)

Returns the value of prop job_id.

Returns:

  • (String, nil) 



# File ''

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

#level ⇒ Level (readonly)

Returns the value of prop level.

Returns:




# File ''

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

#process_id ⇒ Integer (readonly)

Returns the value of prop process_id.

Returns:

  • (Integer) 



# File ''

const :process_id, Integer

#queue_name ⇒ Symbol? (readonly)

Returns the value of prop queue_name.

Returns:

  • (Symbol, nil) 



# File ''

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

#result ⇒ String? (readonly)

Returns the value of prop result.

Returns:

  • (String, nil) 



# File ''

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

#source ⇒ Source::Job (readonly)

Shared/common fields

Returns:




# File ''

const :source, Source::Job, default: Source::Job

#thread_id ⇒ String (readonly)

Returns the value of prop thread_id.

Returns:

  • (String) 



# File ''

const :thread_id, String

#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
60
61
62
63
 
# File 'lib/log_struct/log/good_job/finish.rb', line 50

def to_h
  h = T.let({}, T::Hash[LogStruct::LogField, T.untyped])
  h[LogField::JobId] = job_id unless job_id.nil?
  h[LogField::JobClass] = job_class unless job_class.nil?
  h[LogField::QueueName] = queue_name unless queue_name.nil?
  h[LogField::Arguments] = arguments unless arguments.nil?
  h[LogField::Executions] = executions unless executions.nil?
  h[LogField::DurationMs] = duration_ms
  h[LogField::FinishedAt] = finished_at
  h[LogField::ProcessId] = process_id
  h[LogField::ThreadId] = thread_id
  h[LogField::Result] = result unless result.nil?
  h
end