Merge pull request #1 from time-loop/badge

chore: README updates

Author: ahammond

README.md

@@ -1,34 +1,51 @@
-# LambdaEniUsageMetricPublisher
-A construct that creates an AWS Lambda function to publish ENI usage metrics to CloudWatch.
+[![codecov](https://codecov.io/gh/time-loop/cdk-redis-queue-depth-metric-publisher/graph/badge.svg?token=ks9w215OJm)](https://codecov.io/gh/time-loop/cdk-redis-queue-depth-metric-publisher)
+
+# RedisQueueDepthMetricPublisher
+A construct that creates an AWS Lambda function to publish
+queue depths from a redis instance
 
 ## Usage
-To use the `LambdaEniUsageMetricPublisher` construct, simply import it into your AWS CDK stack and create a new instance of the construct:
+To use the `RedisQueueDepthMetricPublisher` construct, simply import it into your AWS CDK stack and create a new instance of the construct:
 
 ``` ts
 import { Stack } from 'aws-cdk-lib';
-import { LambdaEniUsageMetricPublisher } from './lambda-eni-usage-metric-publisher';
-
-const stack = new Stack(app, 'MyStack');
-
-new LambdaEniUsageMetricPublisher(stack, 'MyLambdaEniUsageMetricPublisher', {
-  publishFrequency: 5,
-  regions: ['us-east-1', 'us-west-2'],
-  cwNamespace: 'MyNamespace',
+import { RedisQueueDepthMetricPublisher } from './cdk-redis-queue-depth-metric-publisher';
+
+let stack: Stack;
+
+new RedisQueueDepthMetricPublisher(stack, 'RedisQueueDepthMetricPublisher', {
+  cwNamespace: 'example',
+  cloudwatchLogsRetention: RetentionDays.THREE_MONTHS,
+  publishFrequency: Duration.minutes(5),
+  queues: ['fakeQueue', 'fakeQueue2'],
+  redisAddr: 'fakeRedisAddr',
+  // redisPort: '123456', // Optional
+  redisSecretArn: 'fakeRedisSecretArn',
+  redisSecretKeyArn: 'fakeRedisSecretKeyArn',
+  // redisSecretPasswordPath: 'fakeRedisSecretPasswordPath',
+  // redisSecretUsernamePath: 'fakeRedisSecretUsernamePath',
 });
 ```
 
-This will create a new AWS Lambda function that publishes ENI usage metrics to CloudWatch every 5 minutes for the `us-east-1` and `us-west-2` regions, using the `MyNamespace` namespace.
+This will create a new AWS Lambda function that publishes queue depth metrics to CloudWatch every 5
+minutes. It pulls the information from the `fakeRedisAddr` redis instance on the default port.
+It will fetch login credentials from `redisSecretArn`, log into the redis instance and query
+the two queues `['fakeQueue', 'fakeQueue2']`, then publish the info to the `cwNamespace` with
+metric names that are identical to the queue names.
+NOTE: no mapping is currently supported for the queue names.
 
 ## API
-`LambdaEniUsageMetricPublisher(scope: Construct, id: string, props: LambdaEniUsageMetricPublisherProps)`
+`RedisQueueDepthMetricPublisher(scope: Construct, id: string, props: RedisQueueDepthMetricPublisherProps)`
 
-Creates a new instance of the `LambdaEniUsageMetricPublisher` construct.
+Creates a new instance of the `RedisQueueDepthMetricPublisher` construct.
 
 ### Parameters
 - `scope` - The parent construct.
 - `id` - The ID of the construct.
 - `props` - The properties of the construct.
 
+WRITEME FROM HERE DOWN
+
 ### Properties
 - `publishFrequency` - The time interval (in minutes) that the Lambda function will be triggered to publish metrics to CloudWatch.
 - `regions` - The list of AWS regions to publish ENI usage metrics for.

src/construct.ts

@@ -21,9 +21,9 @@ export interface RedisQueueDepthMetricPublisherProps {
   readonly cwNamespace?: string;
   /**
    * Time intervals that Lambda will be triggered to publish metric in CloudWatch.
-   * @default 1
+   * @default Duration.minutes(1)
    */
-  readonly publishFrequency?: number;
+  readonly publishFrequency?: Duration;
   /**
    * List of queues to measure depth for.
    */
@@ -81,7 +81,7 @@ export interface RedisQueueDepthMetricPublisherProps {
  * A construct that creates an AWS Lambda function to publish ENI usage metrics to CloudWatch.
  */
 export class RedisQueueDepthMetricPublisher extends Construct {
-  readonly publishFrequency: number;
+  readonly publishFrequency: Duration;
   readonly regions: string[];
   readonly handler: NodejsFunction;
   readonly rule: Rule;
@@ -96,7 +96,7 @@ export class RedisQueueDepthMetricPublisher extends Construct {
 
   constructor(scope: Construct, id: Namer, props: RedisQueueDepthMetricPublisherProps) {
     super(scope, id.pascal);
-    this.publishFrequency = props.publishFrequency ?? 1;
+    this.publishFrequency = props.publishFrequency ?? Duration.minutes(1);
     this.cwNamespace = props.cwNamespace ?? 'RedisQueueDepth';
     const myConstruct = this;
 
@@ -149,7 +149,7 @@ export class RedisQueueDepthMetricPublisher extends Construct {
       .addEnvironment('REDIS_SECRET_USERNAME_PATH', props.redisSecretUsernamePath ?? 'username')
 
     this.rule = new Rule(this, 'rule', {
-      schedule: Schedule.rate(Duration.minutes(this.publishFrequency)),
+      schedule: Schedule.rate(this.publishFrequency),
     });
     this.rule.addTarget(new LambdaFunction(this.handler));
   }

test/construct.test.ts

@@ -1,5 +1,6 @@
-import { App, Stack } from 'aws-cdk-lib';
+import { App, Duration, Stack } from 'aws-cdk-lib';
 import { Template } from 'aws-cdk-lib/assertions';
+import { RetentionDays } from 'aws-cdk-lib/aws-logs';
 import { Namer } from 'multi-convention-namer';
 import { RedisQueueDepthMetricPublisher, RedisQueueDepthMetricPublisherProps } from '../src/construct';
 
@@ -14,7 +15,8 @@ beforeEach(() => {
 let template: Template;
 const defaultRedisQueueDepthMetricPublisherProps: RedisQueueDepthMetricPublisherProps = {
   cwNamespace: 'example',
-  cloudwatchLogsRetention: 7,
+  cloudwatchLogsRetention: RetentionDays.TWO_WEEKS,
+  publishFrequency: Duration.seconds(5),
   queues: ['fakeQueue', 'fakeQueue2'],
   redisAddr: 'fakeRedisAddr',
   redisPort: '123456',