Mobius.Event (Mobius v0.7.0)

Copy Markdown View Source

An single event

Summary

Types

name()

The name of the event

new_opt()

Options for creating a new event

t()

An event

Functions

new(session, name, measurements, tags, opts \\ [])

Create a new event

set_timestamp(event, timestamp)

Set the timestamp on an event

Types

name()

@type name() :: binary() | [atom()]

The name of the event

new_opt()

@type new_opt() :: {:group, atom()} | {:timestamp, integer()}

Options for creating a new event

t()

@type t() :: %Mobius.Event{
  group: atom(),
  measurements: map(),
  name: name(),
  session: Mobius.session(),
  tags: map(),
  timestamp: pos_integer() | nil
}

An event

Functions

new(session, name, measurements, tags, opts \\ [])

@spec new(Mobius.session(), name(), map(), map(), [new_opt()]) :: t()

Create a new event

set_timestamp(event, timestamp)

@spec set_timestamp(t(), integer()) :: t()

Set the timestamp on an event