AWS Neptune Cluster¶
The displayed Metrics of AWS Neptune Cluster include cold start time, execution time, concurrent executions, and memory usage, which reflect the response speed, scalability, and resource utilization of the Neptune Cluster function.
Configuration¶
Install Func¶
It is recommended to activate the TrueWatch Integration - Extensions - DataFlux Func (Automata): All prerequisites are automatically installed. Please proceed with the script installation.
For self-deployment of Func, refer to Self-deployment of Func
Install Script¶
Note: Please prepare the required AWS AK in advance (for simplicity, you can directly grant the CloudWatch read-only permission
CloudWatchReadOnlyAccess
)
Managed Version Activation Script¶
- Log in to the TrueWatch console
- Click on the 【Integration】 menu, select 【Cloud Account Management】
- Click on 【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
- Click on 【Test】, if the test is successful, click on 【Save】. If the test fails, please check the relevant configuration information and retest
- Click on 【Cloud Account Management】, you can see the added cloud account in the list, click on the corresponding cloud account to enter the details page
- Click on the 【Integration】 button on the cloud account details page, find
AWS Neptune Cluster
under theUninstalled
list, and click on the 【Install】 button to pop up the installation interface for installation.
Manual Activation Script¶
-
Log in to the Func console, click on 【Script Market】, enter the TrueWatch script market, search for:
integration_aws_neptune_cluster
-
Click on 【Install】, then enter the corresponding parameters: AWS AK ID, AK Secret, and account name.
-
Click on 【Deploy Startup Script】, the system will automatically create the
Startup
script set and configure the corresponding startup script. -
After activation, you can see the corresponding automatic trigger configuration in 「Management / Automatic Trigger Configuration」. Click on 【Execute】 to immediately execute once without waiting for the scheduled time. After a while, you can check the execution task record and corresponding logs.
Verification¶
- In 「Management / Automatic Trigger Configuration」, confirm whether the corresponding task has the corresponding automatic trigger configuration, and you can also check the corresponding task record and logs to check for any exceptions
- In TrueWatch, check whether asset information exists in 「Infrastructure / Custom」
- In TrueWatch, check whether 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 Neptune Cluster Metrics Details
Metrics¶
Metric | Description |
---|---|
BackupRetentionPeriodStorageUsed |
The total amount of backup storage supported by the backup retention window of the Neptune database cluster (in bytes). Included in the total reported by the TotalBackupStorageBilled metric. |
BufferCacheHitRatio |
The percentage of requests served by the buffer cache. This metric can be used to diagnose query latency, as cache misses can cause significant delays. If the cache hit ratio is below 99.9, consider upgrading the instance type to cache more data in memory. |
ClusterReplicaLag |
For read replicas, the total lag (in milliseconds) when replicating updates from the primary instance. |
ClusterReplicaLagMaximum |
The maximum lag (in milliseconds) between the primary instance and each Neptune database instance in the database cluster. |
ClusterReplicaLagMinimum |
The minimum lag (in milliseconds) between the primary instance and each Neptune database instance in the database cluster. |
CPUUtilization |
The percentage of CPU utilization. |
EngineUptime |
The length of time (in seconds) that the instance has been running. |
FreeableMemory |
The amount of available random access memory (in bytes). |
GlobalDbDataTransferBytes |
The number of bytes of redo log data transferred from the primary serverAWS region to the secondaryAWS region in the Neptune global database. |
GlobalDbReplicatedWriteIO |
The number of write I/O operations replicated from the primary server,AWS region in the global database to the auxiliary database cluster volumeAWS region. The billing calculation for each database cluster in the Neptune global database uses theVolumeWriteIOPSmetric to measure the write operations performed within that cluster. For the primary database cluster, the billing calculation usesGlobalDbReplicatedWriteIOto take into account cross-region replication for the auxiliary database cluster. |
GlobalDbProgressLag |
For user transactions and system transactions, the number of milliseconds the auxiliary cluster lags behind the primary cluster. |
GremlinRequestsPerSec |
The number of requests per second to the Gremlin engine. |
GremlinWebSocketOpenConnections |
The number of openWebSocketconnections to Neptune. |
LoaderRequestsPerSec |
The number of loader requests per second. |
MainRequestQueuePendingRequests |
The number of requests waiting to be executed in the input queue. When requests exceed the maximum queue capacity, Neptune starts throttling requests. |
NCUUtilization |
At the cluster level,NCUUtilizationreports the percentage of maximum capacity used by the entire cluster. |
NetworkThroughput |
The network throughput (in bytes per second) received from and transmitted to clients by each instance in the Neptune database cluster. This throughput does notinclude the network traffic between instances in the database cluster and the cluster volume. |
Object¶
The collected AWS Neptune Cluster object data structure can be seen in 「Infrastructure - Custom」
{
"measurement": "aws_neptune_cluster",
"tags": {
"DBClusterIdentifier" :"test",
"class" :"aws_neptune_cluster",
"cloud_provider" :"aws",
"FunctionName" :"dataflux-alb",
"name" :"dataflux-alb",
"PackageType" :"Zip",
"RegionId" :"cn-northwest-1",
"RevisionId" :"5e52ff51-615a-4ecb-96b7-40083a7b4b62",
"Role" :"arn:aws-cn:iam::XXXX:role/service-role/s3--xxxx-role-xxxx",
"Runtime" :"python3.7",
"Version" :"$LATEST"
},
"fields": {
"CreatedTime" : "2022-03-09T06:13:31Z",
"ListenerDescriptions": "{JSON data}",
"AvailabilityZones" : "{Availability Zone JSON data}",
"message" : "{Instance JSON data}"
}
}
Note: The fields in
tags
andfields
may change with subsequent updatesTip 1: The value of
tags.account_name
is the instance ID, used as a unique identifier