(aws-dynamodb): metricThrottledRequestsForOperation is not part of the ITable interface.

[Sunilkby17]

Describe the bug

ITable interface doesn't contain metricThrottledRequestsForOperation but instead contains deprecated metricThrottledRequests which has an issue and doesn't provide any metrics at all. By just having metricThrottledRequests in ITable interface is hiding the fact that it's deprecated and not allowing the recommended metricThrottledRequestsForOperation to use for users who declare the objects with ITable as type.

Expected Behavior

ITable interface should contain metricThrottledRequestsForOperation declaration

Current Behavior

ITable interface contains metricThrottledRequests declartion which is providing invalid metrics or not providing any metircs at all. So there is a new method (metricThrottledRequestsForOperation) provided as alternative and recommended according to documentation but it's not part of the ITable interface. If an object is declared with ITable type then the recommended method can't be accesed.

  /**
   * How many requests are throttled on this table
   *
   * Default: sum over 5 minutes
   *
   * @deprecated Do not use this function. It returns an invalid metric. Use `metricThrottledRequestsForOperation` instead.
   */
  public metricThrottledRequests(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
    return this.metric('ThrottledRequests', { statistic: 'sum', ...props });
  }

  /**
   * How many requests are throttled on this table, for the given operation
   *
   * Default: sum over 5 minutes
   */
  public metricThrottledRequestsForOperation(operation: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric {
    return new cloudwatch.Metric({
      ...DynamoDBMetrics.throttledRequestsSum({ Operation: operation, TableName: this.tableName }),
      ...props,
    }).attachTo(this);
  }

Reproduction Steps

if an object is declared with ITable as type then only getThrottledMetrics can be accessed and not metricThrottledRequestsForOperation

export class DynamoDBTableMetricGenerator {

    private readonly dynamoDbTable: ITable;

    constructor(dynamoDbTable: ITable) {
        this.dynamoDbTable = props.dynamoDbTable;
    }

    /**
     * Returns metircs for throttled requests on the table for all the operations passed
     */
    getThrottledMetrics(operations: strings[], props: MetricOptions): Metric[] {
         operations.forEach((operation) => {
                this.dynamoDbTable.metricThrottledRequests({
                    label: operation,
                    period: Duration.minutes(1),
                    dimensions: {
                        TableName: this.dynamoDbTable.tableName,
                        Operation: operation,
                    },
                }),
            });
        }
    }

Possible Solution

If metricThrottledRequestsForOperation is added to the ITable interface then the object can access it and use accordingly

export class DynamoDBTableMetricGenerator {

    private readonly dynamoDbTable: ITable;

    constructor(dynamoDbTable: ITable) {
        this.dynamoDbTable = props.dynamoDbTable;
    }

    /**
     * Returns metircs for throttled requests on the table for all the operations passed
     */
    getThrottledMetrics(operations: strings[], props: MetricOptions): Metric[] {
         operations.forEach((operation) => {
                this.dynamoDbTable.metricThrottledRequestsForOperation(operation, {
                    label: operation,
                    period: Duration.minutes(1),
                    dimensions: {
                        TableName: this.dynamoDbTable.tableName,
                        Operation: operation,
                    },
                }),
            });
        }
    }

Additional Information/Context

No response

CDK CLI Version

3

Framework Version

No response

Node.js Version

14.x

OS

GNU/Linux

Language

Typescript

Language Version

No response

Other information

No response

[VarunWachaspati]

Raised a PR to add the recommended method metricThrottledRequestsForOperation() to the ITable interface.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.