chaperon v0.2.3 Chaperon.Scenario.Metrics View Source

This module calculates histogram data for a session’s metrics. It uses the Histogrex library to calculate the histograms.

Link to this section Summary

Functions

Replaces base metrics for a given session with the histogram values for them

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Link to this section Types

Link to this type metric() View Source
metric() :: atom() | {atom(), any()}
Link to this type metric_type() View Source
metric_type() :: atom()

Link to this section Functions

Link to this function add_histogram_metrics(session) View Source
add_histogram_metrics(Chaperon.Session.t()) :: Chaperon.Session.t()

Replaces base metrics for a given session with the histogram values for them.

Link to this function get_names() View Source
get_names() :: [atom()]

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be (re)started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Link to this function passes_filter?(types, type) View Source