From 7e457d189565cd268b1ad9db683cc1445c7a1aeb Mon Sep 17 00:00:00 2001 From: Connor Adams Date: Wed, 10 Jun 2020 17:00:40 -0400 Subject: [PATCH] Instrumentation for Pyramid (#776) Co-authored-by: Yusuke Tsutsumi --- ext/opentelemetry-ext-pyramid/CHANGELOG.md | 5 + ext/opentelemetry-ext-pyramid/LICENSE | 201 ++++++++++++++++++ ext/opentelemetry-ext-pyramid/MANIFEST.in | 9 + ext/opentelemetry-ext-pyramid/README.rst | 21 ++ ext/opentelemetry-ext-pyramid/setup.cfg | 59 +++++ ext/opentelemetry-ext-pyramid/setup.py | 26 +++ .../src/opentelemetry/ext/pyramid/__init__.py | 141 ++++++++++++ .../opentelemetry/ext/pyramid/callbacks.py | 172 +++++++++++++++ .../src/opentelemetry/ext/pyramid/version.py | 15 ++ .../tests/__init__.py | 0 .../tests/pyramid_base_test.py | 54 +++++ .../tests/test_automatic.py | 79 +++++++ .../tests/test_programmatic.py | 194 +++++++++++++++++ tox.ini | 11 +- 14 files changed, 985 insertions(+), 2 deletions(-) create mode 100644 ext/opentelemetry-ext-pyramid/CHANGELOG.md create mode 100644 ext/opentelemetry-ext-pyramid/LICENSE create mode 100644 ext/opentelemetry-ext-pyramid/MANIFEST.in create mode 100644 ext/opentelemetry-ext-pyramid/README.rst create mode 100644 ext/opentelemetry-ext-pyramid/setup.cfg create mode 100644 ext/opentelemetry-ext-pyramid/setup.py create mode 100644 ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/__init__.py create mode 100644 ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/callbacks.py create mode 100644 ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/version.py create mode 100644 ext/opentelemetry-ext-pyramid/tests/__init__.py create mode 100644 ext/opentelemetry-ext-pyramid/tests/pyramid_base_test.py create mode 100644 ext/opentelemetry-ext-pyramid/tests/test_automatic.py create mode 100644 ext/opentelemetry-ext-pyramid/tests/test_programmatic.py diff --git a/ext/opentelemetry-ext-pyramid/CHANGELOG.md b/ext/opentelemetry-ext-pyramid/CHANGELOG.md new file mode 100644 index 00000000000..33144da9132 --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## Unreleased + +- Initial release \ No newline at end of file diff --git a/ext/opentelemetry-ext-pyramid/LICENSE b/ext/opentelemetry-ext-pyramid/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/ext/opentelemetry-ext-pyramid/MANIFEST.in b/ext/opentelemetry-ext-pyramid/MANIFEST.in new file mode 100644 index 00000000000..aed3e33273b --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/MANIFEST.in @@ -0,0 +1,9 @@ +graft src +graft tests +global-exclude *.pyc +global-exclude *.pyo +global-exclude __pycache__/* +include CHANGELOG.md +include MANIFEST.in +include README.rst +include LICENSE diff --git a/ext/opentelemetry-ext-pyramid/README.rst b/ext/opentelemetry-ext-pyramid/README.rst new file mode 100644 index 00000000000..c7890ad0955 --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/README.rst @@ -0,0 +1,21 @@ +OpenTelemetry Pyramid Integration +================================= + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-pyramid.svg + :target: https://pypi.org/project/opentelemetry-ext-pyramid/ + +Installation +------------ + +:: + + pip install opentelemetry-ext-pyramid + + +References +---------- +* `OpenTelemetry Pyramid Integration `_ +* `OpenTelemetry Project `_ + diff --git a/ext/opentelemetry-ext-pyramid/setup.cfg b/ext/opentelemetry-ext-pyramid/setup.cfg new file mode 100644 index 00000000000..7170bcf5827 --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/setup.cfg @@ -0,0 +1,59 @@ +# 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. +# +[metadata] +name = opentelemetry-ext-pyramid +description = OpenTelemetry Pyramid integration +long_description = file: README.rst +long_description_content_type = text/x-rst +author = OpenTelemetry Authors +author_email = cncf-opentelemetry-contributors@lists.cncf.io +url = https://github.com/open-telemetry/opentelemetry-python/tree/master/ext/opentelemetry-ext-pyramid +platforms = any +license = Apache-2.0 +classifiers = + Development Status :: 4 - Beta + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Programming Language :: Python + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.4 + Programming Language :: Python :: 3.5 + Programming Language :: Python :: 3.6 + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 + +[options] +python_requires = >=3.4 +package_dir= + =src +packages=find_namespace: +install_requires = + pyramid >= 1.7 + opentelemetry-instrumentation == 0.9.dev0 + opentelemetry-api == 0.9.dev0 + opentelemetry-ext-wsgi == 0.9.dev0 + wrapt >= 1.0.0, < 2.0.0 + +[options.extras_require] +test = + werkzeug == 0.16.1 + opentelemetry-test == 0.9.dev0 + +[options.packages.find] +where = src + +[options.entry_points] +opentelemetry_instrumentor = + pyramid = opentelemetry.ext.pyramid:PyramidInstrumentor diff --git a/ext/opentelemetry-ext-pyramid/setup.py b/ext/opentelemetry-ext-pyramid/setup.py new file mode 100644 index 00000000000..175db54ed57 --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/setup.py @@ -0,0 +1,26 @@ +# 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. +import os + +import setuptools + +BASE_DIR = os.path.dirname(__file__) +VERSION_FILENAME = os.path.join( + BASE_DIR, "src", "opentelemetry", "ext", "pyramid", "version.py" +) +PACKAGE_INFO = {} +with open(VERSION_FILENAME) as f: + exec(f.read(), PACKAGE_INFO) + +setuptools.setup(version=PACKAGE_INFO["__version__"]) diff --git a/ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/__init__.py b/ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/__init__.py new file mode 100644 index 00000000000..6f63634bc7a --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/__init__.py @@ -0,0 +1,141 @@ +# 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. + +""" +Pyramid instrumentation supporting `pyramid`_, it can be enabled by +using ``PyramidInstrumentor``. + +.. _pyramid: https://docs.pylonsproject.org/projects/pyramid/en/latest/ + +Usage +----- + There are two methods to instrument Pyramid: + +Method 1 (Instrument all Configurators): +---------------------------------------- +.. code:: python + + from pyramid.config import Configurator + from opentelemetry.ext.pyramid import PyramidInstrumentor + + PyramidInstrumentor.instrument() + + config = Configurator() + + # use your config as normal + config.add_route('index', '/') + +Method 2 (Instrument one Configurator): +--------------------------------------- +.. code:: python + + from pyramid.config import Configurator + from opentelemetry.ext.pyramid import PyramidInstrumentor + + config = Configurator() + PyramidInstrumentor().instrument_config(config) + + # use your config as normal + config.add_route('index', '/') + +Using ``pyramid.tweens`` settings: +---------------------------------- + If you use Method 2 and then set tweens for your application with the ``pyramid.tweens`` setting, + you need to add ``opentelemetry.ext.pyramid.trace_tween_factory`` explicity to the list, + *as well as* instrumenting the config with `PyramidInstrumentor().instrument_config(config)`. + + For example: +.. code:: python + settings = { + 'pyramid.tweens', 'opentelemetry.ext.pyramid.trace_tween_factory\\nyour_tween_no_1\\nyour_tween_no_2', + } + config = Configurator(settings=settings) + PyramidInstrumentor.instrument_config(config) + + # use your config as normal. + config.add_route('index', '/') +--- +""" + +import typing + +from pyramid.config import Configurator +from pyramid.path import caller_package +from pyramid.settings import aslist +from wrapt import ObjectProxy +from wrapt import wrap_function_wrapper as _wrap + +from opentelemetry.ext.pyramid.callbacks import ( + SETTING_TRACE_ENABLED, + TWEEN_NAME, + trace_tween_factory, +) +from opentelemetry.ext.pyramid.version import __version__ +from opentelemetry.instrumentation.instrumentor import BaseInstrumentor +from opentelemetry.instrumentation.utils import unwrap +from opentelemetry.trace import TracerProvider, get_tracer + + +def traced_init(wrapped, instance, args, kwargs): + settings = kwargs.get("settings", {}) + tweens = aslist(settings.get("pyramid.tweens", [])) + + if tweens and TWEEN_NAME not in settings: + # pyramid.tweens.EXCVIEW is the name of built-in exception view provided by + # pyramid. We need our tween to be before it, otherwise unhandled + # exceptions will be caught before they reach our tween. + tweens = [TWEEN_NAME] + tweens + + settings["pyramid.tweens"] = "\n".join(tweens) + + kwargs["settings"] = settings + + # `caller_package` works by walking a fixed amount of frames up the stack + # to find the calling package. So if we let the original `__init__` + # function call it, our wrapper will mess things up. + if not kwargs.get("package", None): + # Get the package for the third frame up from this one. + # Default is `level=2` which will give us the package from `wrapt` + # instead of the desired package (the caller) + kwargs["package"] = caller_package(level=3) + + wrapped(*args, **kwargs) + instance.include("opentelemetry.ext.pyramid.callbacks") + + +class PyramidInstrumentor(BaseInstrumentor): + def _instrument(self, **kwargs): + """Integrate with Pyramid Python library. + https://docs.pylonsproject.org/projects/pyramid/en/latest/ + """ + _wrap("pyramid.config", "Configurator.__init__", traced_init) + + def _uninstrument(self, **kwargs): + """"Disable Pyramid instrumentation""" + unwrap(Configurator, "__init__") + + # pylint:disable=no-self-use + def instrument_config(self, config): + """Enable instrumentation in a Pyramid configurator. + + Args: + config: The Configurator to instrument. + + Returns: + An instrumented Configurator. + """ + config.include("opentelemetry.ext.pyramid.callbacks") + + def uninstrument_config(self, config): + config.add_settings({SETTING_TRACE_ENABLED: False}) diff --git a/ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/callbacks.py b/ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/callbacks.py new file mode 100644 index 00000000000..e19e447beee --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/callbacks.py @@ -0,0 +1,172 @@ +from logging import getLogger + +from pyramid.events import BeforeTraversal +from pyramid.httpexceptions import HTTPException +from pyramid.settings import asbool +from pyramid.tweens import EXCVIEW + +import opentelemetry.ext.wsgi as otel_wsgi +from opentelemetry import configuration, context, propagators, trace +from opentelemetry.ext.pyramid.version import __version__ +from opentelemetry.util import disable_trace, time_ns + +TWEEN_NAME = "opentelemetry.ext.pyramid.trace_tween_factory" +SETTING_TRACE_ENABLED = "opentelemetry-pyramid.trace_enabled" + +_ENVIRON_STARTTIME_KEY = "opentelemetry-pyramid.starttime_key" +_ENVIRON_SPAN_KEY = "opentelemetry-pyramid.span_key" +_ENVIRON_ACTIVATION_KEY = "opentelemetry-pyramid.activation_key" +_ENVIRON_ENABLED_KEY = "opentelemetry-pyramid.tracing_enabled_key" +_ENVIRON_TOKEN = "opentelemetry-pyramid.token" + +_logger = getLogger(__name__) + + +def get_excluded_hosts(): + hosts = configuration.Configuration().PYRAMID_EXCLUDED_HOSTS or [] + if hosts: + hosts = str.split(hosts, ",") + return hosts + + +def get_excluded_paths(): + paths = configuration.Configuration().PYRAMID_EXCLUDED_PATHS or [] + if paths: + paths = str.split(paths, ",") + return paths + + +_excluded_hosts = get_excluded_hosts() +_excluded_paths = get_excluded_paths() + + +def includeme(config): + config.add_settings({SETTING_TRACE_ENABLED: True}) + + config.add_subscriber(_before_traversal, BeforeTraversal) + _insert_tween(config) + + +def _insert_tween(config): + settings = config.get_settings() + tweens = settings.get("pyramid.tweens") + # If the list is empty, pyramid does not consider the tweens have been + # set explicitly. And if our tween is already there, nothing to do + if not tweens or not tweens.strip(): + # Add our tween just before the default exception handler + config.add_tween(TWEEN_NAME, over=EXCVIEW) + + +def _before_traversal(event): + request = event.request + environ = request.environ + span_name = otel_wsgi.get_default_span_name(environ) + + enabled = environ.get(_ENVIRON_ENABLED_KEY) + if enabled is None: + _logger.warning( + "Opentelemetry pyramid tween 'opentelemetry.ext.pyramid.trace_tween_factory'" + "was not called. Make sure that the tween is included in 'pyramid.tweens' if" + "the tween list was created manually" + ) + return + + if not enabled: + # Tracing not enabled, return + return + + start_time = environ.get(_ENVIRON_STARTTIME_KEY) + + token = context.attach( + propagators.extract(otel_wsgi.get_header_from_environ, environ) + ) + tracer = trace.get_tracer(__name__, __version__) + + attributes = otel_wsgi.collect_request_attributes(environ) + + if request.matched_route: + span_name = request.matched_route.pattern + attributes["http.route"] = request.matched_route.pattern + else: + span_name = otel_wsgi.get_default_span_name(environ) + + span = tracer.start_span( + span_name, + kind=trace.SpanKind.SERVER, + attributes=attributes, + start_time=start_time, + ) + + activation = tracer.use_span(span, end_on_exit=True) + activation.__enter__() + environ[_ENVIRON_ACTIVATION_KEY] = activation + environ[_ENVIRON_SPAN_KEY] = span + environ[_ENVIRON_TOKEN] = token + + +def trace_tween_factory(handler, registry): + settings = registry.settings + enabled = asbool(settings.get(SETTING_TRACE_ENABLED, True)) + + if not enabled: + # If disabled, make a tween that signals to the + # BeforeTraversal subscriber that tracing is disabled + def disabled_tween(request): + request.environ[_ENVIRON_ENABLED_KEY] = False + return handler(request) + + return disabled_tween + + # make a request tracing function + def trace_tween(request): + if disable_trace(request.url, _excluded_hosts, _excluded_paths): + request.environ[_ENVIRON_ENABLED_KEY] = False + # short-circuit when we don't want to trace anything + return handler(request) + + request.environ[_ENVIRON_ENABLED_KEY] = True + request.environ[_ENVIRON_STARTTIME_KEY] = time_ns() + + try: + response = handler(request) + response_or_exception = response + except HTTPException as exc: + # If the exception is a pyramid HTTPException, + # that's still valuable information that isn't necessarily + # a 500. For instance, HTTPFound is a 302. + # As described in docs, Pyramid exceptions are all valid + # response types + response_or_exception = exc + raise + finally: + span = request.environ.get(_ENVIRON_SPAN_KEY) + enabled = request.environ.get(_ENVIRON_ENABLED_KEY) + if not span and enabled: + _logger.warning( + "Pyramid environ's OpenTelemetry span missing." + "If the OpenTelemetry tween was added manually, make sure" + "PyramidInstrumentor().instrument_config(config) is called" + ) + elif enabled: + otel_wsgi.add_response_attributes( + span, + response_or_exception.status, + response_or_exception.headers, + ) + + activation = request.environ.get(_ENVIRON_ACTIVATION_KEY) + + if isinstance(response_or_exception, HTTPException): + activation.__exit__( + type(response_or_exception), + response_or_exception, + getattr(response_or_exception, "__traceback__", None), + ) + else: + activation.__exit__(None, None, None) + + context.detach(request.environ.get(_ENVIRON_TOKEN)) + + return response + + return trace_tween diff --git a/ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/version.py b/ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/version.py new file mode 100644 index 00000000000..603bf0b7e5f --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/src/opentelemetry/ext/pyramid/version.py @@ -0,0 +1,15 @@ +# 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. + +__version__ = "0.9.dev0" diff --git a/ext/opentelemetry-ext-pyramid/tests/__init__.py b/ext/opentelemetry-ext-pyramid/tests/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/ext/opentelemetry-ext-pyramid/tests/pyramid_base_test.py b/ext/opentelemetry-ext-pyramid/tests/pyramid_base_test.py new file mode 100644 index 00000000000..21a6a1ab95e --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/tests/pyramid_base_test.py @@ -0,0 +1,54 @@ +# 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. + +import pyramid.httpexceptions as exc +from pyramid.response import Response +from werkzeug.test import Client +from werkzeug.wrappers import BaseResponse + +from opentelemetry.configuration import Configuration + + +class InstrumentationTest: + def setUp(self): # pylint: disable=invalid-name + super().setUp() # pylint: disable=no-member + Configuration._reset() # pylint: disable=protected-access + + @staticmethod + def _hello_endpoint(request): + helloid = int(request.matchdict["helloid"]) + if helloid == 500: + raise exc.HTTPInternalServerError() + return Response("Hello: " + str(helloid)) + + def _common_initialization(self, config): + # pylint: disable=unused-argument + def excluded_endpoint(request): + return Response("excluded") + + # pylint: disable=unused-argument + def excluded2_endpoint(request): + return Response("excluded2") + + config.add_route("hello", "/hello/{helloid}") + config.add_view(self._hello_endpoint, route_name="hello") + config.add_route("excluded_arg", "/excluded/{helloid}") + config.add_view(self._hello_endpoint, route_name="excluded_arg") + config.add_route("excluded", "/excluded_noarg") + config.add_view(excluded_endpoint, route_name="excluded") + config.add_route("excluded2", "/excluded_noarg2") + config.add_view(excluded2_endpoint, route_name="excluded2") + + # pylint: disable=attribute-defined-outside-init + self.client = Client(config.make_wsgi_app(), BaseResponse) diff --git a/ext/opentelemetry-ext-pyramid/tests/test_automatic.py b/ext/opentelemetry-ext-pyramid/tests/test_automatic.py new file mode 100644 index 00000000000..d19da3c2b36 --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/tests/test_automatic.py @@ -0,0 +1,79 @@ +# 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. + +from pyramid.config import Configurator + +from opentelemetry.ext.pyramid import PyramidInstrumentor +from opentelemetry.test.test_base import TestBase +from opentelemetry.test.wsgitestutil import WsgiTestBase + +# pylint: disable=import-error +from .pyramid_base_test import InstrumentationTest + + +class TestAutomatic(InstrumentationTest, TestBase, WsgiTestBase): + def setUp(self): + super().setUp() + + PyramidInstrumentor().instrument() + + self.config = Configurator() + + self._common_initialization(self.config) + + def tearDown(self): + super().tearDown() + with self.disable_logging(): + PyramidInstrumentor().uninstrument() + + def test_uninstrument(self): + # pylint: disable=access-member-before-definition + resp = self.client.get("/hello/123") + self.assertEqual(200, resp.status_code) + self.assertEqual([b"Hello: 123"], list(resp.response)) + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + + PyramidInstrumentor().uninstrument() + self.config = Configurator() + + self._common_initialization(self.config) + + resp = self.client.get("/hello/123") + self.assertEqual(200, resp.status_code) + self.assertEqual([b"Hello: 123"], list(resp.response)) + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + + def test_tween_list(self): + tween_list = "pyramid.tweens.excview_tween_factory" + config = Configurator(settings={"pyramid.tweens": tween_list}) + self._common_initialization(config) + resp = self.client.get("/hello/123") + self.assertEqual(200, resp.status_code) + self.assertEqual([b"Hello: 123"], list(resp.response)) + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + + PyramidInstrumentor().uninstrument() + + self.config = Configurator() + + self._common_initialization(self.config) + + resp = self.client.get("/hello/123") + self.assertEqual(200, resp.status_code) + self.assertEqual([b"Hello: 123"], list(resp.response)) + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) diff --git a/ext/opentelemetry-ext-pyramid/tests/test_programmatic.py b/ext/opentelemetry-ext-pyramid/tests/test_programmatic.py new file mode 100644 index 00000000000..b1ecbb38bb7 --- /dev/null +++ b/ext/opentelemetry-ext-pyramid/tests/test_programmatic.py @@ -0,0 +1,194 @@ +# 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. + +from unittest.mock import patch + +from pyramid.config import Configurator + +from opentelemetry import trace +from opentelemetry.ext.pyramid import PyramidInstrumentor +from opentelemetry.test.test_base import TestBase +from opentelemetry.test.wsgitestutil import WsgiTestBase + +# pylint: disable=import-error +from .pyramid_base_test import InstrumentationTest + + +def expected_attributes(override_attributes): + default_attributes = { + "component": "http", + "http.method": "GET", + "http.server_name": "localhost", + "http.scheme": "http", + "host.port": 80, + "http.host": "localhost", + "http.target": "/", + "http.flavor": "1.1", + "http.status_text": "OK", + "http.status_code": 200, + } + for key, val in override_attributes.items(): + default_attributes[key] = val + return default_attributes + + +class TestProgrammatic(InstrumentationTest, TestBase, WsgiTestBase): + def setUp(self): + super().setUp() + config = Configurator() + PyramidInstrumentor().instrument_config(config) + + self.config = config + + self._common_initialization(self.config) + + def tearDown(self): + super().tearDown() + with self.disable_logging(): + PyramidInstrumentor().uninstrument_config(self.config) + + def test_uninstrument(self): + resp = self.client.get("/hello/123") + self.assertEqual(200, resp.status_code) + self.assertEqual([b"Hello: 123"], list(resp.response)) + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + + PyramidInstrumentor().uninstrument_config(self.config) + # Need to remake the WSGI app export + self._common_initialization(self.config) + + resp = self.client.get("/hello/123") + self.assertEqual(200, resp.status_code) + self.assertEqual([b"Hello: 123"], list(resp.response)) + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + + def test_simple(self): + expected_attrs = expected_attributes( + {"http.target": "/hello/123", "http.route": "/hello/{helloid}"} + ) + self.client.get("/hello/123") + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + self.assertEqual(span_list[0].name, "/hello/{helloid}") + self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER) + self.assertEqual(span_list[0].attributes, expected_attrs) + + def test_404(self): + expected_attrs = expected_attributes( + { + "http.method": "POST", + "http.target": "/bye", + "http.status_text": "Not Found", + "http.status_code": 404, + } + ) + + resp = self.client.post("/bye") + self.assertEqual(404, resp.status_code) + resp.close() + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + self.assertEqual(span_list[0].name, "/bye") + self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER) + self.assertEqual(span_list[0].attributes, expected_attrs) + + def test_internal_error(self): + expected_attrs = expected_attributes( + { + "http.target": "/hello/500", + "http.route": "/hello/{helloid}", + "http.status_text": "Internal Server Error", + "http.status_code": 500, + } + ) + resp = self.client.get("/hello/500") + self.assertEqual(500, resp.status_code) + resp.close() + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + self.assertEqual(span_list[0].name, "/hello/{helloid}") + self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER) + self.assertEqual(span_list[0].attributes, expected_attrs) + + def test_tween_list(self): + tween_list = "opentelemetry.ext.pyramid.trace_tween_factory\npyramid.tweens.excview_tween_factory" + config = Configurator(settings={"pyramid.tweens": tween_list}) + PyramidInstrumentor().instrument_config(config) + self._common_initialization(config) + + resp = self.client.get("/hello/123") + self.assertEqual(200, resp.status_code) + self.assertEqual([b"Hello: 123"], list(resp.response)) + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + + PyramidInstrumentor().uninstrument_config(config) + # Need to remake the WSGI app export + self._common_initialization(config) + + resp = self.client.get("/hello/123") + self.assertEqual(200, resp.status_code) + self.assertEqual([b"Hello: 123"], list(resp.response)) + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + + @patch("opentelemetry.ext.pyramid.callbacks._logger") + def test_warnings(self, mock_logger): + tween_list = "pyramid.tweens.excview_tween_factory" + config = Configurator(settings={"pyramid.tweens": tween_list}) + PyramidInstrumentor().instrument_config(config) + self._common_initialization(config) + + self.client.get("/hello/123") + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 0) + self.assertEqual(mock_logger.warning.called, True) + + mock_logger.warning.called = False + + tween_list = "opentelemetry.ext.pyramid.trace_tween_factory" + config = Configurator(settings={"pyramid.tweens": tween_list}) + self._common_initialization(config) + + self.client.get("/hello/123") + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 0) + self.assertEqual(mock_logger.warning.called, True) + + @patch( + "opentelemetry.ext.pyramid.callbacks._excluded_hosts", + ["http://localhost/excluded_arg/123"], + ) + @patch( + "opentelemetry.ext.pyramid.callbacks._excluded_paths", + ["excluded_noarg"], + ) + def test_exclude_lists(self): + self.client.get("/excluded_arg/123") + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 0) + + self.client.get("/excluded_arg/125") + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + + self.client.get("/excluded_noarg") + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) + + self.client.get("/excluded_noarg2") + span_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(span_list), 1) diff --git a/tox.ini b/tox.ini index de7fe82ca17..2d05a98288d 100644 --- a/tox.ini +++ b/tox.ini @@ -91,6 +91,10 @@ envlist = py3{4,5,6,7,8}-test-ext-pymysql pypy3-test-ext-pymysql + ; opentelemetry-ext-pyramid + py3{4,5,6,7,8}-test-ext-pyramid + pypy3-test-ext-pyramid + ; opentelemetry-ext-asgi py3{5,6,7,8}-test-ext-asgi pypy3-test-ext-asgi @@ -171,6 +175,7 @@ changedir = test-exporter-cloud-trace: ext/opentelemetry-exporter-cloud-trace/tests test-ext-psycopg2: ext/opentelemetry-ext-psycopg2/tests test-ext-pymysql: ext/opentelemetry-ext-pymysql/tests + test-ext-pyramid: ext/opentelemetry-ext-pyramid/tests test-ext-asgi: ext/opentelemetry-ext-asgi/tests test-ext-sqlite3: ext/opentelemetry-ext-sqlite3/tests test-ext-wsgi: ext/opentelemetry-ext-wsgi/tests @@ -201,8 +206,8 @@ commands_pre = grpc: pip install {toxinidir}/ext/opentelemetry-ext-grpc[test] - wsgi,flask,django,asgi: pip install {toxinidir}/tests/util - wsgi,flask,django: pip install {toxinidir}/ext/opentelemetry-ext-wsgi + wsgi,flask,django,asgi,pyramid: pip install {toxinidir}/tests/util + wsgi,flask,django,pyramid: pip install {toxinidir}/ext/opentelemetry-ext-wsgi asgi: pip install {toxinidir}/ext/opentelemetry-ext-asgi @@ -229,6 +234,8 @@ commands_pre = pymysql: pip install {toxinidir}/ext/opentelemetry-ext-dbapi {toxinidir}/ext/opentelemetry-ext-pymysql[test] + pyramid: pip install {toxinidir}/ext/opentelemetry-ext-pyramid[test] + sqlite3: pip install {toxinidir}/ext/opentelemetry-ext-dbapi {toxinidir}/ext/opentelemetry-ext-sqlite3[test] redis: pip install {toxinidir}/ext/opentelemetry-ext-redis[test]