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))#

基类：Metrics

表示 64 位无符号整数计数器的类。

Note

使用本样例前，需在部署时配置 ENABLE_METRICS 和 RUNTIME_METRICS_CONFIG 环境变量，否则样例无法使用。可通过以下方式配置：

方式一：在 config.toml 中配置

[function_agent.env]
ENABLE_METRICS = "true"
RUNTIME_METRICS_CONFIG = '{"backends":[{"immediatelyExport":{"name":"FileExporter","enable":true,"exporters":[{"fileExporter":{"enable":true,"enabledInstruments":["yr_alarm"],"failureQueueMaxSize":1000,"failureDataDir":"/home/sn/metrics/failure","failureDataFileMaxCapacity":20,"initConfig":{"fileDir":"/home/sn/metrics/file","rolling":{"enable":true,"maxFiles":3,"maxSize":100,"compress":false},"contentType":"STANDARD"}}}]}}]}'

方式二：通过命令行参数覆盖

yr start --master -s 'function_agent.env.ENABLE_METRICS="true"' -s 'function_agent.env.RUNTIME_METRICS_CONFIG="{\"backends\":[{\"immediatelyExport\":{\"name\":\"FileExporter\",\"enable\":true,\"exporters\":[{\"fileExporter\":{\"enable\":true,\"enabledInstruments\":[\"yr_alarm\"],\"failureQueueMaxSize\":1000,\"failureDataDir\":\"/home/sn/metrics/failure\",\"failureDataFileMaxCapacity\":20,\"initConfig\":{\"fileDir\":\"/home/sn/metrics/file\",\"rolling\":{\"enable\":true,\"maxFiles\":3,\"maxSize\":100,\"compress\":false},\"contentType\":\"STANDARD\"}}}]}}]}"'
参数：

  • name (str) - 计数器名称。

  • description (str) - 计数器描述。

  • unit (str，可选) - 单位。

  • labels (Dict[str, str]，可选) - 计数器的可选标签。

方法：

__init__

add_labels

为 metrics 数据添加标签。

set

将 uint64 计数器设置为给定的值。

reset

重置 uint64 计数器。

increase

将 uint64 计数器增加到给定的值。

get_value

获取 uint64 计数器的值。
Contents