跳转至

采集器「火山引擎-EIP」配置手册

阅读本文前,请先阅读:

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

1. 配置结构

本采集器配置结构如下:

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

2. 配置示例

指定地域

采集北京地域的数据

Python
1
2
3
collector_configs = {
    'regions': [ 'cn-beijing' ]
}

配置过滤器(可选项)

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

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

支持筛选的对象属性:

属性 描述
AllocationId 公网IP的ID
EipAddress 公网IP的公网IP地址
EipName 公网IP的名称
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
# 示例:开启过滤器,根据对象的 AllocationId 属性过滤,配置格式如下:
def filter_instance(instance):
    '''
    采集 instance_id 为 xxxxx 的实例
    '''
    # return True
    instance_id = instance['AllocationId']
    instance_name = instance['name']
    if instance_id in ['xxxxx']:
        return True
    return False


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


@DFF.API('Volcengine-EIP 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
{
  "measurement": "volcengine_eip",
  "tags": {
    "AllocationId": "eip-xxxxxxxx",
    "Description": "",
    "EipAddress": "14.103.xxx.xx",
    "ProjectName": "default",
    "RegionId": "cn-beijing",
    "name": "eip-xxxxxxxx"
  },
  "fields": {
    "AllocationTime": "2023-11-21T14:44:10+08:00",
    "Bandwidth": 5,
    "ExpiredTime": "",
    "ISP": "BGP",
    "InstanceId": "i-ydj80bruv4XXXXXX",
    "InstanceType": "EcsInstance",
    "IsBlocked": false,
    "Status": "Attached",
    "Tags": "[{云厂商控制台设置的 Tags}}]",
    "message": "{实例 JSON 数据}"
  }
}

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

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

  • fields.message
  • fields.Tags

X. 附录

请参考火山引擎官方文档: