|
| 1 | +# Copyright The OpenTelemetry Authors |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +from logging import getLogger |
| 16 | +from os import environ |
| 17 | + |
| 18 | +from pkg_resources import iter_entry_points |
| 19 | + |
| 20 | +from opentelemetry.instrumentation.dependencies import ( |
| 21 | + get_dist_dependency_conflicts, |
| 22 | +) |
| 23 | +from opentelemetry.instrumentation.distro import BaseDistro, DefaultDistro |
| 24 | +from opentelemetry.instrumentation.environment_variables import ( |
| 25 | + OTEL_PYTHON_CONFIGURATOR, |
| 26 | + OTEL_PYTHON_DISABLED_INSTRUMENTATIONS, |
| 27 | + OTEL_PYTHON_DISTRO, |
| 28 | +) |
| 29 | +from opentelemetry.instrumentation.version import __version__ |
| 30 | + |
| 31 | +_logger = getLogger(__name__) |
| 32 | + |
| 33 | + |
| 34 | +def _load_distro() -> BaseDistro: |
| 35 | + distro_name = environ.get(OTEL_PYTHON_DISTRO, None) |
| 36 | + for entry_point in iter_entry_points("opentelemetry_distro"): |
| 37 | + try: |
| 38 | + # If no distro is specified, use first to come up. |
| 39 | + if distro_name is None or distro_name == entry_point.name: |
| 40 | + distro = entry_point.load()() |
| 41 | + if not isinstance(distro, BaseDistro): |
| 42 | + _logger.debug( |
| 43 | + "%s is not an OpenTelemetry Distro. Skipping", |
| 44 | + entry_point.name, |
| 45 | + ) |
| 46 | + continue |
| 47 | + _logger.debug( |
| 48 | + "Distribution %s will be configured", entry_point.name |
| 49 | + ) |
| 50 | + return distro |
| 51 | + except Exception as exc: # pylint: disable=broad-except |
| 52 | + _logger.exception( |
| 53 | + "Distribution %s configuration failed", entry_point.name |
| 54 | + ) |
| 55 | + raise exc |
| 56 | + return DefaultDistro() |
| 57 | + |
| 58 | + |
| 59 | +def _load_instrumentors(distro): |
| 60 | + package_to_exclude = environ.get(OTEL_PYTHON_DISABLED_INSTRUMENTATIONS, []) |
| 61 | + if isinstance(package_to_exclude, str): |
| 62 | + package_to_exclude = package_to_exclude.split(",") |
| 63 | + # to handle users entering "requests , flask" or "requests, flask" with spaces |
| 64 | + package_to_exclude = [x.strip() for x in package_to_exclude] |
| 65 | + |
| 66 | + for entry_point in iter_entry_points("opentelemetry_pre_instrument"): |
| 67 | + entry_point.load()() |
| 68 | + |
| 69 | + for entry_point in iter_entry_points("opentelemetry_instrumentor"): |
| 70 | + if entry_point.name in package_to_exclude: |
| 71 | + _logger.debug( |
| 72 | + "Instrumentation skipped for library %s", entry_point.name |
| 73 | + ) |
| 74 | + continue |
| 75 | + |
| 76 | + try: |
| 77 | + conflict = get_dist_dependency_conflicts(entry_point.dist) |
| 78 | + if conflict: |
| 79 | + _logger.debug( |
| 80 | + "Skipping instrumentation %s: %s", |
| 81 | + entry_point.name, |
| 82 | + conflict, |
| 83 | + ) |
| 84 | + continue |
| 85 | + |
| 86 | + # tell instrumentation to not run dep checks again as we already did it above |
| 87 | + distro.load_instrumentor(entry_point, skip_dep_check=True) |
| 88 | + _logger.debug("Instrumented %s", entry_point.name) |
| 89 | + except Exception as exc: # pylint: disable=broad-except |
| 90 | + _logger.exception("Instrumenting of %s failed", entry_point.name) |
| 91 | + raise exc |
| 92 | + |
| 93 | + for entry_point in iter_entry_points("opentelemetry_post_instrument"): |
| 94 | + entry_point.load()() |
| 95 | + |
| 96 | + |
| 97 | +def _load_configurators(): |
| 98 | + configurator_name = environ.get(OTEL_PYTHON_CONFIGURATOR, None) |
| 99 | + configured = None |
| 100 | + for entry_point in iter_entry_points("opentelemetry_configurator"): |
| 101 | + if configured is not None: |
| 102 | + _logger.warning( |
| 103 | + "Configuration of %s not loaded, %s already loaded", |
| 104 | + entry_point.name, |
| 105 | + configured, |
| 106 | + ) |
| 107 | + continue |
| 108 | + try: |
| 109 | + if ( |
| 110 | + configurator_name is None |
| 111 | + or configurator_name == entry_point.name |
| 112 | + ): |
| 113 | + entry_point.load()().configure(auto_instrumentation_version=__version__) # type: ignore |
| 114 | + configured = entry_point.name |
| 115 | + else: |
| 116 | + _logger.warning( |
| 117 | + "Configuration of %s not loaded because %s is set by %s", |
| 118 | + entry_point.name, |
| 119 | + configurator_name, |
| 120 | + OTEL_PYTHON_CONFIGURATOR, |
| 121 | + ) |
| 122 | + except Exception as exc: # pylint: disable=broad-except |
| 123 | + _logger.exception("Configuration of %s failed", entry_point.name) |
| 124 | + raise exc |
0 commit comments