Opentelemetry-java: Provide usage examples

Created on 10 Dec 2019  路  4Comments  路  Source: open-telemetry/opentelemetry-java

We should add samples for using OpenTelemetry Java to make it easier for beginners to get a feeling of how to use the API properly.
OpenCensus had examples included right in the repo and so do OTel Python, JS, Go and .NET.

Most helpful comment

I can take care of it!

All 4 comments

I can take care of it!

Should we make the examples a subproject which breaks the build if the API is changed without updating the examples accordingly?

Having the examples as standalone projects which reference OTel via Maven makes more sense for users looking at them but this way they're more likely to get outdated if no one cares to update them regularly.

Should we make the examples a subproject which breaks the build if the API is changed without updating the examples accordingly?

I personally like this, as otherwise it would be very easy to forget about them ;)

I think we have the first set of examples, we should file more granular issues if we need more examples.

Was this page helpful?
0 / 5 - 0 ratings