Class: LogStruct::Log::Ahoy

Inherits:
T::Struct
  • Object
show all
Extended by:
T::Sig
Includes:
Interfaces::CommonFields, Shared::SerializeCommon
Defined in:
lib/log_struct/log/ahoy.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::App, event: Event::Log, timestamp:, level: Level::Info, message:, ahoy_event:, properties: nil) ⇒ void

Parameters:

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

    Shared/common fields

  • event (Event) (defaults to: Event::Log)
  • timestamp (Time)
  • level (Level) (defaults to: Level::Info)
  • message (String) —

    Event-specific fields

  • ahoy_event (String)
  • properties (Hash{Symbol => T.untyped}, nil) (defaults to: nil) 



# File ''

const :source, Source::App, default: Source::App
const :event, Event, default: Event::Log
const :timestamp, Time, factory: -> { Time.now }
const :level, Level, default: Level::Info
const :message, String
const :ahoy_event, String
const :properties, T.nilable(T::Hash[Symbol, T.untyped]), default: nil

Instance Attribute Details

#ahoy_event ⇒ String (readonly)

Returns the value of prop ahoy_event.

Returns:

  • (String) 



# File ''

const :ahoy_event, String

#event ⇒ Event (readonly)

Returns the value of prop event.

Returns:




# File ''

const :event, Event, default: Event::Log

#level ⇒ Level (readonly)

Returns the value of prop level.

Returns:




# File ''

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

#message ⇒ String (readonly)

Event-specific fields

Returns:

  • (String) 



# File ''

const :message, String

#properties ⇒ Hash{Symbol => T.untyped}? (readonly)

Returns the value of prop properties.

Returns:

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



# File ''

const :properties, T.nilable(T::Hash[Symbol, T.untyped]), default: nil

#source ⇒ Source::App (readonly)

Shared/common fields

Returns:




# File ''

const :source, Source::App, default: Source::App

#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:



41
42
43
44
45
46
47
 
# File 'lib/log_struct/log/ahoy.rb', line 41

def to_h
  h = T.let({}, T::Hash[LogStruct::LogField, T.untyped])
  h[LogField::Message] = message
  h[LogField::AhoyEvent] = ahoy_event
  h[LogField::Properties] = properties unless properties.nil?
  h
end