(cloudfront): Flag on Distribution L2 to enable publishing additional CloudWatch metrics

[straygar]

Describe the feature

The CloudFront UI and API lets you enable more granular metrics per-distribution, at an additional (fixed) cost.

There is an L1 construct that lets you do this, which can be easily integrated into the L2 construct and enabled via a prop.

Use Case

I want to create a dashboard of data like origin latency, Lambda@Edge error rate etc. and alarm on these metrics.

Proposed Solution

An additional prop for cloudfront.Distribution:

new Distribution(this, 'Distro', {
    ...,
    publishAdditionalMetrics: true,  // default: false
});

If this is set to true a CfnMonitoringSubscription instance is created:

new CfnMonitoringSubscription(nextJsDeployment.distribution, 'MonitoringSubscription', {
    distributionId: nextJsDeployment.distribution.distributionId,
    monitoringSubscription: {
        realtimeMetricsSubscriptionConfig: {
            realtimeMetricsSubscriptionStatus: 'Enabled',
        }
    }
});

Also, we probably want to expose these metrics via distro.metricsXyz() methods (should probably throw, if publishAdditionalMetrics is set to false.

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.50.0

Environment details (OS name and version, etc.)

n/a

[peterwoodworth]

Thanks for the feature request @straygar,

I am marking this issue as p2, which means that we are unable to work on this immediately.

We use +1s to help prioritize our work, and are happy to revaluate this issue based on community feedback. You can reach out to the cdk.dev community on Slack to solicit support for reprioritization.

Check out our contributing guide if you're interested in contributing yourself. Before you start contributing, you will probably want to spend some time discussing the best direction to go with someone on the team. There aren't any L2s for CfnMonitoringSubscription yet, it's possible we'd want to tackle that first before this feature.

[straygar]

@peterwoodworth Alright, thanks! I'd like to contribute, but I'm not sure what discussion is to be had there. CfnMonitoringSubscription is currently just a boolean flag wrapped in some objects, I reckon creating an L2 might be overkill. Happy to be challenged though.

My suggestion above was just a publishAdditionalMetrics/publishRealtimeMetrics flag, but we can also make it an object to be ready for future CFN changes:

monitoringSubscriptions: { 
    realtimeMetrics: RealtimeMetrics.ENABLED/DISABLED 
}

In any case, what is the best way to involve somebody from the CDK team to discuss this?

[github-actions]

This issue has received a significant amount of attention so we are automatically upgrading its priority. A member of the community will see the re-prioritization and provide an update on the issue.

[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.