采集器「腾讯云-CVM」配置手册
阅读本文前,请先阅读:
使用本采集器前,必须安装「观测云集成 Core 核心包」及其配套的第三方依赖包
1. 配置结构
本采集器配置结构如下:
字段 |
类型 |
是否必须 |
说明 |
regions |
list |
必须 |
所需采集的地域列表 |
regions[#] |
str |
必须 |
地域 ID。如:'ap-shanghai' 总表见附录 |
2. 配置示例
指定地域
采集上海、广州地域的数据
Python |
---|
| collector_configs = {
'regions': [ 'ap-shanghai', 'ap-guangzhou' ]
}
|
配置过滤器(可选项)
本采集器脚本支持用户自定义过滤器,让用户通过对象属性筛选出目标资源。过滤器函数返回值为 True|False
- True:目标资源需要被采集。
- False 目标资源不需要被采集
支持筛选的对象属性:
属性 |
描述 |
RegionId |
地域 |
InstanceId |
实例ID |
InstanceChargeType |
付费类型 |
InstanceType |
实例类型 |
OsName |
操作系统名称 |
InstanceName |
实例名称 |
Python |
---|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 | # 示例:开启过滤器,根据对象的 InstanceId,OsName 属性过滤,配置格式如下:
def filter_instance(instance):
'''
采集 InstanceId 为 ins-0d7620xxxxxxxa, ins-0d7620xxxxxxxb 且 OsName 为 TencentOS Server 3.1 (TK4) 的指标
'''
instance_id = instance['InstanceId']
os_name = instance['OsName']
if instance_id in ['ins-0d7620xxxxxxxa', 'ins-0d7620xxxxxxxb'] and os_name in ['TencentOS Server 3.1 (TK4)']:
return True
return False
from guance_integration__runner import Runner
import guance_tencentcloud_cvm__main as main
@DFF.API('TencentCloud-CVM 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": "tencentcloud_cvm",
"tags": {
"name" : "ins-bahxxxx",
"RegionId" : "ap-shanghai",
"Zone" : "ap-shanghai-1",
"InstanceId" : "ins-bahxxxx",
"InstanceChargeType": "POSTPAID_BY_HOUR",
"InstanceType" : "SA2.MEDIUM2",
"OsName" : "TencentOS Server 3.1 (TK4)"
},
"fields": {
"CPU" : 2,
"Memory" : 2,
"InstanceState" : "RUNNING",
"PublicIpAddresses" : "{公网 IP 数据}",
"PrivateIpAddresses": "{私网 IP 数据}",
"SystemDisk" : "{系统盘 JSON 数据}",
"DataDisks" : "{数据盘 JSON 数据}",
"Placement" : "{地区 JSON 数据}",
"ExpiredTime" : "2022-05-07T01:51:38Z",
"message" : "{实例 JSON 数据}"
}
}
|
tags、fields 中的字段可能会随后续更新有所变动
fields.message、fields.DataDisks、fields.Placement、fields.PrivateIpAddresses、fields.PublicIpAddresses、fields.SystemDisk 均为 JSON 序列化后字符串
X. 附录
请参考腾讯云官方文档: