AWS DocumentDB¶

The displayed metrics of AWS DocumentDB include read and write throughput, query latency, and scalability.

Configuration¶

Install Func¶

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

For self-deploying Func, refer to Self-deploying Func

Install Script¶

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

Automata Activation Script¶

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 the cloud account information has been configured before, ignore this step.
4. Click 【Test】, and after 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 the 【Integration】 button on the cloud account details page, find AWS DocumentDB under the Not Installed list, and click the 【Install】 button to pop up the installation interface for installation.

Manual Activation Script¶

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

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 scripts.

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 check the execution task records and corresponding logs.

Verification¶

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

Metrics¶

After configuring Amazon CloudWatch, the default Measurement is as follows. More metrics can be collected through configuration. Amazon CloudWatch Metrics Details

Object¶

The collected AWS DocumentDB object data structure can be seen in 「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 info}"
  }
}

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