Honeylixir.Event (honeylixir v0.1.0) View Source

Used for managing Events, not the sending of them.

Link to this section Summary

Functions

By default, an event is constructed with the values in the configuration

Add a single key/value pair to the event.

The standard, default way to create an event. No special data and uses the current time as the timestamp.

create/1 accepts either just a timestamp or just a set of fields to set the event with.

Accepts both a timestamp in RFC3339 format and a map of key/values to initialize the Events truct with.

Used for acknowledging the event is ready for sending, passing it off to the Transmission function to handle the sending.

Link to this section Functions

Link to this function

%Honeylixir.Event{}

View Source (struct)

By default, an event is constructed with the values in the configuration

Link to this function

add_field(event, field, value)

View Source

Add a single key/value pair to the event.

Examples

iex> event = Honeylixir.Event.create()
iex> Honeylixir.Event.add_field(event, "key", "other").fields
%{"service_name" => "honeylixir-tests", "key" => "other"}

The standard, default way to create an event. No special data and uses the current time as the timestamp.

create/1 accepts either just a timestamp or just a set of fields to set the event with.

Link to this function

create(timestamp, fields)

View Source

Accepts both a timestamp in RFC3339 format and a map of key/values to initialize the Events truct with.

Used for acknowledging the event is ready for sending, passing it off to the Transmission function to handle the sending.