View Source PromEx.Storage behaviour (PromEx v1.11.0)

Storage definition behaviour.

Summary

Define child specs for gatherer process.

scrape(name)

Gather metrics for given collector with given name.

Generate the process child spec for the store.

Extract the metrics out of the configured store.

@callback child_spec(atom(), [Telemetry.Metrics.t()]) :: Supervisor.child_spec()

Define child specs for gatherer process.

@callback scrape(name :: atom()) :: iodata() | :prom_ex_down

Gather metrics for given collector with given name.

@spec child_spec(
  mod :: module(),
  name :: module(),
  metrics :: [Telemetry.Metrics.t()]
) ::
  Supervisor.child_spec()

Generate the process child spec for the store.

@spec scrape(mod :: module(), name :: module()) :: iodata() | :prom_ex_down

Extract the metrics out of the configured store.