AWS keyspaces documentation change
Summary
Restructured documentation to add CDC metrics section, updated headings, removed CloudWatch console/CLI instructions, and added detailed metrics for Change Data Capture (CDC) operations
Security assessment
The changes primarily add monitoring metrics for CDC operations and reorganize content. There is no mention of vulnerabilities, security incidents, or security controls. The CDC metrics help monitor API operations but don't directly address security weaknesses.
Diff
diff --git a/keyspaces/latest/devguide/metrics-dimensions.md b/keyspaces/latest/devguide/metrics-dimensions.md index 6afca1467..ebbd27cf5 100644 --- a//keyspaces/latest/devguide/metrics-dimensions.md +++ b//keyspaces/latest/devguide/metrics-dimensions.md @@ -5 +5 @@ -Amazon Keyspaces metrics and dimensions +Amazon Keyspaces metricsDimensions for Amazon Keyspaces metricsMetrics for Amazon Keyspaces change data capture (CDC) @@ -9 +9 @@ Amazon Keyspaces metrics and dimensions -When you interact with Amazon Keyspaces, it sends the following metrics and dimensions to Amazon CloudWatch. All metrics are aggregated and reported every minute. You can use the following procedures to view the metrics for Amazon Keyspaces. +When you interact with Amazon Keyspaces, it sends metrics and dimensions to Amazon CloudWatch. All metrics are aggregated and reported every minute. The following sections are an overview of all available metrics for Amazon Keyspaces. @@ -11 +11 @@ When you interact with Amazon Keyspaces, it sends the following metrics and dime -###### To view metrics using the CloudWatch console +###### Topics @@ -13 +13 @@ When you interact with Amazon Keyspaces, it sends the following metrics and dime -Metrics are grouped first by the service namespace, and then by the various dimension combinations within each namespace. + * Amazon Keyspaces metrics @@ -15 +15 @@ Metrics are grouped first by the service namespace, and then by the various dime - 1. Open the CloudWatch console at [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/). + * Dimensions for Amazon Keyspaces metrics @@ -17 +17 @@ Metrics are grouped first by the service namespace, and then by the various dime - 2. If necessary, change the Region. On the navigation bar, choose the Region where your AWS resources reside. For more information, see [AWS service endpoints](http://docs.aws.amazon.com/general/latest/gr/rande.html). + * Metrics for Amazon Keyspaces change data capture (CDC) @@ -19 +18,0 @@ Metrics are grouped first by the service namespace, and then by the various dime - 3. In the navigation pane, choose **Metrics**. @@ -21 +19,0 @@ Metrics are grouped first by the service namespace, and then by the various dime - 4. Under the **All metrics** tab, choose `AWS/Cassandra.` @@ -24,16 +22 @@ Metrics are grouped first by the service namespace, and then by the various dime - - -###### To view metrics using the AWS CLI - - * At a command prompt, use the following command. - - aws cloudwatch list-metrics --namespace "AWS/Cassandra" - - - - -## Amazon Keyspaces metrics and dimensions - -The metrics and dimensions that Amazon Keyspaces sends to Amazon CloudWatch are listed here. - -### Amazon Keyspaces metrics +## Amazon Keyspaces metrics @@ -205 +188 @@ Logical Amazon Keyspaces partitions can span multiple storage partitions and are -`SuccessfulRequestLatency` reflects activity only within Amazon Keyspaces and does not take into account network latency or client-side activity. Units: `Milliseconds` Dimensions: `Keyspace, TableName, Operation` Valid Statistics: +`SuccessfulRequestLatency` reflects activity only within Amazon Keyspaces and doesn’t take network latency or client-side activity into account. Units: `Milliseconds` Dimensions: `Keyspace, TableName, Operation` Valid Statistics: @@ -229 +212 @@ Logical Amazon Keyspaces partitions can span multiple storage partitions and are -`UserErrors` | Requests to Amazon Keyspaces that generate an `InvalidRequest` error during the specified time period. An `InvalidRequest` usually indicates a client-side error, such as an invalid combination of parameters, an attempt to update a nonexistent table, or an incorrect request signature. `UserErrors` represents the aggregate of invalid requests for the current AWS Region and the current AWS account. Units: `Count` Dimensions: `Keyspace, TableName, Operation` Valid Statistics: +`UserErrors` | Requests to Amazon Keyspaces that generate an `InvalidRequest` error during the specified time period. `InvalidRequest` errors usually represent a client-side error, for example an invalid combination of parameters, an attempt to update a non-existent table, or an incorrect request signature. `UserErrors` represent the aggregate of invalid requests for the current AWS Region and the current AWS account. Units: `Count` Dimensions: `Keyspace, TableName, Operation` Valid Statistics: @@ -242 +225 @@ Logical Amazon Keyspaces partitions can span multiple storage partitions and are -### Dimensions for Amazon Keyspaces metrics +## Dimensions for Amazon Keyspaces metrics @@ -251,0 +235,41 @@ Dimension | Description +## Metrics for Amazon Keyspaces change data capture (CDC) + +The following metrics are available in your CloudWatch account that monitor API calls to the Amazon Keyspaces change data capture (CDC) endpoint. + +Metric | Description +---|--- +`ReturnedRecordsCount` | The number of stream records returned by `GetRecords` operations during the specified time period. Units: `Count` Dimensions: `Keyspace, TableName, Operation` Valid Statistics: + + * `Minimum` + * `Maximum` + * `Average` + * `SampleCount` + * `Sum` + + +`SuccessfulRequestLatency` | The successful requests to Amazon Keyspaces during the specified time period. `SuccessfulRequestLatency` can provide two different kinds of information: + + * The elapsed time for successful requests (`Minimum`, `Maximum`, `Sum`, or `Average`). + * The number of successful requests (`SampleCount`). + +`SuccessfulRequestLatency` reflects activity only within Amazon Keyspaces CDC APIs and doesn’t take network latency or client-side activity into account. Units: `Milliseconds` Dimensions: `Keyspace, TableName, Operation` Valid Statistics: + + * `Minimum` + * `Maximum` + * `Average` + * `SampleCount` + + +`SystemErrors` | The requests to Amazon Keyspaces CDC that generate a `HTTP 500` status code during the specified time period. A `HTTP 500` status code usually indicates an internal service error. Units: `Count` Dimensions: `Keyspace, TableName, Operation` Valid Statistics: + + * `Sum` + * `SampleCount` + + +`UserErrors` | Requests to Amazon Keyspaces CDC that generate an `HTTP 400` status code during the specified time period. `UserErrors` represents the aggregate of `HTTP 400` errors for Amazon Keyspaces CDC in the current AWS Region and the current AWS account. Units: `Count` Dimensions: `Keyspace, TableName, Operation` Valid Statistics: + + * `Sum` + * `SampleCount` + + + @@ -260 +284 @@ Monitoring with CloudWatch -Creating alarms +View metrics