跳转至

采集器「AWS-EBS」配置手册

阅读本文前，请先阅读：

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

1. 配置结构

本采集器配置结构如下：

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

2. 配置示例

指定地域

采集宁夏、北京地域的实例数据

Python
1
2
3
collector_configs = {
    'regions': [ 'cn-northwest-1', 'cn-north-1' ]
}

配置过滤器（可选项）

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

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

支持筛选的对象属性：

属性 描述
VolumeId EBS 卷 ID
VolumeName EBS 卷名称
VolumeType EBS 卷类型
AvailabilityZone 可用区

示例：

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# 示例：开启过滤器，根据对象的 VolumeId 属性过滤，配置格式如下：

def filter_instance(instance, namespace='AWS/EBS'):
    '''
    采集 InstanceId 为 i-xxxxxa, i-xxxxxb 且 RegionId 为 cn-northwest-1 的指标
    '''
    volume_id = instance['tags'].get('InstanceId')
    if volume_id in ['xxx']:
        return True
    return False

from guance_integration__runner import Runner
import guance_aws_ebs__main as main

@DFF.API('AWS-EBS 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
{
  "measurement": "aws_ebs",
  "tags": {
    "name"          : "vol-049d8fxxxxxxx",
    "VolumeId"      : "vol-049d8fxxxxxxx",
    "VolumeType"    : "gp2",
    "VolumeName"    : "test",
    "RegionId"      : "cn-northwest-1",
    "AvailabilityZone": "cn-northwest-1a",
  },
  "fields": {
    "CreateTime" : "2023-11-16T13:05:13.549000Z",
    "Iops"       : 100,
    "Size"       : 10,
    "SnapshotId" : "snap-09ee56fexxxxxxx",
    "State"      : "in-use",
    "Attachments": "{Attachments 信息}",
    "message"    : "{实例 JSON 数据}"
  }
}

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

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

fields.message，fields.Attachments 为 JSON 序列化后字符串

4. IAM 策略权限

如果用户使用带入 IAM 角色的方式采集资源，需要开启一定的操作权限

该采集器需要如下操作权限：

ec2:DescribeVolumes

X. 附录

参考 AWS 官方文档：