OpenTelemetry Base Instrumentor
An ABC for instrumentors
Child classes of this ABC should instrument specific third party libraries or frameworks either by using the
opentelemetry-instrumentcommand or by calling their methods directly.
Since every third party library or framework is different and has different instrumentation needs, more methods can be added to the child classes as needed to provide practical instrumentation to the end user.
Instrument the library
This method will be called without any optional arguments by the
opentelemetry-instrumentcommand. The configuration of the instrumentation when done in this way should be done by previously setting the configuration (using environment variables or any other mechanism) that will be used later by the code in the
instrumentimplementation via the global
kwargsshould default to values from the
This means that calling this method directly without passing any optional values should do the very same thing that the
opentelemetry-instrumentcommand does. This approach is followed because the
Configurationobject is immutable.
Uninstrument the library
BaseInstrumentor.instrumentfor more information regarding the usage of