# Copyright The OpenTelemetry Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# type: ignore
"""
OpenTelemetry Base Instrumentor
"""
from abc import ABC, abstractmethod
from logging import getLogger
_LOG = getLogger(__name__)
[docs]class BaseInstrumentor(ABC):
"""An ABC for instrumentors"""
_instance = None
_is_instrumented = False
def __new__(cls):
if cls._instance is None:
cls._instance = object.__new__(cls)
return cls._instance
@abstractmethod
def _instrument(self, **kwargs):
"""Instrument"""
@abstractmethod
def _uninstrument(self, **kwargs):
"""Uninstrument"""
[docs] def instrument(self, **kwargs):
"""Instrument"""
if not self._is_instrumented:
result = self._instrument(**kwargs)
self._is_instrumented = True
return result
_LOG.warning("Attempting to instrument while already instrumented")
return None
[docs] def uninstrument(self, **kwargs):
"""Uninstrument"""
if self._is_instrumented:
result = self._uninstrument(**kwargs)
self._is_instrumented = False
return result
_LOG.warning("Attempting to uninstrument while already uninstrumented")
return None
__all__ = ["BaseInstrumentor"]