自定义指标文件

字段说明

自定义指标文件中的字段说明如表1所示。

约束说明

• 不支持软链接。
• 不支持指定一个目录。
• JSON文件只支持指定一个文件，指定多个时只读取第一个。
• 文件中字段的格式需满足表1要求。格式不正确会关闭基于文件的自定义指标采集。
• 当指定的自定义指标文件不存在或为空文件时，等待1分钟后仍不满足条件，则关闭基于文件的自定义指标采集。
• 自动获取指标的label时，以data_list中的第一条数据为准。
• 自定义指标文件需要为root属组，具有读权限，不具有任何执行权限。
• 程序运行中不支持修改文件的name、desc、version和label。
• 自定义指标文件仅支持Prometheus方式上报。
• 自定义指标文件大小限制为100KB。

数据样例说明

{
  "version": "1.0",
  "name": "hccs_bandwidth",
  "desc": "hccs bandwidth info, unit is 'MB/s'.",
  "timestamp": 1766456419845127,
  "data_list": [
    {
      "value": 190.02,
      "label": {
        "numa": "2",
        "device": "hisi_sicl10_pa0",
        "link": "0",
        "direction": "in",
        "path": "P0->P1"
      }
    },
    {
      "value": 143.09,
      "label": {
        "numa": "2",
        "device": "hisi_sicl10_pa0",
        "link": "1",
        "direction": "in",
        "path": "P2->P1"
      }
    }
  ]
}

自定义指标开发说明

通过自定义指标文件可开发自定义指标。用户根据表1，创建符合要求的自定义指标文件。启动NPU Exporter时，配置“-textMetricsFilePath”参数，指定该自定义指标文件的路径，详情请参见表2。NPU Exporter会在每个数据采集周期读取自定义指标文件，并将文件内容上报给Prometheus。

开发示例如下：

使用NPU Exporter集成并采集Devkit工具生成的hccs_bandwidth指标，详情请参见NPU Exporter集成Devkit部署指南。关于hccs_bandwidth指标信息的说明请参见HCCS带宽监控。

• 自定义的指标不能与已有的指标名重复。
• 开发者需要对自定义指标文件格式的正确性负责。