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.
|
I talked to @pellared on Slack, asking whether publishing the code from this PR to the the dice example at the canonical reference would be accepted. It's not very clear to me, given his concerns about the stability of the otelconf package. Before investing more time on this, I'd really need some clarity on whether this code, as is (plus closing the read file), would be accepted there. If it would, I'll gladly send the PR to update that, otherwise I'd prefer to close this here, given the limited time I have for this specific task. |
|
Could we keep the changes, except for the use of otelconf? |
|
|
| Create `otel.yaml` with the following configuration: | ||
|
|
||
| ```yaml | ||
| file_format: '0.3' |
There was a problem hiding this comment.
I believe you should be able to use rc.2 these days: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/Makefile#L326
8 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. ↩