feat(metrics): add runtime validations for the metric name

[sdangol]

Issue number: #7010

Summary

This PR adds runtime validation for the metric name. It ensures that the metric name meets the required constraints before they are added, providing better error handling and feedback to users. This was done to prevent potential issues that could have come up due to invalid metric name being passed to Cloudwatch.

Changes

• Added runtime validation for the Metric Name: Validated according to the constraints in https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
• Added constants for metric name length constraints (MIN_METRIC_NAME_LENGTH and MAX_METRIC_NAME_LENGTH)
• Added tests for the new validations

User experience

Before this, for the users who were passing in an invalid metric name (empty string or a string of more than 255 characters), the metrics would get silently dropped. But, now the users will get an error.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[boring-cyborg]

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[codecov]

Codecov Report

Attention: Patch coverage is 85.71429% with 2 lines in your changes missing coverage. Please review.

Project coverage is 96.24%. Comparing base (a73282d) to head (bf7639c).
Report is 4 commits behind head on develop.

Files with missing lines	Patch %	Lines
aws_lambda_powertools/metrics/base.py	60.00%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #7026      +/-   ##
===========================================
- Coverage    96.25%   96.24%   -0.02%     
===========================================
  Files          275      275              
  Lines        12884    12896      +12     
  Branches       950      952       +2     
===========================================
+ Hits         12402    12412      +10     
- Misses         377      378       +1     
- Partials       105      106       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[leandrodamascena]

Hey @sdangol thanks a lot for submitting this PR!! I just left a small comment and we are good to merge.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[leandrodamascena]

Thanks a lot for working on this and addressing the feedback @sdangol!

[boring-cyborg]

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!