Current section

Files

Jump to
opentelemetry_api_experimental src otel_observable_updowncounter.erl
Raw

src/otel_observable_updowncounter.erl

%%%------------------------------------------------------------------------
%% Copyright 2022, 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 Asynchronous UpDownCounter is an asynchronous Instrument which
%% reports additive value(s) (e.g. the process heap size - it makes
%% sense to report the heap size from multiple processes and sum them up,
%% so we get the total heap usage) when the instrument is being observed.
%%
%% Note: if the value is monotonically increasing, use Asynchronous Counter
%% instead; if the value is non-additive, use Asynchronous Gauge instead.
%% @end
%%%-------------------------------------------------------------------------
-module(otel_observable_updowncounter).
-export([]).