跳转至

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

阅读本文前，请先阅读：

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

1. 配置结构

本采集器配置结构如下：

字段 类型 是否必须 说明
regions list 必须 所需采集的地域列表
regions[#] str 必须 地域 ID。如：'cn-north-1'
总表见附录
engines list 否 引擎类型列表（不配置，采集所有引擎类型的 RDS 实例）
engines[#] str 否 引擎类型，目前支持：aurora-mysql, aurora-postgresql, mariadb, mysql, oracle-ee, oracle-ee-cdb, oracle-se2, oracle-se2-cdb, postgres, sqlserver-ee, sqlserver-se, sqlserver-ex, sqlserver-web

2. 配置示例

指定地域

采集宁夏、北京地域，引擎类型为 aurora-mysql，aurora-postgresql，mysql 的实例数据

Python
1
2
3
4
collector_configs = {
    'engines': ['aurora-mysql', 'aurora-postgresql', 'mysql'],
    'regions': [ 'cn-northwest-1', 'cn-north-1' ]
}

配置过滤器（可选项）

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

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

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

支持筛选的对象属性：

属性 描述
name 实例 ID
Engine 实例引擎
DBInstanceClass 实例类型
DBInstanceIdentifier 实例标识符
AvailabilityZone 实例可用区
SecondaryAvailabilityZone 备用可用区
Endpoint_Address 端点地址
DBInstanceStatus 实例状态
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# 示例：开启过滤器，根据对象的 DBInstanceIdentifier 和 Engine 属性过滤，配置格式如下：
def filter_instance(instance):
    '''
    采集 instance_id 为 xxx 并且 engine 为 mysql 的实例
    '''
    # return True
    instance_id = instance['DBInstanceIdentifier']
    instance_engine = instance['Engine']
    if instance_id in ['xxx'] and instance_engine in ['mysql']:
        return True
    return False

@DFF.API('AWS-RDS 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
{
  "measurement": "aws_rds",
  "tags": {
    "name"                     : "xxxxx",
    "RegionId"                 : "cn-northwest-1",
    "Engine"                   : "mysql",
    "DBInstanceClass"          : "db.t3.medium",
    "DBInstanceIdentifier"     : "xxxxxx",
    "AvailabilityZone"         : "cn-northwest-1c",
    "SecondaryAvailabilityZone": "cn-northwest-1d"
  },
  "fields": {
    "InstanceCreateTime"  : "2018-03-28T19:54:07.871Z",
    "LatestRestorableTime": "2018-03-28T19:54:07.871Z",
    "Endpoint"            : "{连接地址 JSON 数据}",
    "AllocatedStorage"    : 100,
    "message"             : "{实例 JSON 数据}",
  }
}

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

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

fields.message、fields.Endpoint 均为 JSON 序列化后字符串

4. IAM 策略权限

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

该采集器需要以下权限：

rds:DescribeDBInstances

X. 附录

请参考 AWS 官方文档：