EventBus.Model.Event (event_bus v1.7.0) View Source

Structure and type for Event model.

Link to this section Summary

Types

t()

Definition of the Event struct.

Functions

duration(event)

Calculates the duration of the event, and simple answer of how long does it take to generate this event.

Link to this section Types

t()

Specs

t() :: %EventBus.Model.Event{
  data: any(),
  id: String.t() | integer(),
  initialized_at: integer() | nil,
  occurred_at: integer() | nil,
  source: String.t() | nil,
  topic: atom(),
  transaction_id: String.t() | integer() | nil,
  ttl: integer() | nil
}

Definition of the Event struct.

:id - Identifier
:transaction_id - Transaction identifier, if event belongs to a transaction
:topic - Topic name
:data - Context
:initialized_at - When the process initialized to generate this event
:occurred_at - When it is occurred
:source - Who created this event: module, function or service name are good
:ttl - Time to live value

Link to this section Functions

duration(event)

Specs

duration(t()) :: integer()

Calculates the duration of the event, and simple answer of how long does it take to generate this event.