instrument_meter (instrument v0.6.1)

OpenTelemetry-compatible MeterProvider and Meter API.

This module provides an OTel-style API for creating and using metrics, backed by the existing NIF infrastructure.

Example Usage

  Meter = instrument_meter:get_meter(<<"my_service">>),
  Counter = instrument_meter:create_counter(Meter, <<"requests_total">>, #{
    description => <<"Total requests">>,
    unit => <<"1">>
  }),
  instrument_meter:add(Counter, 1, #{method => <<"GET">>, status => 200}).

Summary

Functions

add(Instrument, Value)

Adds a value to a Counter or UpDownCounter.

add(Otel_instrument, Value, Attrs)

Adds a value to a Counter or UpDownCounter with attributes.

collect_observables()

Invokes all observable instrument callbacks. This should be called before metrics collection to update observable values.

create_counter(Meter, Name)

Creates a Counter instrument.

create_counter(Meter, Name, Opts)

Creates a Counter instrument with options.

create_gauge(Meter, Name)

Creates a Gauge instrument.

create_gauge(Meter, Name, Opts)

Creates a Gauge instrument with options.

create_histogram(Meter, Name)

Creates a Histogram instrument.

create_histogram(Meter, Name, Opts)

Creates a Histogram instrument with options.

create_observable_counter(Meter, Name, Callback)

Creates an ObservableCounter with a callback. Callback can be: - 0-arity: fun() -> number() - returns a single value - 1-arity: fun(Observe) -> ok - calls Observe(Value, Attrs) for each observation

create_observable_gauge(Meter, Name, Callback)

Creates an ObservableGauge with a callback. Callback can be: - 0-arity: fun() -> number() - returns a single value - 1-arity: fun(Observe) -> ok - calls Observe(Value, Attrs) for each observation

create_observable_up_down_counter(Meter, Name, Callback)

Creates an ObservableUpDownCounter with a callback. Callback can be: - 0-arity: fun() -> number() - returns a single value - 1-arity: fun(Observe) -> ok - calls Observe(Value, Attrs) for each observation

create_up_down_counter(Meter, Name)

Creates an UpDownCounter instrument.

create_up_down_counter(Meter, Name, Opts)

Creates an UpDownCounter instrument with options.

force_flush()

Forces a flush of all pending metrics. This is a no-op in the current implementation.

get_instrument(Name)

Gets an instrument by name.

get_meter(Name)

Gets or creates a Meter with the given name.

get_meter(Name, Opts)

Gets or creates a Meter with the given name and options.

list_instruments()

Lists all registered instruments.

record(Instrument, Value)

Records a value in a Histogram.

record(Otel_instrument, Value, Attrs)

Records a value in a Histogram with attributes.

set(Instrument, Value)

Sets a value on a Gauge.

set(Otel_instrument, Value, Attrs)

Sets a value on a Gauge with attributes.

shutdown()

Shuts down the MeterProvider. This is a no-op in the current implementation.

unregister_all_instruments()

Unregisters all OTel instruments.

unregister_instrument(Name)

Unregisters an instrument by name. This removes the instrument from persistent_term, unregisters the underlying metric, and cleans up any associated vec metrics created for attributed operations.

Types

instrument/0

-type instrument() ::
          #otel_instrument{name :: binary(),
                           kind ::
                               counter | up_down_counter | histogram | gauge | observable_counter |
                               observable_gauge | observable_up_down_counter,
                           description :: binary() | undefined,
                           unit :: binary() | undefined,
                           meter ::
                               #meter{name :: binary(),
                                      version :: binary() | undefined,
                                      schema_url :: binary() | undefined,
                                      resource ::
                                          #resource{attributes :: map(),
                                                    schema_url :: binary() | undefined} |
                                          undefined} |
                               undefined,
                           handle :: term(),
                           temporality :: cumulative | delta}.

instrument_opts/0

-type instrument_opts() ::
          #{description => binary(),
            unit => binary(),
            boundaries => [number()],
            temporality => cumulative | delta}.

meter/0

-type meter() ::
          #meter{name :: binary(),
                 version :: binary() | undefined,
                 schema_url :: binary() | undefined,
                 resource ::
                     #resource{attributes :: map(), schema_url :: binary() | undefined} | undefined}.