AWS RDS MySQL¶

Use the "Guance Cloud Sync" script packages in the script market to synchronize cloud monitoring and cloud asset data to Guance

Configuration¶

Install Func¶

We recommend enabling Guance Integrations - Extensions - Hosted Func: all prerequisites are installed automatically. Continue with script installation.

To deploy Func yourself, see Self-hosted Func.

Install Script¶

Note: Please prepare the required Amazon AK in advance (for simplicity, you can grant global read-only permissions ReadOnlyAccess)

Activate Script in DataFlux Func (Automata)¶

1. Log in to the Guance console
2. Click the 【Integration】 menu and select 【Cloud Account Management】
3. Click 【Add Cloud Account】, select 【AWS】, and fill in the required information on the interface. If you have already configured the cloud account information before, ignore this step
4. Click 【Test】, and if the test is successful, click 【Save】. If the test fails, please check if the relevant configuration information is correct and test again
5. Click 【Cloud Account Management】, and you can see the added cloud account in the list. Click the corresponding cloud account to enter the details page
6. Click on the 【Integration】 button on the cloud account details page, and under the Not Installed list, find AWS RDS MySQL, and click on the 【Install】 button. The installation interface will pop up for installation.

Activate Script Manually¶

1. Log in to the Func console, click on 【Script Market】, enter the Guance script market, and search for: integration_aws_rds

2. Click 【Install】, then enter the corresponding parameters: AWS AK ID, AK Secret, and account name.

3. Click 【Deploy Startup Script】, the system will automatically create the Startup script set and automatically configure the corresponding startup script.

4. After activation, you can see the corresponding automatic trigger configuration in 「Manage / Automatic Trigger Configuration」. Click 【Execute】 to execute it immediately without waiting for the scheduled time. After a while, you can view the execution task records and corresponding logs.

Verification¶

1. Under [Management / Automatic Trigger Configuration], confirm that an automatic trigger configuration exists for the task, and check the task records and logs for errors.
2. In Guance, check [Infrastructure / Custom] for asset information.
3. In Guance, check [Metrics] for the corresponding monitoring data.

Metrics¶

After Amazon CloudWatch is configured, the default metrics are as follows. You can collect more metrics through configuration: Amazon CloudWatch Metrics Details

Amazon CloudWatch Instance-Level Metrics for Amazon RDS¶

The AWS/RDS namespace in Amazon CloudWatch includes the following instance-level metrics.

Note:

The Amazon RDS console may display metrics in different units than those sent to Amazon CloudWatch. For example, the Amazon RDS console may display a metric in megabytes (MB), while sending the metric to Amazon CloudWatch in bytes.

The table below is aligned with the latest AWS documentation and keeps only metrics that apply to MySQL or to all engines.

Amazon CloudWatch Usage Metrics for Amazon RDS¶

The AWS/Usage namespace in Amazon CloudWatch includes account-level usage metrics for Amazon RDS service quotas. CloudWatch automatically collects usage metrics for all AWS Regions.

For more information, see CloudWatch Usage Metrics in the Amazon CloudWatch User Guide. For quota-related details, see Quotas and Limits for Amazon RDS and Requesting a Quota Increase in the Service Quotas User Guide.

* Amazon RDS does not publish the units of usage metrics to CloudWatch. These units appear only in the documentation.

Objects¶

The AWS RDS MySQL object data structure collected can be viewed in 「Infrastructure - Custom」

{
  "measurement": "aws_rds",
  "tags": {
    "name"                     : "xxxxx",
    "RegionId"                 : "cn-northwest-1",
    "Engine"                   : "mysql",
    "DBInstanceClass"          : "db.t3.medium",
    "DBInstanceIdentifier"     : "xxxxxx",
    "AvailabilityZone"         : "cn-northwest-1c",
    "SecondaryAvailabilityZone": "cn-northwest-1d"
  },
  "fields": {
    "InstanceCreateTime"  : "2018-03-28T19:54:07.871Z",
    "LatestRestorableTime": "2018-03-28T19:54:07.871Z",
    "Endpoint"            : "{Connection address JSON data}",
    "AllocatedStorage"    : 100,
    "message"             : "{Instance JSON Data}",
  }
}

Note: Fields in tags and fields may change with subsequent updates

Tip 1: tags.name value is the instance ID, used as a unique identifier

Tip 2: fields.message, fields.Endpoint are JSON serialized strings