Skip to content

Configuration Manual for the "Tencent Cloud-RocketMQ" Collector

Before reading this article, please first read:

Before using this collector, you must install the 'Integration Core Package' and its accompanying third-party dependency packages

1. Configuration Structure

The configuration structure of this collector is as follows:

Field Type Required Description
regions list Required List of regions to collect data from
regions[#] str Required Region ID. Example: 'ap-shanghai'
Refer to appendix for full list

2. Configuration Examples

Specify Region

Collect data from the Shanghai region

Python
1
2
3
collector_configs = {
    'regions': [ 'ap-shanghai' ]
}

Configure Filters (Optional)

This collector script supports user-defined filters that allow users to filter target resources by object attributes. The filter function returns True｜False: - True: Target resource needs to be collected. - False: Target resource does not need to be collected.

Supported object attributes for filtering:

Attribute Description
ClusterId Cluster ID
ClusterName Cluster Name
VpcEndPoint VPC Endpoint
PublicEndPoint Public Endpoint
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# Example: Enable filter based on InstanceId property, configure as follows:

def filter_instance(instance):
    '''
    return True｜False
    '''
    if instance in ['xxx'] :
        return True
    return False

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

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

3. Data Reporting Format

After the data synchronizes successfully, it can be viewed in the "Infrastructure - Resource Catalog" section of {{( brand_name }}}.

Example of reported data:

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": "tencentcloud_rocketmq",
  "tags": {
    "ClusterId"               : "rocketmq-xxxx",
    "ClusterName"             : "test_rocketmq",
    "IsVip"                   : "False",
    "PublicEndPoint"          : "",
    "RegionId"                : "ap-shanghai",
    "Status"                  : "1",
    "SupportNamespaceEndpoint": "True",
    "VpcEndPoint"             : "",
    "name"                    : "rocketmq-xxxx"
  },
  "fields": {
    "HttpPublicEndpoint"    : "",
    "HttpVpcEndpoint"       : "http://rocketmq-k3dmxmo7pa45.tdmq-rocketmq.rest.xxxx.xxxx",
    "CreateTime"            : "1691731708000",
    "IsolateTime"           : "1693411200000",
    "Config"                : "{Cluster configuration information}",
    "Vpcs"                  : "{VPC information}",
    "message"               : "{Instance JSON data}"
  }
}

Descriptions of some parameters are as follows:

Field Type Description
Status str Cluster status, 0: Creating, 1: Normal, 2: Deleting, 3: Deleted, 4: Isolating, 5: Creation failed, 6: Deletion failed

Fields in tags and fields may change with subsequent updates

tags.name value is the instance ID, used as a unique identifier, fields.message is a string after JSON serialization

X. Appendix

Please refer to the official Tencent Cloud documentation: