Skip to content

Collector Configuration Manual for "Tencent Cloud-Memcached"

Before reading this article, please first read:

Before using this collector, you must install the 'Integration Core Package' and its associated 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. For example: 'ap-shanghai'
Refer to the appendix for the full table

2. Configuration Example

Specifying Regions

Collect data from Shanghai and Guangzhou regions

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

Configuring Filters (Optional)

This collector script supports user-defined filters that allow users to filter target resources by object properties. The filter function returns True or False.

  • True: The target resource needs to be collected.
  • False: The target resource does not need to be collected.

Supported object properties for filtering:

Property Description
AutoRenewFlag Whether the instance has auto-renewal set, 1: Set auto-renewal; 0: No auto-renewal set
Status Current status of the instance, 0: In delivery; 1: Running; 2: Creation failed; 4: Deleting; 5: Isolating; 6: Offline process
CmemId Built-in ID of the instance
InstanceId Instance ID
InstanceName Instance name
ZoneId Zone ID
PayMode Billing mode: 0 - Pay-as-you-go, 1 - Subscription
AppId User AppID
Vport Instance port number
Python
 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
# Example: Enable filter based on InstanceId and name attributes of the object, configuration format is as follows:
def filter_instance(instance):
    '''
    Collect instances with instance_id as xxxx and instance_name as xxx
    '''
    # return True
    instance_id = instance['InstanceId']
    instance_name = instance['InstanceName']
    if instance_id in ['xxxx'] and instance_name in ['xxx']:
        return True
    return False


###### Do not modify the following contents #####
from guance_integration__runner import Runner
import guance_tencentcloud_memcached__main as memcached_main
import guance_tencentcloud_monitor__main as monitor_main


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

3. Data Reporting Format

After data is synchronized normally, 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
24
{
  "measurement": "tencentcloud_memcached",
  "tags": {
    "AppId"         : "1311317185",
    "AutoRenewFlag" : "0",
    "CmemId"        : "100007773",
    "InstanceId"    : "cmem-xxxxxxx",
    "InstanceName"  : "cmem-xxxxxx",
    "PayMode"       : "0",
    "RegionId"      : "ap-shanghai",
    "Status"        : "1",
    "Vport"         : "9101",
    "ZoneId"        : "200005",
    "name"          : "cmem-xxxx"
  },
  "fields": {
    "AddTimeStamp"     : "2023-08-18 14:51:02",
    "DeadlineTimeStamp": "0001-01-01 08:05:43",
    "Expire"           : 0,
    "InstanceDesc"     : "cmem-aaaekm1p",
    "ModTimeStamp"     : "2023-08-18 14:51:08",
    "message"          : "{JSON data of instance}"
  }
}

Descriptions of some parameters are as follows:

Field Type Description
AutoRenewFlag String Whether the instance has auto-renewal set, 1: Set auto-renewal; 0: No auto-renewal set
CmemId String Built-in ID of the instance
PayMode String Billing mode: 0 - Pay-as-you-go, 1 - Subscription
Status String Current status of the instance, 0: In delivery; 1: Running; 2: Creation failed; 4: Deleting; 5: Isolating; 6: Offline process
AddTimeStamp String Instance creation time
DeadlineTimeStamp String Instance deadline time
Expire Integer Expiration strategy

Fields in tags and fields may change with subsequent updates.

The value of tags.name 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: