跳转至

采集器「阿里云-CLB」配置手册

阅读本文前,请先阅读:

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

1. 配置结构

本采集器配置结构如下:

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

2. 配置示例

指定地域

采集杭州、上海地域的数据

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

配置过滤器(可选项)

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

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

支持筛选的对象属性:

属性 描述
LoadBalancerId 实例 ID
RegionId 地域 ID
SlaveZoneId 实例备可用区 ID
MasterZoneId 实例主可用区 ID
Address 实例服务地址
PayType 付费模式
InternetChargeType 公网型实例付费方式
LoadBalancerName 实例名称
LoadBalancerStatus 实例状态
NetworkType 私网负载均衡实例的网络类型
AddressType 传统型负载均衡实例的网络类型
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# 示例:开启过滤器,根据对象的 InstanceId,RegionId 属性过滤,配置格式如下:

def filter_instance(instance, namespace='aliyun_slb'):
    '''
    采集 InstanceId 为 i-xxxxxa, i-xxxxxb 且 RegionId 为 cn-hangzhou 的指标
    '''
    instance_id = instance['InstanceId']
    region_id = instance['RegionId']
    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_aliyun_slb__main as main

@DFF.API('AlibabaCloud-SLB 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
21
22
23
24
25
26
27
28
29
{
  "measurement": "aliyun_slb",
  "tags": {
    "name"              : "lb.xxxxxxxx",
    "LoadBalancerId"    : "lb.xxxxxxxxx",
    "RegionId"          : "cn-shanghai",
    "SlaveZoneId"       : "cn-shanghai-i",
    "MasterZoneId"      : "cn-shanghai",
    "Address"           : "172.xxx.xxx.xxx",
    "PayType"           : "PayOnDemand",
    "InternetChargeType": "paybytraffic",
    "LoadBalancerName"  : "业务系统",
    "LoadBalancerStatus": "active",
    "AutoReleaseTime"   : "1513947075000",
    "RenewalStatus"     : "AutoRenewal",
    "AddressType"       : "Internet",
    "NetworkType"       : "vpc",
},
  "fields": {
    "CreateTime"              : "2020-11-18T08:47:11Z",
    "ListenerPortsAndProtocol": "{监听端口 JSON 数据}",
    "ServerHealthStatus"      : "{实例健康状态 JSON 数据}",
    "ServerCertificates"      : "{证书信息 JSON 数据}",
    "Bandwidth"               : "5120",
    "EndTimeStamp"            : "32493801600000",
    "Tags"                    : "[云控制台设置的 Tags]",
    "message"                 : "{实例 JSON 数据}",
  }
}

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

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

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

fields.ServerHealthStatus 为 SLB 下对应实例的健康状态

fields.AutoReleaseTime, fields.EndTimeStamp 为时间戳(单位:秒)

X. 附录

请参考阿里云官方文档: