cdk-monitoring-constructs/lib/monitoring/aws-kinesis/KinesisDataStreamConsumerMetricFactory.d.ts

[](https://badge.fury.io/js/cdk-monitoring-constructs) [](https://m

import { DimensionsMap } from "aws-cdk-lib/aws-cloudwatch";
import { BaseMetricFactory, BaseMetricFactoryProps, MetricFactory } from "../../common";
export interface KinesisDataStreamConsumerMetricFactoryProps extends BaseMetricFactoryProps {
    readonly streamName: string;
    readonly consumerName: string;
}
/**
 * Metrics for a single enhanced fan-out (EFO) consumer of a Kinesis data stream.
 * Dimensions: {StreamName, ConsumerName}.
 *
 * @see https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html#kinesis-metrics-consumer
 */
export declare class KinesisDataStreamConsumerMetricFactory extends BaseMetricFactory {
    protected readonly dimensionsMap: DimensionsMap;
    constructor(metricFactory: MetricFactory, props: KinesisDataStreamConsumerMetricFactoryProps);
    /** Max lag (ms) for events delivered to this EFO consumer. */
    metricSubscribeToShardEventMillisBehindLatestMaxMs(): import("../../common").MetricWithAlarmSupport;
    /** Rate at which SubscribeToShard calls for this consumer are throttled. */
    metricSubscribeToShardRateExceededAverage(): import("../../common").MetricWithAlarmSupport;
    /** Success rate of SubscribeToShard calls (connect handshake). */
    metricSubscribeToShardSuccessAverage(): import("../../common").MetricWithAlarmSupport;
    /** Success rate of individual SubscribeToShardEvent deliveries within an open subscription. */
    metricSubscribeToShardEventSuccessAverage(): import("../../common").MetricWithAlarmSupport;
    /** Records delivered to this consumer. */
    metricSubscribeToShardEventRecordsSumCount(): import("../../common").MetricWithAlarmSupport;
    /** Bytes delivered to this consumer. */
    metricSubscribeToShardEventSumBytes(): import("../../common").MetricWithAlarmSupport;
}