sleipnir v0.1.3

View Source Sleipnir.Client protocol (sleipnir v0.1.3)

The HTTP client that makes requests on behalf of Sleipnir

Link to this section Summary

Types

reason()
response()

Returned if the request was successfully sent. Loki will generally respond with status 204 No Content on a successful request. Headers should contain the headers from the response.

result()
t()

Functions

push(client, push_request, opts \\ [])

Pushes the request to Loki. Implementations may define their own options.

Link to this section Types

Link to this type

reason()

View Source 
@type reason() :: term()
Link to this type

response()

View Source 
@type response() :: %{status: integer(), headers: [{binary(), binary()}]}

Returned if the request was successfully sent. Loki will generally respond with status 204 No Content on a successful request. Headers should contain the headers from the response.

Link to this type

result()

View Source 
@type result() :: {:ok, response()} | {:error, reason()}
Link to this type

t()

View Source 
@type t() :: term()

Link to this section Functions

Link to this function

push(client, push_request, opts \\ [])

View Source 
@spec push(t(), Sleipnir.PushRequest.t(), Keyword.t()) :: result()

Pushes the request to Loki. Implementations may define their own options.