Collector 'OB Cloud-Cloud Monitoring' Configuration Manual¶

Before reading this document, please read:

• Cloud Integration

1. Configuration Structure¶

The configuration structure of this collector is as follows:

2. Configuration Examples¶

Specifying Specific Metrics¶

Collect 2 metrics named active_session and all_session in ECS.

collector_configs = {
    'targets': [
        {
            'labels': 'clusterId,tenantId',
            'metrics'  : ['active_session', 'all_session',],
        },
    ],
}

Wildcard Matching for Metrics¶

Metric names can use the * wildcard for matching.

The following metrics will be collected in this example:

• Metrics named all_session
• Metrics whose names start with active
• Metrics whose names end with session
• Metrics whose names contain session

collector_configs = {
    'targets': [
        {
            'labels': 'clusterId,tenantId',
            'metrics'  : ['all_session', 'active*', '*session', '*session*'],
        },
    ],
}

Excluding Some Metrics¶

Adding the "NOT" marker at the beginning indicates removing the following metrics.

In this example, the following metrics will [NOT] be collected:

• Metrics named all_session
• Metrics whose names start with active
• Metrics whose names end with session
• Metrics whose names contain session

collector_configs = {
    'targets': [
        {
            'labels': 'clusterId,tenantId',
            'metrics'  : ['NOT', 'all_session', 'active*', '*session', '*session*'],
        },
    ],
}

Multi-step Filtering to Specify Required Metrics¶

The same namespace can be specified multiple times, filtering by metric name sequentially from top to bottom.

In this example, the metric names undergo the following filtering steps:

1. Select all metrics whose names contain session
2. From the results of the previous step, remove metrics named all_session

collector_configs = {
    'targets': [
        {
            'labels': 'clusterId,tenantId',
            'metrics'  : ['*session*'],
        },
        {
            'labels': 'clusterId,tenantId',
            'metrics'  : ['NOT', 'all_session'],
        },
    ],
}

3. Data Reporting Format¶

After data is synchronized normally, you can view the data in the 'Metrics' section of TrueWatch.

Taking the following collector configuration as an example:

collector_configs = {
    'targets': [
        {
            'labels': 'clusterId,tenantId',
            'metrics'  : ['active_session'],
        },
    ],
}

The reported data example is as follows:

{
    "measurement": "obcloud_oceanbase_metric",
    "fields": {
      "active_session": 1.0
    },
    "tags": {
      "cloud_provider": "obcloud",
      "cluster_id": "xxxxxx",
      "cluster_name": "xxxxxx",
      "cluster_role": "NORMAL",
      "cluster_type": "cluster",
      "labels": "clusterId,tenantId",
      "project_id": "xxxxxx",
      "tenant_id": "xxxxxx",
      "tenant_name": "xxxxxx"
    },
    "timestamp": 1766000000
}

4. Metrics Overview¶

X. Appendix¶

Please refer to the OB Cloud official documentation:

• API DescribeMetricsData