How to use monitorCustom

[wernermorgenstern]

I was wondering if anybody has sample code in how to use monitorCustom?
I want to use it to have Dashboards and Alarms for IoT Rules, and also other resources, which are currently not enabled for CDK?

[echeung-amzn]

We need to write some more documentation for it (#153).

In general, you can just pass in some metrics like so:

this.facade.monitorCustom({
    alarmFriendlyName: 'My-Custom-Alarm',
    description: 'Sample custom alarm',
    metricGroups: [
        {
            title: 'Errors-Sum',
            metrics: [
                {
                    alarmFriendlyName: 'UnknownError-Sum',
                    metric: new Metric({
                        // cf. whatever you have in Cloudwatch metrics
                        namespace: 'MyNameSpace',
                        metricName: 'AnError',
                        statistic: MetricStatistic.SUM,
                        dimensionsMap: {
                            MyDimen: 'DimenValue',
                        },
                    }),
                    addAlarm: {
                        Critical: {
                            comparisonOperator: ComparisonOperator.GREATER_THAN_THRESHOLD,
                            treatMissingDataOverride: TreatMissingData.IGNORE,
                            threshold: 0,
                            actionOverride: ...,
                        },
                    },
                },
            ],
        },
    ],
});

[wernermorgenstern]

Thank you. I actually have one more question :)
Currently, when I use the AWS CDK Cloudwatch Module, I can use SingleValueWidget (just to display a number).
Does cdk-monitoring-constructs have that yet? I see in the code itself, it is only used for the Billing Alarm/Dashboard right now.

[echeung-amzn]

Will be added in #182

[voho]

The PR got merged, so you should be able to use it in the latest release.