metrix v0.4.0 Metrix

Summary

Functions

Adds metadata to the global context, which will add the metadata values to all subsequent metrix output. Global context is useful for component-wide values, such as source=X or app=Y metadata, that remains unchanged throughout the life of your application

Called when an application is started

Functions

add_context(metadata)

Adds metadata to the global context, which will add the metadata values to all subsequent metrix output. Global context is useful for component-wide values, such as source=X or app=Y metadata, that remains unchanged throughout the life of your application.

clear_context()
count(metric)
count(metric, num)
count(metadata, metric, num)
get_context()
log(values)
measure(metric, fun)
measure(metadata, metric, fun)
sample(metric, value)
sample(metadata, metric, value)
start(type, args)

Called when an application is started.

This function is called when an the application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application’s supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

  • :normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another mode and the application specification key :start_phases is :undefined.
  • {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
  • {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the pid of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the stop/2 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.