Skip to content

AWS Neptune Cluster

The metrics displayed for AWS Neptune Cluster include cold start time, execution time, number of concurrent executions, and memory usage. These metrics reflect the response speed, scalability, and resource utilization of the Neptune Cluster functions.

Configuration

Install Func

It is recommended to activate the Guance integration - Extensions - Managed Func: all prerequisites are automatically installed. Please proceed with script installation.

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

Installation Script

Tip: Please prepare an Amazon Web Services AK that meets the requirements in advance (for simplicity, you can directly grant read-only permission CloudWatchReadOnlyAccess).

Script for Managed Version Activation

  1. Log in to the Guance console.
  2. Click on the 【Integration】 menu and select 【Cloud Account Management】.
  3. Click 【Add Cloud Account】, select 【AWS】, and fill in the required information. If you have already configured cloud account information previously, skip this step.
  4. Click 【Test】; after a successful test, click 【Save】. If the test fails, please check whether the configuration information is correct and re-test.
  5. In the 【Cloud Account Management】 list, you can see the added cloud accounts. Click on the corresponding cloud account to enter the details page.
  6. On the cloud account details page, click the 【Integration】 button. Under the Not Installed list, find AWS Neptune Cluster and click the 【Install】 button to install it using the pop-up interface.

Script for Manual Activation

  1. Log in to the Func console, click 【Script Market】 to access the official script market, and search for: guance_aws_neptune_cluster.

  2. After clicking 【Install】, input the relevant parameters: AWS AK ID, AK Secret, and account name.

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

  4. After activation, you can view the corresponding auto-trigger configurations under «Management / Auto-Trigger Configuration». Click 【Execute】 to run it immediately without waiting for scheduled intervals. Wait a moment, and then check the execution task records and corresponding logs.

Verification

  1. Confirm in «Management / Auto-Trigger Configuration» whether there is an auto-trigger configuration for the corresponding task. You can also check the task records and logs for any abnormalities.
  2. In Guance, view infrastructure asset information under «Infrastructure / Custom».
  3. In Guance, check for corresponding monitoring data under «Metrics».

Metrics

Once Amazon CloudWatch is configured, the default measurement sets are as follows. More metrics can be collected by configuring accordingly:

Amazon CloudWatch Neptune Cluster Metric Details

Metrics

Metric Description
BackupRetentionPeriodStorageUsed Total amount of backup storage used (in bytes) supported by the Neptune database cluster's backup retention window. Included in the total reported by the TotalBackupStorageBilled metric.
BufferCacheHitRatio Percentage of requests served by the buffer cache. This metric can be used to diagnose query latency because cache misses cause significant delays. If the cache hit rate drops 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 delay (in milliseconds) between the primary instance and each Neptune database instance within the database cluster.
ClusterReplicaLagMinimum The minimum delay (in milliseconds) between the primary instance and each Neptune database instance within the database cluster.
CPUUtilization CPU utilization percentage.
EngineUptime Length of time (in seconds) the instance has been running.
FreeableMemory Amount of available random access memory (in bytes).
GlobalDbDataTransferBytes Number of bytes of redo log data transferred from the primary AWS Region to the secondary AWS Region in a Neptune global database.
GlobalDbReplicatedWriteIO The number of write I/O operations replicated from the primary AWS Region to the secondary database clusters in the global database.
Billing calculations for each database cluster in a Neptune global database use the VolumeWriteIOPS metric to measure write operations performed within that cluster. For the primary database cluster, billing calculations use GlobalDbReplicatedWriteIO to account for cross-region replication to secondary database clusters.
GlobalDbProgressLag Milliseconds behind the primary cluster that the secondary cluster is for user transactions and system transactions.
GremlinRequestsPerSec Number of requests per second to the Gremlin engine.
GremlinWebSocketOpenConnections Number of open WebSocket connections to Neptune.
LoaderRequestsPerSec Number of loader requests per second.
MainRequestQueuePendingRequests Number of requests waiting in the input queue for execution. When requests exceed the maximum queue capacity, Neptune begins throttling requests.
NCUUtilization At the cluster level, NCUUtilization reports the percentage of maximum capacity used across the entire cluster.
NetworkThroughput Network throughput for each instance in the Neptune database cluster receiving from and transmitting to clients, measured in bytes per second. This throughput does not include network traffic between instances in the database cluster and the cluster volume.

Objects

The collected AWS Neptune Cluster object data structure can be viewed under «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: Fields in tags and fields may change with subsequent updates.

Tip 1: tags.account_name value is the instance ID, serving as a unique identifier.

Feedback

Is this page helpful? ×