Amazon CloudFront additional real-time metrics in Amazon CloudWatch

[piyushsonigra]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

AWS recently released feature in CloudFront to view additional cloudwatch metrics.

New or Affected Resource(s)

aws_cloudfront_distribution

Potential Terraform Configuration

terraform "aws_cloudfront_distribution" "cf_name" {
   ....
   additional_metrics = true
   ....
}

References

https://aws.amazon.com/about-aws/whats-new/2019/12/cloudfront-realtime-metrics/
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional

[asaghri]

Hi, any update on this ? This feature will be greatly appreciated !

[jpeeler]

I was looking for this as well, but wasn't able to find the functionality implemented in https://github.com/aws/aws-sdk-go. Did I miss it? If not, it's doubtful this can move forward until the SDK supports it.

[r1m]

Apparently the console is using an undocumented API method (UpdateMonitoringSubscription) that is not public yet and not part of any SDK I checked. AWS support confirmed to me that it is not possible yet through SDK.

[anmolbhatia05]

@piyushsonigra Is there a way to enable real time metrics via terraform now ?

[vicentllongo]

The functionality to manage additional and real-time metrics is already available in the aws-sdk-go since v1.34.13:

You can now manage CloudFront's additional, real-time metrics with the CloudFront API.

[piyushsonigra]

@anmolbhatia05 directly inside terraform resource, it's not available yet but you can enable additional metrics using null_resource and local-exec Provisioner and execute AWS cli command.

resource "aws_cloudfront_distribution" "distribution" {
  ....
  ....
}

resource "null_resource" "cloudfront_addtional_metrics" {

 provisioner "local-exec" {
   command = "aws --profile $aws_profile cloudfront create-monitoring-subscription --distribution-id $cloudfront_distribution_id --monitoring-subscription RealtimeMetricsSubscriptionConfig={RealtimeMetricsSubscriptionStatus=Enabled}"

   environment = {
      aws_profile = var.aws_profile
      cloudfront_distribution_id = aws_cloudfront_distribution.distribution.id
    }
  }
}

[ewbankkit]

Potential new resource:

resource "aws_cloudfront_monitoring_subscription" "example" {
  distribution_id = aws_cloudfront_distribution.example.id

  monitoring_subscription {
    realtime_metrics_subscription_config {
      realtime_metrics_subscription_status = "Enabled"
    }
  }
}

[shuheiktgw]

I've started implementing this resource

[shuheiktgw]

I added the resource in #18083 and it's now ready for review. Please upvote the PR for faster review! 🙏

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.