Skip to content

Configuration Manual for the "Azure-DB For MySQL Flexible Server Collection" Collector

Before reading this article, please read the following first:

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
subscriptions list Required List of subscription IDs to collect data from
subscriptions[#] str Subscription ID
locations list Optional Region list
locations[#] str Region, e.g.: westus2

2. Configuration Examples

Specifying Subscriptions

Collect all instance objects under the subscription ID: xxxx1

Python
1
2
3
collector_configs = {
    'subscriptions': ['xxxx1']
}

Specifying Subscriptions and Regions

Collect all instance objects under subscription ID: xxxx1 and in regions westus2, westus

Python
1
2
3
4
collector_configs = {
    'subscriptions': ['xxxx1'],
    'locations': ['westus2', 'westus']
}

Configuring Filters (Optional)

This collector script supports user-defined filters, allowing users to filter target resources based on object attributes. 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 attributes for filtering:

Attribute Description
name Resource ID
resourceId Resource ID (same as name field)
resourceName Resource name
resourceGroup Resource group name
location Resource location
availabilityZone Availability zone
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Example: Enable filters to filter by the resourceId property of the object, with the following configuration:
def filter_instance(instance):
    '''
    Collect instances where resourceId is xxx
    '''
    # return True
    r_id = instance['resourceId']
    if r_id in ['xxx']:
        return True
    return False

@DFF.API('Azure-DB For MySQL Flexible Server Collection', timeout=3600, fixed_crontab='*/15 * * * *')
def run():
    Runner(main.DataCollector(account, collector_configs, filters=[filter_instance])).run()

3. Data Reporting Format

After data synchronization is successful, you can view the data in the "TrueWatch" section under "Infrastructure - Resource Catalog".

An example of reported data is as follows:

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
{
  "measurement": "azure_dbformysql_flexibleservers",
  "tags": {
    "cloud_provider"   : "azure",
    "location"         : "westus2",
    "name"             : "/subscriptions/sss/resourcegroups/xxx/providers/microsoft.dbformysql/flexibleservers/mmm",
    "resource_group"   : "xxx",
    "resource_id"      : "/subscriptions/sss/resourcegroups/xxx/providers/microsoft.dbformysql/flexibleservers/mmm",
    "resource_name"    : "mmm",
    "state"            : "Ready",
    "subscription_id"  : "sss",
    "tenant_id"        : "ce9fe5b4-xxxx",
    "availability_zone": "3"
  },
  "fields": {
    "fully_qualified_domain_name": "mmm.mysql.database.azure.com",
    "version"                    : "8.0.21",
    "sku"                        : "{Server SKU}",
    "storage"                    : "{Server storage properties}",
    "backup"                     : "{Server backup properties}",
    "maintenance_window"         : "{Server maintenance window properties}",
    "message"                    : "{Instance JSON data}",
    "tags"                       : "{Tags configured in the Azure Console}"
  }
}

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, fields.sku, fields.storage, fields.backup, fields.maintenance_window, fields.tags are all JSON serialized strings

X. Appendix

Azure related documentation: