The debug section in the builder README is a good starting point in that it includes the important initial steps (debug_compilation setting + how to use go-delve dlv exec), but there are mandatory additional step after that to actually meaningfully use delve
It took me much too long to figure out that I had to add a very simple delve configuration in order to be able to use the delve cli for debugging.
The README only gives a very vague hint about "go set up your IDE now ...", which I imagine might work for people who use IDEs and are familiar with what buttons to press and so forth.
In order to improve the experience, I can see the following options:
Add a new subsection to the Debug section for configuring the delve cli to use the correct path substitutions
For IDE users, maybe give some indication of which IDEs are proven to work and are used by the maintainers. But I'd be happy to hear from IDE users what they think about the current documentation for setting up delve for otelcollector (I don't use IDEs)
The debug section in the builder README is a good starting point in that it includes the important initial steps (
debug_compilation
setting + how to use go-delvedlv exec
), but there are mandatory additional step after that to actually meaningfully use delveIt took me much too long to figure out that I had to add a very simple delve configuration in order to be able to use the delve cli for debugging.
The README only gives a very vague hint about "go set up your IDE now ...", which I imagine might work for people who use IDEs and are familiar with what buttons to press and so forth.
In order to improve the experience, I can see the following options: