Timber

v0.4.7

Timber

Timber v0.4.7 Timber.Events.CustomEvent

Allows for custom events that aren’t covered elsewhere.

Custom events can be used to encode information about events that are central to your line of business like receiving credit card payments, saving a draft of a post, or changing a user’s password.

Fields

  • type - (atom, required) This is the type of your event. It should be something unique and unchanging. It will be used to identify this event. Example: :my_event.
  • data - (map, optional) A map of data. This can be anything that implements the Poison.Encoder protocol. That is, anything that can be JSON encoded. Example: %{key: "value"}.

Special data fields

These are special fields Timber looks for to enhancement your experience with our interface:

  • time_ms - A fractional float represented the execution time in milliseconds. example: 45.6

An example:

Timber.Events.CustomEvent.new(type: :payment_rejected, data: %{time_ms: 45.6})

Examples

Please see Timber.Eventable for examples on using custom events.

Summary

Types

t()

Functions

new(opts)

Creates a new custom event. Takes any of the fields described in the module docs as keys

Types

t() 
t :: %Timber.Events.CustomEvent{data: map | nil, type: atom}

Functions

new(opts) 
new(Keyword.t) :: t

Creates a new custom event. Takes any of the fields described in the module docs as keys.