-
Notifications
You must be signed in to change notification settings - Fork 395
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
[docs] Notes about debug mode, and debugging in Kubernetes #476
Conversation
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.
All good to me, but maybe we should move the testing part somewhere else?
|
||
`Please read on if you are curious about further configuration, or | ||
would rather set up Datadog Tracing explicitly in code.` | ||
If you're running in a Kubernetes cluster, and still don't see your traces, make sure your application has a route to the tracing Agent. An easy way to test this is with a:: |
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.
Would make sense to move this part in a separated section? It's kind of generic and applies to other frameworks too.
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.
Sure! If you can find a place for it that makes more sense, I'm cool with that.
I initially thought putting this at the top where we're showing how to set up the Agent made sense.
But based upon feedback I've been seeing, I think a separate dedicated section for debugging might make more sense. Possibly going into detail about differences between ddtrace-run
and patch_all()
, and showing how to enable debugging in code without the environment variable set.
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.
What if we create a Troubleshooting section after Advance Usage
?
Also yes, we need to describe the difference between ddtrace-run
and patch_all()
at the beginning of the documentation. It's something important that is not clear. Can you do these 2 changes if they make sense?
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.
We'll prepare a follow-up PR to redact our Python documentation.
Adds information to the debugging process for new users.
Clarifies running your application in debug mode disables traces as suggested by ndkv.
Also gives an example command to see if your traces are being shipped or not in a Kubernetes environment. I'm open to suggestions here if someone knows a better / quicker way.