编排器API的度量命名约定 _编程开发

编排器API的度量命名约定

创始人

2024-12-05 01:31:16

0次

编排器API的度量命名应该符合以下约定：

度量名称应该使用小写字母，并用下划线分隔单词。
度量名称应该以与API路径相对应的前缀开头。
API路径中使用的参数应该在度量名称中使用相应的标识符。例如，如果API路径为/v1/tasks/{task_id}/logs，命名为_task_logs_total的度量表示给定任务的日志总数，其中是与API路径相对应的前缀，task_id是参数标识符。实现此约定的示例包含以下代码：

# 定义前缀
ORCHESTRATOR_API_PREFIX = 'my_orchestrator_api'

# 定义API路径和参数标识符
api_path = '/v2/tasks/{task_id}/logs'
param_identifier = '{task_id}'

# 定义度量名称
metric_name = f"{ORCHESTRATOR_API_PREFIX}_task_logs_total"

# 注册度量
my_registry.register(metric_name, MetricType.COUNTER, "Total number of logs for a given task", ["task_id"])

以上示例将生成名为my_orchestrator_api_task_logs_total的度量，该度量表示给定任务的日志总数。task_id参数将作为度量的标签。

上一篇：编排和发送端口过滤问题。

下一篇：编排器的断路器

编排器API的度量命名约定

相关内容

热门资讯