Skip to content

fix(tracer): add name sanitization for X-Ray subsegments #4005

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #3981

Summary

Changes

This pull request addresses the concern raised by @loesak regarding subsegment names generated when using our Tracer utility. While there's currently no loss of tracer or subsegment data, it's crucial to ensure that the generated names comply with the X-Ray specification to prevent any potential issues or warnings.

User experience

By implementing name sanitization, we'll ensure that X-Ray no longer emits warnings due to non-compliant subsegment names. This bug fix will result in customers no longer receiving X-Ray warnings.

Checklist

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

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.

@leandrodamascena leandrodamascena requested a review from a team March 22, 2024 09:45
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 22, 2024
@github-actions github-actions bot added the bug Something isn't working label Mar 22, 2024
@codecov-commenter
Copy link

codecov-commenter commented Mar 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.30%. Comparing base (e14e768) to head (9c160b9).
Report is 218 commits behind head on develop.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4005      +/-   ##
===========================================
- Coverage    96.38%   96.30%   -0.08%     
===========================================
  Files          214      215       +1     
  Lines        10030    10275     +245     
  Branches      1846     1913      +67     
===========================================
+ Hits          9667     9895     +228     
- Misses         259      271      +12     
- Partials       104      109       +5     

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

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@leandrodamascena leandrodamascena merged commit 49fc491 into aws-powertools:develop Mar 22, 2024
14 checks passed
@leandrodamascena leandrodamascena deleted the tracer-remove-chars branch March 22, 2024 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working commons size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tests tracer Tracer utility
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Generates valid subsegment names that comply with X-Ray SDK restrictions
3 participants