-
Notifications
You must be signed in to change notification settings - Fork 96
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
Support tracing via the ObservabilityPolicy #2004
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2004 +/- ##
==========================================
- Coverage 87.66% 87.61% -0.05%
==========================================
Files 93 96 +3
Lines 6557 6694 +137
Branches 50 50
==========================================
+ Hits 5748 5865 +117
- Misses 753 773 +20
Partials 56 56 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sjberman can you add some tests here:
NOTE: When adding a new NGF policy to the change processor, |
We just need to make sure the shared policy store correctly handles multiple policy types.
Problem: As a user, I want to be able to enable tracing for requests flowing through NGF to my backend applications, so I can understand and debug my requests. Solution: Using the ObservabilityPolicy, an app dev can now enable and configure tracing for their Route(s). The policy will only be applied if the NginxProxy configuration containing the tracing collector endpoint has been defined and attached to the GatewayClass. The policy can be attached to one or more HTTP or GRPC Routes. Updated span attributes from the NginxProxy to be applied at the location block context, otherwise they are overwritten. Also added functional tests to ensure that the complete solution is working.
Verify end to end tracing by creating a collector and sending trace data to it. Test cases: 1. one policy attached to one route 2. one policy attached to multiple routes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀 🚀
Problem: As a user, I want to be able to enable tracing for requests flowing through NGF to my backend applications, so I can understand and debug my requests.
Solution: Using the ObservabilityPolicy, an app dev can now enable and configure tracing for their Route(s). The policy will only be applied if the NginxProxy configuration containing the tracing collector endpoint has been defined and attached to the GatewayClass. The policy can be attached to one or more HTTP or GRPC Routes.
Updated span attributes from the NginxProxy to be applied at the location block context, otherwise they are overwritten.
Also added functional tests to ensure that the complete solution is working.
Testing: Add functional tests for tracing
Verify end to end tracing by creating a collector and sending trace data to it.
Test cases:
Also did lots of manual testing
Closes #1828
Closes #1911
Closes #1788
Checklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes
If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.