[docs] New quickstart page #2895
Conversation
cartermp
requested review from
jmacd,
MrAlias,
Aneurysm9,
evantorrie,
XSAM,
dashpole,
MadVikingGod,
pellared and
hanyuancheung
as code owners
|
Added a couple of comments just to help clarify the narrative a bit more. Coming from the viewpoint of OTel noob who is desperately searching for a step-by-step example. I did try out all 3 scenarios myself. Pretty solid overall! |
hanyuancheung
added
Skip Changelog
There was a problem hiding this comment.
I like the update to the guide and the effort to standardise across instrumentation. Thanks @cartermp for the effort on this. I have some comments inline.
One other thing. I wonder is it worth keeping the example in the current quick start guide somewhere for reference? There is good content in it also.
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Co-authored-by: Chester Cheung <cheung.zhy.csu@gmail.com>
There was a problem hiding this comment.
Nice updates, thanks @cartermp.
For me 2 comments still open:
|
@hickeyma Yep! Will be addressing this soon. Still recovering from jetlag 🙂 |
|
Hey folks! Added a couple of little nitpicky comments, but I also ran through this whole thing stem to stern and it works on my machine ™️. Could we get this merged in so it can be brought into the page? |
| exporter, err := | ||
| otlptracehttp.New(ctx, | ||
| // WithInsecure lets us use http instead of https. | ||
| // This is just for local development. | ||
| otlptracehttp.WithInsecure(), | ||
| otlptracehttp.WithEndpoint(collectorAddr), | ||
| ) |
There was a problem hiding this comment.
This snippet makes a number of changes to things outside of just what is shown here. Mainly there is now a context that is part of the initialization func.
This makes this block not copy and pasteable like previous ones. I am ok with that but the supporting text probably should warn someone of this pitfall.
There was a problem hiding this comment.
Yeah, I originally didn't include it but got feedback to have this snippet in here before the full sample that should be copy/paste-able. I'm fine with either approach.
|
Sorry that this has fallen through the cracks. If I get time at the end of the day I will try and merge the last touches and just open an issue to resolve anything outstanding. |
Co-authored-by: Aaron Clawson <3766680+MadVikingGod@users.noreply.github.com>
Co-authored-by: Aaron Clawson <3766680+MadVikingGod@users.noreply.github.com>
There was a problem hiding this comment.
Similar to the existing documentation, can you please add a working and complete example of code being constructed here as compilable code in the examples directory?
This helps users by having a working example and it will help in review of these docs. There are many idiomatic Go issues with the code highlighted here that would be easier to point out if the example existed.
So, this is, uhh, a big change. I chatted with @austinlparker who wrote this article first, and he said we should rewrite it. So that's what this is!
Background: there's an effort in docs to standardize on how we do "get started" across the languages. In broad strokes:
The otel-go getting started page is next up in this set of changes.
The approach I took here is sort of verbose - adding to the same bit of code a few times and showing the full sample in each relevant section. I think there's a benefit to that, in that at any given stage you have a fully working sample you can copy-paste into a file and run. But it does make the doc and changes larger. I am happy to consider alternatives.
@chalin, @svrnm, @austinlparker, @avillela -- would be good to get your eyes here as well. I validated that this works with no broken links in a local build of the website with these changes.