跳转至

采集器「火山引擎-NAS」配置手册

阅读本文前,请先阅读:

使用本采集器前,必须安装「观测云集成 Core 核心包」及其配套的第三方依赖包

1. 配置结构

本采集器配置结构如下:

字段 类型 是否必须 说明
regions list 必须 所需采集的地域列表
regions[#] str 必须 地域 ID。如:'cn-shanghai'
总表见附录

2. 配置示例

指定地域

采集北京地域的数据

Python
1
2
3
collector_configs = {
    'regions': [ 'cn-beijing' ]
}

配置过滤器(可选项)

本采集器脚本支持用户自定义过滤器,让用户通过对象属性筛选出目标资源。过滤器函数返回值为 True|False

  • True:目标资源需要被采集。
  • False:目标资源不需要被采集

支持筛选的对象属性:

属性 描述
FileSystemId 文件系统 ID
FileSystemName 文件系统名称
FileSystemType 文件系统类型
Extreme:NAS 极速型;
Capacity:NAS 容量型;
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# 示例:开启过滤器,根据对象的 FileSystemId 属性过滤,配置格式如下:
def filter_instance(instance):
    '''
    采集 FileSystemId 为 xxxxx 实例
    '''
    # return True
    file_sys_id = instance['FileSystemId']
    if file_sys_id in ['xxxxx']:
        return True
    return False

###### Do not modify the following contents #####
from guance_integration__runner import Runner
import guance_volcengine_nas__main as main

@DFF.API('Volcengine-NAS Collection', timeout=3600, fixed_crontab='*/15 * * * *')
def run():
    Runner(main.DataCollector(account, collector_configs, filters=[filter_instance])).run()

3. 数据上报格式

数据正常同步后,可以在观测云的「基础设施-资源目录」中查看数据。

上报的数据示例如下:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "measurement": "volcengine_nas",
  "tags": {
    "RegionId"      : "cn-beijing",
    "ProjectName"   : "default",
    "AccountId"     : "205465415",
    "FileSystemId"  : "enas-xxx",
    "FileSystemName": "enas-test",
    "FileSystemType": "Extreme",
    "Status"        : "Running",
    "name"          : "enas-xxx"
  },
  "fields": {
    "ZoneId"        : " cn-beijing-a",
    "Capacity"      : "{容量信息}",
    "StorageType"   : "Standard",
    "ChargeType"    : "PayAsYouGo"
    "Description"   : "test",
    "CreateTime"    : "2023-03-13T10:00:14+08:00",
    "UpdateTime"    : "2023-04-13T16:34:44+08:00",
    "Tags"          : "{云平台标签信息}"
    "message"       : "{实例 JSON 数据}"
  }
}

tags、fields 中的字段可能会随后续更新有所变动

tags.name 值为实例 ID,作为唯一标识

以下字段均为 JSON 序列化后字符串

  • fields.message
  • fields.Capacity
  • fields.Tags

X. 附录

请参考火山引擎官方文档: