Honeylixir.Response (honeylixir v0.3.0) View Source

Link to this section Summary

Types

t()

Response object with data about an event after a send attempt.

Link to this section Types

Specs

t() :: %Honeylixir.Response{
  body: nil | String.t(),
  duration: integer(),
  err: nil | :overflow | :sampled,
  metadata: map(),
  status_code: nil | integer()
}

Response object with data about an event after a send attempt.

  • metadata - the metadata from the Event a user can use to correlate this response with a specific event
  • duration - time in ms it took to send the event, HTTP time only.
  • status_code - status code for this event from Honeycomb
  • body - the body associated with this event
  • err - set if an error occurs in sending, such as a max queue size overflow or when the event is sampled