Open
Description
Prerequisites
- I have written a descriptive issue title
- I have searched existing issues to ensure the issue has not already been raised
Issue
otel is pretty impenetrable in many ways, and figuring out how to simply get started is quite a journey. I had a couple of ideas that would really improve the onboard ramp of this module that I would be willing to contribute if maintainers are interested in landing:
- An expanded example: a folder with a full basic example of a simple, but realistic fastify configuration (app.js/ts, otel.js) and a start script loaded correctly using the --require/--import flags from the fastify or node cli
- Separated out code blocks to clarify the README examples are in separate files.
- Clarify what a
.setTracerProvider(provider)is and how to get access to that. - Clarify what this instrumentation is actually doing under the hood and clarify any redundancies between it and what one might already have in their otel.js file
- Clarify any requirements or optional components regarding tracing spans and metrics (for example, if you just want metrics do you need to do anything special)
Open to other ideas, but these were all the questions I personally ran into when looking into using this and I think it would be helpful to upstream some improvements here if there is interest.