Specs

idp(metrics :: map()) :: {:ok, struct()} | {:error, binary()}

A convenience function to produce a IdPInfo report (reformated "idp" metrics)

Examples

  Shin.Reports.idp(metrics)
  # => {:ok, %Reports.IdPInfo{ ... }}

Specs

produce(metrics :: map(), reporter :: binary() | atom()) ::
  {:ok, struct()} | {:error, binary()}

Produce the specified report using the provided metrics

The reporter can be an alias (an atom already know to Shin) or any suitable module.

Examples

  Reports.produce(metrics, :system_info)
  # => {:ok, %Shin.Reports.SystemInfo{ ... }}

  Reports.produce(metrics, Shin.Reports.IdPInfo)
  # => {:ok, %Reports.IdPInfo{ ... }}

Specs

reporter_aliases() :: list()

Returns a list reporter aliases

Examples

  Shin.Reports.reporter_aliases
  # => [:system_info, :idp_info]

Specs

reporter_modules() :: list()

Returns a map of reporter modules.

Examples

  Shin.Reports.reporter_modules
  # => [Shin.Reports.SystemInfo, Shin.Reports.IdPInfo]

Specs

reporters() :: map()

Returns a map of reporter aliases and modules.

Examples

  Shin.Reports.reporters
  # => %{system_info: Shin.Reports.SystemInfo, idp_info: Shin.Reports.IdPInfo}

Specs

system(metrics :: map()) :: {:ok, struct()} | {:error, binary()}

A convenience function to produce a SystemInfo report (reformated "core" metrics)

Examples

  Shin.Reports.system(metrics)
  # => {:ok, %Reports.SystemInfo{cores: 4,  ...}}