opentelemetry_api_experimental

%%%------------------------------------------------------------------------
%% Copyright 2020, OpenTelemetry Authors
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% @doc All measurements are associated with an instrument.
%% @end
%%%-------------------------------------------------------------------------
-module(otel_instrument).

-export([new/7,
         new/9,
         is_monotonic/1]).

-include("otel_metrics.hrl").

-type name() :: atom() | unicode:latin1_chardata().
-type description() :: unicode:unicode_binary().
-type kind() :: ?KIND_COUNTER | ?KIND_OBSERVABLE_COUNTER | ?KIND_HISTOGRAM |
                ?KIND_OBSERVABLE_GAUGE | ?KIND_UPDOWN_COUNTER | ?KIND_OBSERVABLE_UPDOWNCOUNTER.
-type unit() :: atom(). %% latin1, maximum length of 63 characters
-type value_type() :: ?VALUE_TYPE_INTEGER | ?VALUE_TYPE_FLOAT.
-type observation() :: {number(), opentelemetry:attributes_map()}.
-type named_observation() :: {name(), number(), opentelemetry:attributes_map()}.
-type callback_args() :: term().
-type callback() :: fun((callback_args()) -> observation() |
                                             [named_observation()]).

-type t() :: #instrument{}.

-export_type([t/0,
              name/0,
              description/0,
              kind/0,
              value_type/0,
              unit/0,
              callback/0,
              callback_args/0]).

-spec new(module(), otel_meter:t(), kind(), name(), description(), unit(), value_type()) -> t().
new(Module, Meter, Kind, Name, Description, Unit, ValueType) ->
    #instrument{module      = Module,
                meter       = Meter,
                name        = Name,
                description = Description,
                kind        = Kind,
                value_type  = ValueType,
                unit        = Unit}.

-spec new(module(), otel_meter:t(), kind(), name(), description(), unit(), value_type(), callback(), term()) -> t().
new(Module, Meter, Kind, Name, Description, Unit, ValueType, Callback, CallbackArgs) ->
    #instrument{module        = Module,
                meter         = Meter,
                name          = Name,
                description   = Description,
                kind          = Kind,
                value_type    = ValueType,
                unit          = Unit,
                callback      = Callback,
                callback_args = CallbackArgs}.

is_monotonic(#instrument{kind=?KIND_COUNTER}) ->
    true;
is_monotonic(#instrument{kind=?KIND_OBSERVABLE_COUNTER}) ->
    true;
is_monotonic(_) ->
    false.