跳转至

采集器「华为云-DDS」配置手册

阅读本文前，请先阅读：

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

1. 配置结构

本采集器配置结构如下：

字段 类型 是否必须 说明
region_projects dict 必须 所需采集数据的「地域 - 项目 ID」列表
region_projects[#] str:list 必须 键值对中：
Key 代表地域（如：'cn-north-4'）
Value 代表该地域下所需采集的项目 ID 列表
总表见附录

2. 配置示例

指定地域

采集cn-north-4地域对应项目的 DDS 实例数据

Python
1
2
3
4
5
collector_configs = {
    'region_projects': {
        'cn-north-4': ['c631f046252d4exxxxxxxxxxx'],
    }
}

配置过滤器（可选项）

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

支持筛选的对象属性：

属性 描述
id 实例 ID
name 实例名称
db_user_name 用户名
engine 存储引擎
mode 实例类型
pay_mode 计费方式
port 数据库端口号
status 实例状态
vpc_id VPC ID
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# 示例：开启过滤器，根据对象的 location 和 name 属性过滤，配置格式如下：

def filter_instance(instance):
    instance_id = instance['id']
    if instance_id in ['xxx']:
        return True
    return False

###### Do not modify the following contents #####
from guance_integration__runner import Runner
import guance_huaweicloud_dds__main as main

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
25
26
27
28
{
  "measurement": "huaweicloud_dds",
  "tags": {
    "RegionId"             : "cn-north-4",
    "project_id"           : "c631f046252d4ebdaxxxx",
    "enterprise_project_id": "0",
    "name"                 : "2afe1b3ce2xxxxxx",
    "instance_id"          : "2afe1b3ce2xxxxxx",
    "instance_name"        : "dds-xxxx",
    "status"               : "normal"
  },
  "fields": {
    "db_user_name"     : "rwuser",
    "engine"               : "wiredTiger",
    "mode"                 : "Single",
    "pay_mode"             : "0",
    "port"                 : "8635",
    "security_group_id"    : "d13ebb59-d4fe-43a5-9832-xxxx",
    "ssl"                  : "0",
    "vpc_id"               : "f6bc2c55-2a95-40ce-835b-xxxx",
    "backup_strategy"      : "{备份策略}",
    "created"              : "2022-08-01T10:07:41",
    "datastore"            : "{数据库信息}",
    "groups"               : "[{组信息}]",
    "updated"              : "2022-08-01T10:07:40",
    "message"              : "{实例 JSON 数据}"
  }
}

部分字段说明如下：

字段 类型 说明
enterprise_project_id String 企业项目 ID。
取值为“0”，表示为 default 企业项目。
engine String 存储引擎。支持 WiredTiger/RocksDB 存储引擎。
数据库版本为 4.2 时，存储引擎为 RocksDB，取值为“rocksDB”。
数据库版本为 4.0 和 3.4 时，存储引擎为 WiredTiger，取值为“wiredTiger”。
mode String 实例类型。
取值为“Sharding”，表示集群实例。
取值为“ReplicaSet”，表示副本集实例。
取值为“Single”，表示单节点实例。
pay_mode String 计费方式。
取值为“0”，表示按需计费。
取值为“1”，表示包年/包月计费
ssl Integer 是否开启 SSL 安全连接。
取值为“1”，表示开启。
取值为“0”，表示不开启。
status String 实例状态。
取值：
normal，表示实例正常。
abnormal，表示实例异常。
creating，表示实例创建中。
frozen，表示实例被冻结。
data_disk_full，表示存储空间满。
createfail，表示实例创建失败。
enlargefail，表示实例扩容节点个数失败。

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

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

以下字段均为 JSON 序列化后字符串

  • fields.messages
  • fields.backup_strategy
  • fields.datastore
  • fields.groups

fields.backup_strategy, fields.datastore, fields.groups 里面的具体字段含义可以查看附录里面的查询实例列表和详情接口文档

X. 附录

华为云 DDS「地域 ID」

请参考华为云官方文档：