Collector "AWS-Neptune Cluster Collection" Configuration Manual¶

Before reading this document, please read:

Cloud Integration

Tip

Before using this collector, you must install the "Integration Core Package" and its accompanying third-party dependencies.

1. Configuration Structure¶

The configuration structure of this collector is as follows:

Field	Type	Required	Description
`regions`	list	Required	List of regions to collect data from
`regions[#]`	str	Required	Region ID. Example: `'cn-north-1'` See appendix for the complete list

2. Configuration Example¶

Collect instance data from the Beijing region

collector_configs = {
    'regions': ['cn-north-1' ]
}

3. Data Reporting Format¶

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

Example of reported data:

{
  "measurement": "aws_neptune_cluster",
  "tags": {
    "DBClusterArn"                  : "arn:aws-cn:rds:cn-north-1::cluster:",
    "DBClusterIdentifier"           : "hn-test",
    "DBSubnetGroup"                 : "default-vpc-",
    "DbClusterResourceId"           : "cluster-JM35ME",
    "Engine"                        : "neptune",
    "EngineVersion"                 : "1.2.0.2",
    "HostedZoneId"                  : "Z027FQJY5",
    "MasterUsername"                : "admin",
    "RegionId"                      : "cn-north-1",
    "Status"                        : "available",
    "name"                          : "hn-test"
  },
  "fields": {
    "AvailabilityZones"              : "[\"cn-north-1a\", \"cn-north-1b\", \"cn-north-1d\"]",
    "BackupRetentionPeriod"          : 1,
    "ClusterCreateTime"              : "2023-08-18T09:23:29.611000Z",
    "CopyTagsToSnapshot"             : false,
    "DBClusterMembers"               : "[{\"DBClusterParameterGroupStatus\": \"in-sync\", \"DBInstanceIdentifier\": \"hn-test-instance-1\", \"IsClusterWriter\": true, \"PromotionTier\": 1}]",
    "DBClusterOptionGroupMemberships": "null",
    "DBClusterParameterGroup"        : "default.neptune1.2",
    "EarliestRestorableTime"         : "2023-08-18T09:24:24.384000Z",
    "Endpoint"                       : ".neptune.cn-north-1.amazonaws.com.cn",
    "LatestRestorableTime"           : "2023-08-18T09:51:15.785000Z",
    "MultiAZ"                        : false,
    "PendingModifiedValues"          : "null",
    "Port"                           : 8182,
    "PreferredBackupWindow"          : "11:55-12:25",
    "PreferredMaintenanceWindow"     : "wed:08:13-wed:08:43",
    "ReaderEndpoint"                 : ".neptune.cn-north-1.amazonaws.com.cn",
    "StorageEncrypted"               : false,
    "VpcSecurityGroups"              : "[{\"Status\": \"active\", \"VpcSecurityGroupId\": \"sg-088b699dac95f5da9\"}]",
    "message"                        : "{Instance JSON data}"
  }
}

Note

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

4. IAM Policy Permissions¶

Note

If users collect resources by assuming an IAM role, certain operational permissions need to be enabled.

This collector requires the following permissions:

rds:DescribeDBClusters

X. Appendix¶

Please refer to the AWS official documentation: