event_bus v1.6.1 EventBus.Model.Event

Structure and type for Event model

Link to this section Summary

Types

t()

Definition of the Event struct

Functions

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

Link to this section Types

Link to this type

t()

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

Link to this function

duration(event)

duration(EventBus.Model.Event.t()) :: integer()

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