census-instrumentation / opencensus-website

opencensus.io website content
https://opencensus.io
Apache License 2.0
42 stars 155 forks source link

content/*: switch tutorial exporters to use open source and free exporters #343

Open bogdandrutu opened 6 years ago

bogdandrutu commented 6 years ago

Someone sent me the feedback that our QuickStart sections are too GCP centric:

https://opencensus.io/quickstart/java/metrics/ - look at the big "requirements" section.

odeke-em commented 6 years ago

Thank you for the report @bogdandrutu!

We used Stackdriver because it has both Tracing and Metrics. We happened to be in a crunch: 2 weeks before Cloud Next 2018 which was an important event for OpenCensus so it was easier.

However, great point, we should be using open source exporters that don't require accounts but also to avoid giving the false impression that this is a Google-centric project.

For the choice of open source exporters, I suggest these

Exporter Go Java Python Node.js
Prometheus(Stats) X X X
Zipkin(Tracing) X X X X

To also give credit, @rakyll @saturnism had all suggested this switch too. We've just been too swamped to have the time to do it. Tonight I've got some time and will spend it on this. Thanks y'all.

odeke-em commented 6 years ago

I've mailed https://github.com/census-instrumentation/opencensus-website/pull/344 which is the seed for other languages to use after that Go update.

odeke-em commented 6 years ago

And the Java quickstarts too have been converted to use open source exporters https://github.com/census-instrumentation/opencensus-website/pull/347

odeke-em commented 6 years ago

Turns out this issue had already been filed in August https://github.com/census-instrumentation/opencensus-website/issues/218 but I'll close the old one since this issue is being focused on more.

EEmery commented 6 years ago

OpenCensus Node's exporters have independent READMEs with simple guides trying to explain the usage. Still, I don't think that's enough. I'll try to create some quickstarts and add them to the website as soon as possible :smile:

odeke-em commented 6 years ago

OpenCensus Node's exporters have independent READMEs with simple guides trying to explain the usage. Still, I don't think that's enough.

Please feel free to copy those guides over as PRs to the website: Prometheus and Zipkin, these are all that are needed. The problem we have is that many of those guides are written in Typescript and some of us aren't domain experts so end up being blocked. Thus it is great to hear that you'll work on them :) Thank you!