opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard
verified publisher icon open-telemetry

[Meta] Standardize instrumentation docs with sample app

Open svrnm opened this issue 2 years ago • 5 comments

Since we are very close to have standardized the "Getting Started" docs for all languages (see https://github.com/open-telemetry/opentelemetry.io/issues/2623), we can do the same now for other pages as well. Code-based Instrumentation is the next important one, so I create a ticket similar to #2623.

Each page should have a structure like the following:

  • Introduction (standardized already)
  • Advanced "roll the dice" example app
  • Setup (language specific, load dependencies, etc.), initialize the SDK
  • Traces
  • Metrics
  • Logs

Note

To implement this for a new language, please take a documentation from an existing language (https://opentelemetry.io/docs/instrumentation/js/manual/, https://opentelemetry.io/docs/instrumentation/java/manual/) and adjust it for the language you picked

Also, it is not necessary do solve all points in one PR, doing Example App + Setup + Traces first is a good point to get started.

Tracking:

  • C++
    • [ ] Example app
    • [ ] Setup
    • [ ] Traces
    • [ ] Metrics
    • [ ] Logs
  • .NET
    • [ ] Example app
    • [ ] Setup
    • [ ] Traces
    • [ ] Metrics
    • [ ] Logs
  • Erlang/Elixir
    • [ ] Example app
    • [ ] Setup
    • [ ] Traces
    • [ ] Metrics
    • [ ] Logs
  • Go
    • [ ] Example app
    • [ ] Setup
    • [ ] Traces
    • [ ] Metrics
    • [ ] Logs
  • Java
    • [x] Example app
    • [x] Setup
    • [x] Traces
    • [ ] Metrics
    • [ ] Logs
  • JavaScript
    • [x] Example app
    • [x] Setup
    • [x] Traces
    • [ ] Metrics
    • [ ] Logs
  • PHP
    • [x] Example app
    • [x] Setup
    • [x] Traces
    • [ ] Metrics
    • [ ] Logs
  • Python
    • [ ] Example app
    • [ ] Setup
    • [ ] Traces
    • [ ] Metrics
    • [ ] Logs
  • Ruby
    • [ ] Example app
    • [ ] Setup
    • [ ] Traces
    • [ ] Metrics
    • [ ] Logs
  • Rust
    • [ ] Example app
    • [ ] Setup
    • [ ] Traces
    • [ ] Metrics
    • [ ] Logs
  • Swift
    • [ ] Example app
    • [ ] Setup
    • [ ] Traces
    • [ ] Metrics
    • [ ] Logs

svrnm avatar Sep 06 '23 10:09 svrnm

I'd like to help with this.

theletterf avatar Oct 02 '23 13:10 theletterf

great! Feel free to just pick one and send a PR; I don't think we have any preferred ordering 🙂

cartermp avatar Oct 03 '23 16:10 cartermp

I'll love to work on the .NET part

IAMebonyhope avatar Jan 19 '24 07:01 IAMebonyhope

@IAMebonyhope that's great to hear! To get started I recommend that you take one of the existing docs (java, JavaScript) and use them as a blueprint to create the same part for .NET (example app, setup, traces). Our goal is to provide a consistent and standardized documentation, so you can copy the outline and the words and fill in the .NET code and fix the wording where necessary. Don't hesitate to provide a draft PR early to get our feedback! Thank you!

svrnm avatar Jan 19 '24 07:01 svrnm

@svrnm here is a draft PR #3834 The example app and manual instrumentation setup sections are ready for review. I am still working on the traces section.

IAMebonyhope avatar Jan 20 '24 10:01 IAMebonyhope