AWS DocumentDB¶

The displayed Metrics for AWS DocumentDB include read and write throughput, query latency, scalability, etc.

Configuration¶

Install Func¶

It is recommended to enable the Guance integration - extension - DataFlux Func (Automata): all prerequisites are automatically installed. Please continue with the script installation.

If you deploy Func manually, refer to Manual Deployment of Func

Installation Script¶

Note: Please prepare an Amazon AK that meets the requirements in advance (for simplicity, you can directly grant global read-only permission ReadOnlyAccess).

Script for enabling the managed version¶

1. Log in to the Guance console.
2. Click on the 【Manage】 menu and select 【Cloud Account Management】.
3. Click 【Add Cloud Account】, choose 【AWS】, and fill in the required information. If you have already configured cloud account information, skip this step.
4. Click 【Test】. After a successful test, click 【Save】. If the test fails, check whether the relevant configuration information is correct and retest.
5. In the 【Cloud Account Management】 list, you can see the added cloud accounts. Click the corresponding cloud account and enter the details page.
6. Click the 【Integration】 button on the cloud account details page. Under the Not Installed list, find AWS DocumentDB, click the 【Install】 button, and install it via the installation interface.

Manual Enablement Script¶

1. Log in to the Func console, click 【Script Market】, enter the official script market, and search for: guance_aws_documentdb.
2. After clicking 【Install】, input the corresponding parameters: AWS AK ID, AK Secret, and account name.
3. Click 【Deploy Startup Script】, and the system will automatically create a Startup script set and automatically configure the corresponding startup script.
4. After enabling, you can see the corresponding automatic trigger configuration under 「Manage / Automatic Trigger Configuration」. Click 【Execute】 to immediately execute once without waiting for the scheduled time. Wait a moment, and you can view the execution task records and corresponding logs.

Verification¶

1. In 「Manage / Automatic Trigger Configuration」, confirm whether the corresponding task has an automatic trigger configuration, and at the same time, you can check the corresponding task records and logs for any abnormalities.
2. In Guance, under 「Infrastructure / Custom」, check if there is asset information.
3. In Guance, under 「Metrics」, check if there is corresponding monitoring data.

Metrics¶

After configuring Amazon-CloudWatch, the default Measurement set is as follows. You can collect more Metrics through configuration. Amazon CloudWatch Metrics Details

Objects¶

The object data structure collected for AWS DocumentDB can be viewed under 「Infrastructure - Custom」

{
  "measurement": "aws_documentdb",
  "tags": {
    "AvailabilityZone"          : "cn-north-1a",
    "CACertificateIdentifier"   : "rds-ca-2019",
    "DBClusterIdentifier"       : "docdb-2023-06",
    "DBInstanceArn"             : "arn:aws-cn:rds:cn-north-1:",
    "DBInstanceClass"           : "db.t3.medium",
    "DBInstanceIdentifier"      : "docdb-2023-07",
    "DBInstanceStatus"          : "available",
    "DbiResourceId"             : "db-CKJQ",
    "Engine"                    : "docdb",
    "EngineVersion"             : "3.6.0",
    "KmsKeyId"                  : "arn:aws-cn:kms:cn-north-1:",
    "cloud_provider"            : "aws",
    "name"                      : "docdb-2023-07"
  },
  "fields": {
    "DBSubnetGroup": "{}",
    "Endpoint": "{\"Address\": \".docdb.cn-north-1.amazonaws.com.cn\", \"HostedZoneId\": \"Z010911BG9\", \"Port\": 27017}",
    "InstanceCreateTime": "2023-07-28T05:45:10.004000Z",
    "PendingModifiedValues": "{}",
    "PubliclyAccessible": "False",
    "StatusInfos": "{}",
    "VpcSecurityGroups": "[{\"Status\": \"active\", \"VpcSecurityGroupId\": \"sg-08895f59\"}]",
    "message": "{instance json information}"
  }
}

Note: The fields in tags and fields may change with subsequent updates.