docs(go): simplify getting started guide #8987
Conversation
Signed-off-by: Juraci Paixão Kröhling <juraci@kroehling.de>
|
@tedsuo shared a reddit post a few days ago with me (https://www.reddit.com/r/ExperiencedDevs/comments/1ow8c61/opentelemetry_worth_the_effort/ ) and one of the comments linked to the getting started guide for Go, which was overly complex and not representative of what I believe people should be doing. The getting started guide is what I personally do in my projects and how I teach people on my other projects. Before merging, it would be good to have someone from the config sig (@codeboten ?) to review, as well as someone from the Go SIG (@pellared ?) to keep me honest. |
|
That's great, is this also relevant for open-telemetry/opentelemetry-go-contrib#8099 ? |
pellared
left a comment
pellared
left a comment
There was a problem hiding this comment.
Our policy so far was to always update the code in https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/examples/dice and then update the docs here.
| // Set up OpenTelemetry. | ||
| otelShutdown, err := setupOTelSDK(ctx) | ||
| // Set up OpenTelemetry SDK from configuration file. | ||
| cfgBytes, err := os.ReadFile("otel.yaml") |
There was a problem hiding this comment.
I think we are not closing the file. The linter in the OTel repository should catch this.
7 participants
Signed-off-by: Juraci Paixão Kröhling juraci@kroehling.de
Footnotes
Yes, I can answer maintainer questions about the content of this PR, without using AI. ↩