View Source Chaperon.Exporter behaviour (doma_chaperon v0.3.2)

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

Link to this section Summary

file_paths()

metrics_data()

options()

output_path()

encode(t, t)

@type file_paths() :: [Strint.t()]

@type metrics_data() :: any()

@type options() :: Keyword.t()

@type output_path() :: String.t()

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

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