feat: add opentelemetry tracer to record the sync trace #697
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: yafeiaa <[email protected]>
Signed-off-by: yafeiaa <[email protected]>
Signed-off-by: yafeiaa <[email protected]>
Signed-off-by: yafeiaa <[email protected]>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #697 +/- ##
==========================================
- Coverage 54.26% 53.24% -1.03%
==========================================
Files 64 65 +1
Lines 6164 6485 +321
==========================================
+ Hits 3345 3453 +108
- Misses 2549 2756 +207
- Partials 270 276 +6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
yafeiaa
changed the title
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Purpose
This submission aims to integrate OpenTelemetry tracing functionality into the GitOps engine's synchronization process, enhancing the observability and debugging capabilities of synchronization operations.
Major Changes
TracerandSpaninterfaces to support tracing operations.syncContext: Updated thesyncContextstructure to include tracing-related fields and created spans during the execution ofcreatetasks,hooktasks, andprunetasks to record the duration of each task execution in Kubernetes.Impact
These changes will enhance the observability of the GitOps engine when handling synchronization tasks, making it easier for developers to perform performance analysis and troubleshoot issues.
This functionality has been thoroughly validated in our company's internal fork of the ArgoCD and GitOps engine projects. It helps us analyze the synchronization process in depth, improving synchronization speed and allowing all collaborators in our team to better understand the order in which ArgoCD applies resources to Kubernetes. This improvement not only enhances our observability but also fosters collaboration and communication within the team.
Effect Diagram
Below is an effect diagram showcasing the tracing information of synchronization tasks as used within our company:
If this commit can be merged, I will submit the corresponding changes to the
argoproj/argo-cdproject to enable this functionality in ArgoCD. Of course, I am more than willing to provide further explanations regarding the necessity of this feature if needed.