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

阅读本文前，请先阅读：

观测云集成 / 基本操作

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

1. 配置结构

本采集器配置结构如下：

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

2. 配置示例

指定地域

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

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

配置过滤器（可选项）

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

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

支持筛选的对象属性：

属性	描述
`InstanceId`	实例 ID
`RegionId`	地域 ID
`PlatformDetails`	操作系统
`InstanceType`	实例类型
`InstanceName`	实例名称

当开启自定义对象采集时，支持筛选的对象属性请参考对应文档

Python
# 示例：开启过滤器，根据对象的 InstanceId，RegionId 属性过滤，配置格式如下：

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

from guance_integration__runner import Runner
import guance_aws_cloudwatch__main as main

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

3. 数据上报格式

数据正常同步后，可以在观测云的「基础设施-自定义对象」中查看数据。

上报的数据示例如下：

JSON
{
  "measurement": "aws_ec2",
  "tags": {
    "name"            : "i-0d7620xxxxxxx",
    "InstanceId"      : "i-0d7620xxxxxxx",
    "InstanceType"    : "c6g.xlarge",
    "PlatformDetails" : "Linux/UNIX",
    "RegionId"        : "cn-northwest-1",
    "InstanceName"    : "test",
    "State"           : "running",
    "StateReason_Code": "Client.UserInitiatedHibernate",
    "AvailabilityZone": "cn-northwest-1",
  },
  "fields": {
    "BlockDeviceMappings": "{设备 JSON 数据}",
    "LaunchTime"         : "2021-10-26T07:00:44Z",
    "NetworkInterfaces"  : "{网络 JSON 数据}",
    "Placement"          : "{可用区 JSON 数据}",
    "message"            : "{实例 JSON 数据}"
  }
}

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

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

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

4. IAM 策略权限

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

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

ec2:DescribeInstances

X. 附录

请参考 AWS 官方文档：

AWS EC2 地域 ID