riemannx v4.0.4 Riemannx.Connection behaviour View Source
This is the behaviour specification for all connections as well as a generic API for communication with them based on the settings given in your config.
The struct in this module is used across all connection types as much of the data is common to all types.
Link to this section Summary
Functions
Query the index of the riemann server, only works with the TLS/TCP/Combined setups. UDP is NOT supported
A failed query
An acceptable query response
Synchronously process an event
Tells the given worker to asynchronously process an event
Link to this section Types
Link to this type
socket()
View Source
socket() :: :gen_udp.socket() | :gen_tcp.socket() | :ssl.sslsocket()
Link to this type
t()
View Source
t() :: %Riemannx.Connection{ host: String.t() | nil, options: list() | nil, port: :inet.port_number() | nil, socket: socket() | nil, to: pid() | nil }
Link to this section Functions
Query the index of the riemann server, only works with the TLS/TCP/Combined setups. UDP is NOT supported.
A failed query.
An acceptable query response.
Link to this function
send(e, t \\ 30000)
View Source
send(encoded_event(), non_neg_integer()) :: :ok | error()
Synchronously process an event.
Link to this function
send_async(e)
View Source
send_async(encoded_event() | Riemannx.events()) :: :ok
Tells the given worker to asynchronously process an event.
Link to this section Callbacks
Link to this callback
send(e, t)
View Source
send(e :: encoded_event(), t :: non_neg_integer()) :: :ok | error()