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

[Meta] Standardize instrumentation docs with sample app #3229

Open
9 of 55 tasks
svrnm opened this issue Sep 6, 2023 · 5 comments
Open
9 of 55 tasks

[Meta] Standardize instrumentation docs with sample app #3229

svrnm opened this issue Sep 6, 2023 · 5 comments
Labels
0-meta enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@svrnm
Copy link
Member

svrnm commented Sep 6, 2023

Since we are very close to have standardized the "Getting Started" docs for all languages (see #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
    • Example app
    • Setup
    • Traces
    • Metrics
    • Logs
  • JavaScript
    • Example app
    • Setup
    • Traces
    • Metrics
    • Logs
  • PHP
    • Example app
    • Setup
    • 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 svrnm added enhancement New feature or request help wanted Extra attention is needed 0-meta labels Sep 6, 2023
@theletterf
Copy link
Member

I'd like to help with this.

@cartermp
Copy link
Contributor

cartermp commented Oct 3, 2023

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

@IAMebonyhope
Copy link
Contributor

I'll love to work on the .NET part

@svrnm
Copy link
Member Author

svrnm commented Jan 19, 2024

@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!

@IAMebonyhope
Copy link
Contributor

@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.

@svrnm svrnm changed the title [Meta] Standardize manual instrumentation docs with sample app [Meta] Standardize instrumentation docs with sample app Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0-meta enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants