[Getting Started] Add reference app specification #6820
Conversation
Signed-off-by: svrnm <sneumann@causely.ai>
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com>
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
Signed-off-by: svrnm <sneumann@causely.ai>
|
Apologies for the delay! I took some time today to incorporate your reviews and expand on the details, please take a look! |
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
Signed-off-by: svrnm <sneumann@causely.ai>
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
| ## General requirements | ||
|
|
||
| - Implementations of the Reference App are owned by language SIGs implementing | ||
| the OpenTelemetry APIs and SDKs. |
There was a problem hiding this comment.
Listed in order of popularity, the most commonly used programming languages among OTel users are:
- JavaScript
- Java
- Go
- Python
Can we prioritize standardizing apps for these languages and consult their respective SIGs?
There was a problem hiding this comment.
nit:
Curious, where ca we get data about Otel language popularity etc.?
Going with just Github stars, Go, DotNet, JS, Java/Rust is the order.
There was a problem hiding this comment.
Hi @cijothomas ! The OTel End User SIG conducted a survey on the language popularity in addition to other helpful insights about the getting-started experience of the OTel users.
There was a problem hiding this comment.
We can prioritize them and make it a goal to have them as early as possible.
But eventually it comes down to the individuals who implement it :-)
content/en/docs/getting-started/reference-application-specification.md
Outdated
Show resolved
Hide resolved
Signed-off-by: svrnm <sneumann@causely.ai>
| - The code of the application must be split into two files: | ||
| - an `app` file that contains the handling of the HTTP requests | ||
| - a `library` file that contains the implementation of the roll dice function. | ||
| The names of those files should be idiomatic within the implementing | ||
| language, like `app.js` and `roll-the-dice.js`. The important point is that | ||
| by separating the two, the code demonstrates that the `library` only takes | ||
| dependency on the API and all the SDK code is initalized in the `app` code. |
There was a problem hiding this comment.
@martincostello @cijothomas is this better, I picked a .js example but if you provide me with what a good naming for .NET is, I can update that accordingly.
| - There should be an option to enable diagnostic logging for the OpenTelemetry | ||
| components, if implemented ideally via `OTEL_LOG_LEVEL`. |
Contributes to the effort to rework our getting started guides