FerricStore.Management.Telemetry behaviour (ferricstore v0.7.4)

Copy Markdown View Source

Stable safe-read telemetry contract for control-plane clients.

This boundary returns metadata and attributes only. Payload search is not part of the default contract.

Summary

Types

result()

@type result() :: {:ok, term()} | {:error, term()}

Callbacks

cluster_info(keyword)

@callback cluster_info(keyword()) :: result()

flow_history(binary, keyword)

@callback flow_history(
  binary(),
  keyword()
) :: result()

flow_query(map, keyword)

@callback flow_query(
  map(),
  keyword()
) :: result()

namespace_usage(binary, keyword)

@callback namespace_usage(
  binary(),
  keyword()
) :: result()

Functions

cluster_info(opts \\ [])

@spec cluster_info(keyword()) :: result()

flow_history(id, opts \\ [])

@spec flow_history(
  binary(),
  keyword()
) :: result()

flow_query(attrs, opts \\ [])

@spec flow_query(
  map(),
  keyword()
) :: result()

namespace_usage(prefix, opts \\ [])

@spec namespace_usage(
  binary(),
  keyword()
) :: result()