View Source Chaperon.Exporter behaviour (chaperon v0.3.1)

Metrics exporter behaviour. Implemented by all built-in exporter modules (see Chaperon.Export.*)

Link to this section Summary

Link to this section Types

@type file_paths() :: [Strint.t()]
@type metrics_data() :: any()
@type options() :: Keyword.t()
@type output_path() :: String.t()

Link to this section Callbacks

@callback encode(Chaperon.Session.t(), Keyword.t()) ::
  {:ok, metrics_data()} | {:error, String.t()}
Link to this callback

write_output(module, options, metrics_data, output_path)

View Source
@callback write_output(module(), options(), metrics_data(), output_path()) ::
  {:ok, file_paths()} | {:error, String.t()}