Skip to content
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

Go: Roll the dice #3310

Merged
merged 17 commits into from
Sep 26, 2023
Merged

Go: Roll the dice #3310

merged 17 commits into from
Sep 26, 2023

Conversation

pellared
Copy link
Member

@pellared pellared commented Sep 25, 2023

@pellared pellared marked this pull request as ready for review September 25, 2023 10:57
@pellared pellared requested review from a team September 25, 2023 10:57
@cartermp

This comment was marked as resolved.

@pellared
Copy link
Member Author

@pellared should this go in after the Go PR is merged, or can we consider this orthogonally?

@cartermp, please consider this orthogonally

  1. I will make further PR(s) if there would be any changes done in Add dice example opentelemetry-go#4539. I did the same for manual metrics docs Go: Refine Initialize Metrics #3305
  2. I plan to improve other Go docs pages. I want to have this one merged first to reduce the number of open PRs. I prefer going baby steps.

Copy link
Contributor

@cartermp cartermp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks great. I think it'd be helpful to have an ending section called Next Steps, like the python docs here: https://deploy-preview-3310--opentelemetry.netlify.app/docs/instrumentation/python/getting-started/#next-steps

Doesn't have to be copied verbatim -- I think mainly we should link to the manual instrumentation page and the exporters page.

content/en/docs/instrumentation/go/getting-started.md Outdated Show resolved Hide resolved
Comment on lines 10 to 11
You will learn how you can instrument a simple application automatically, in
such a way that [traces][] and [metrics][] are emitted to the console.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You will learn how you can instrument a simple application automatically, in
such a way that [traces][] and [metrics][] are emitted to the console.
You will learn how you can instrument a simple application using
instrumentation libraries and custom instrumentation with
OpenTelemetry APIs. You'll create [traces][] and [metrics][] and emit
them to the console.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bigger suggestion here -- since we're not using the go autoinstrumentation agent (maybe that comes in the future!) I think it's worth rephrasing here to emphasize libraries and custom instrumentation with APIs.

Copy link
Member Author

@pellared pellared Sep 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I also mention the SDK? Isn't the term "OpenTelemetry APIs confusing, because there is also OpenTelemetry API which is used for custom instrumentation?

I will simply change to

Suggested change
You will learn how you can instrument a simple application automatically, in
such a way that [traces][] and [metrics][] are emitted to the console.
You will learn how you can instrument a simple application manually, in
such a way that [traces][] and [metrics][] are emitted to the console.

But I am open for further suggestions.

PS. I have created #3308 before this PR and I have forgotten to remove "automatically" 🤦

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pellared
Copy link
Member Author

Overall this looks great. I think it'd be helpful to have an ending section called Next Steps, like the python docs here: https://deploy-preview-3310--opentelemetry.netlify.app/docs/instrumentation/python/getting-started/#next-steps

Fine. I will add it. See 4c82660 🤣

@pellared pellared requested a review from cartermp September 25, 2023 21:41
Copy link
Contributor

@dashpole dashpole left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm overall

content/en/docs/instrumentation/go/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/go/getting-started.md Outdated Show resolved Hide resolved
@pellared
Copy link
Member Author

@cartermp I think it is good to merge.

@svrnm svrnm merged commit 935f42c into open-telemetry:main Sep 26, 2023
@pellared pellared deleted the go-dice branch September 26, 2023 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants