search

open-telemetry / opentelemetry-specification

Specifications for OpenTelemetry
https://opentelemetry.io
Apache License 2.0
3.64k stars 871 forks source link

Documentation for creating a custom Instrumentation class. #3986

Closed sushaanttb closed 2 months ago

sushaanttb commented 2 months ago

I had a use case where I wanted to create my own custom instrumentor class. However, I could not find any reference for same in the documentation. The user in this case is left wondering on the steps for same and it requires a bit of research (for e.g. by having a look at other instrumentation libraries implementation) to understand the process.

For e.g. in case of python, As figured out, it's simply just about extending the BaseInstrumentor class from opentelemetry.instrumentation.instrumentor package and implementing it's abstract methods accordingly.

I think it would be very helpful for users if there could be respective section for same in the documentation.

MrAlias commented 2 months ago

Is this issue meant for the https://github.com/open-telemetry/opentelemetry-python respository?

tedsuo commented 2 months ago

This is not a spec issue, please reopen it in the Python repo.

sushaanttb commented 2 months ago

@MrAlias No, this is a general comment, not specifically w.r.t python SDK (that was meant to share only as a ref.) Updated comment accordingly. Also, the reason I am raising it under Spec is as per the "issue raising guidelines" that if the issues is general and not related to any language then it needs to be raised under spec.

@tedsuo Hope it's ok to reopen now?