census-instrumentation / opencensus-website

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

advanced-topics/troubleshooting: add section "Diagnosing problems with tracing" #472

Open odeke-em opened 5 years ago

odeke-em commented 5 years ago

Borrowing an idea from the MySQL website "Performance schema quickstart" https://dev.mysql.com/doc/refman/8.0/en/performance-schema-quick-start.html I just saw the value of having a direct advisory of how to use a solution to diagnose and solve problems.

It would be useful for us to make a section titled "Diagnosing problems with tracing" and link to that in the same fashion at the top of the "Tracing" introduction page. This ensures that the practicalities of using tracing will be properly communicated and prescriptive, thereby creating a direct use for the content on the website

/cc @hvent90 @bogdandrutu @rakyll @shahprit

hvent90 commented 5 years ago

Similar sentiments as https://github.com/census-instrumentation/opencensus-website/issues/473#issuecomment-442956969

If someone who has the real-world experience of using [tracing] in a site-reliability capacity is able to afford the time to detail a high-level real-world implementation, then I can go in and write the guide.

Context: I am familiar with the API accross java/go/node/python, however I haven't used it in a real-world scenario -- so my implementation isn't battle tested and would be flawed.

Another scenario is I could just write the section to get it out the door and then a more knowledgable individual polishes it up later.