yr.UInt64Counter

Contents

yr.UInt64Counter#

class yr.UInt64Counter(name: str, description: str, unit: str, labels: ~typing.Dict[str, str] = Field(name=None, type=None, default=<dataclasses._MISSING_TYPE object>, default_factory=<class 'dict'>, init=True, repr=True, hash=None, compare=True, metadata=mappingproxy({}), _field_type=None))[source]#

Bases: Metrics

A class representing a 64-bit unsigned integer counter for metrics.

Parameters:
  • name (str) – Name of the counter.

  • description (str) – Description of the counter.

  • unit (str) – Unit of the counter.

  • labels (Dict[str, str]) – Optional labels for the counter.

Methods

__init__

add_labels

add lable for metrics data.

get_value

Get value of uint64 counter.

increase

Increase uint64 counter to the given value.

reset

Reset uint64 counter.

set

Set uint64 counter to the given value.