npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@thundra/cdk-alarm-creator

v1.0.1

Published

AWS CDK custom resource to create a CloudWatch Alarm based on custom Target Group metrics

Downloads

21

Readme

@thundra/cdk-alarm-creator

Target Group Based Alarm Creator for AWS CDK

This package provides Constructs for creating a Target Group based CloudWatch alarms for your applications. It'll look up target group ids while creating an alarm and sets 4XX and 5XX alarms for those applications.

In it's current stage, the CDK is pretty simple and basic. We're planning to make this package as modular as possible to meet our custom CloudWatch alarm needs in the future.


About CDK Compatibility

@thundra/cdk-alarm-creator is currently only supported to CDK v2.

Installation

npm

npm i @thundra/cdk-alarm-creator

Example

import * as thundra from '@thundra/cdk-alarm-creator';

// ...

export class AlarmStack extends cdk.Stack {
    constructor(scope: Construct, id: string, props?: cdk.StackProps) {
        super(scope, id, props);

        // ...

        new thundra.CloudWatchAlarmCreator(this, `my-app-target-group-alarms`, {
            prefix: '<PREFIX_FOR_CFN_RESOURCES>',
            postfix: '<POSTFIX_FOR_CFN_RESOURCES>',
            stage: '<APPLICATION_STAGE_POSTFIX>',
            applicationName: '<APPLICATION_NAME>',
            elbArn: '<ELB_ARN>',
            threshold4xx: '<4XX_THRESHOLD>',
            threshold5xx: '<5XX_THRESHOLD>',
            alarmTopics: [
                '<SNS_TOPIC_ARN>',
            ]
        });
    }
}

Constructs

CloudWatchAlarmCreator

Initializer

new CloudWatchAlarmCreator(scope: cdk.Construct, id: string, props: CloudWatchAlarmCreatorProps);

Construct Props

export interface CloudWatchAlarmCreatorProps {
    /**
     * Prefix to be used to name custom resources.
     */
    readonly prefix?: string;
    /**
     * Postfix to be used to name custom resources.
     */
    readonly postfix?: string;
    /**
     * Application name without the stage postfix.
     * e.g. foresight-api-backend
     */
    readonly applicationName: string;
    /**
     * Application stage postfix. Will be merged with
     * `applicationName` automatically.
     * e.g. lab
     */
    readonly stage: string;
    /**
     * The ARN of the ELB that target groups are added.
     */
    readonly elbArn: string;
    /**
     * Threshold for the 4XX percentage.
     */
    readonly threshold4xx: number,
    /**
     * Threshold for the 5XX percentage.
     */
    readonly threshold5xx: number,
    /**
     * The ARN of the SNS Topics that'll be triggered
     * when the alarm sets on or off.
     */
    readonly alarmTopics: string[];
}

Licensing

@thundra/cdk-alarm-creator is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.