采集器「阿里云-OSS」配置手册¶
阅读本文前,请先阅读:
Tip
使用本采集器前,必须安装「集成 Core 核心包」及其配套的第三方依赖包
1. 配置结构¶
本采集器配置结构如下:
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
regions |
list | 必须 | 所需采集的地域列表 |
regions[#] |
str | 必须 | 地域 ID。如:'cn-hangzhou' 总表见附录 |
2. 配置示例¶
指定地域¶
采集杭州、上海地域的数据
配置过滤器(可选项)¶
本采集器脚本支持用户自定义过滤器,让用户通过对象属性筛选出目标资源。过滤器函数返回值为 True|False
- True:目标资源需要被采集。
- False:目标资源不需要被采集
支持筛选的对象属性:
属性 | 描述 |
---|---|
name | Bucket 名称 |
storage_class | Bucket 存储类型 |
location | Bucket 地域 |
grant | Bucket ACL权限 |
# 示例:开启过滤器,根据对象的 location 和 name 属性过滤,配置格式如下:
def filter_bucket(bucket):
bucket_location = bucket['location']
bucket_name = bucket['name']
if bucket_location in ['cn-north-4'] and bucket_name in ['xxx']:
return True
return False
###### Do not modify the following contents #####
from integration_core__runner import Runner
import integration_alibabacloud_oss__main as main
def run():
Runner(main.DataCollector(account, collector_configs, filters=[filter_bucket])).run()
3. 数据上报格式¶
数据正常同步后,可以在 观测云 的「基础设施-资源目录」中查看数据。
上报的数据示例如下:
{
"measurement": "aliyun_oss",
"tags": {
"name" : "ack-backup-hangzhou",
"RegionId" : "oss-cn-hangzhou",
"storage_class": "IA",
"location" : "oss-cn-hangzhou",
"grant" : "private"
},
"fields": {
"extranet_endpoint": "oss-cn-hangzhou.aliyuncs.com",
"intranet_endpoint": "oss-cn-hangzhou-internal.aliyuncs.com",
"creation_date" : 1638415082,
"message" : "{实例 JSON 数据}"
}
}
Note
tags、fields 中的字段可能会随后续更新有所变动
Tip
tags.name 值为 Bucket 名称,作为唯一标识,fields.message 为 JSON 序列化后字符串
X. 附录¶
请参考阿里云官方文档: