diff --git a/eachdist.ini b/eachdist.ini index b573b838fdf..b123230b581 100644 --- a/eachdist.ini +++ b/eachdist.ini @@ -5,6 +5,7 @@ sortfirst= opentelemetry-api opentelemetry-sdk opentelemetry-auto-instrumentation + ext/opentelemetry-ext-utils ext/opentelemetry-ext-wsgi ext/opentelemetry-ext-dbapi ext/* diff --git a/ext/opentelemetry-ext-aiohttp-client/setup.cfg b/ext/opentelemetry-ext-aiohttp-client/setup.cfg index 80d53a1f89b..614c2bbfc8d 100644 --- a/ext/opentelemetry-ext-aiohttp-client/setup.cfg +++ b/ext/opentelemetry-ext-aiohttp-client/setup.cfg @@ -40,6 +40,7 @@ package_dir= packages=find_namespace: install_requires = opentelemetry-api >= 0.8.dev0 + opentelemetry-ext-utils == 0.8.dev0 aiohttp ~= 3.0 [options.packages.find] diff --git a/ext/opentelemetry-ext-aiohttp-client/src/opentelemetry/ext/aiohttp_client/__init__.py b/ext/opentelemetry-ext-aiohttp-client/src/opentelemetry/ext/aiohttp_client/__init__.py index 77dadbd6453..182216cac2b 100644 --- a/ext/opentelemetry-ext-aiohttp-client/src/opentelemetry/ext/aiohttp_client/__init__.py +++ b/ext/opentelemetry-ext-aiohttp-client/src/opentelemetry/ext/aiohttp_client/__init__.py @@ -52,38 +52,11 @@ def strip_query_params(url: yarl.URL) -> str: from opentelemetry import context as context_api from opentelemetry import propagators, trace from opentelemetry.ext.aiohttp_client.version import __version__ +from opentelemetry.ext.utils import http_status_to_canonical_code from opentelemetry.trace import SpanKind from opentelemetry.trace.status import Status, StatusCanonicalCode -# TODO: refactor this code to some common utility -def http_status_to_canonical_code(status: int) -> StatusCanonicalCode: - # pylint:disable=too-many-branches,too-many-return-statements - if status < 100: - return StatusCanonicalCode.UNKNOWN - if status <= 399: - return StatusCanonicalCode.OK - if status <= 499: - if status == 401: # HTTPStatus.UNAUTHORIZED: - return StatusCanonicalCode.UNAUTHENTICATED - if status == 403: # HTTPStatus.FORBIDDEN: - return StatusCanonicalCode.PERMISSION_DENIED - if status == 404: # HTTPStatus.NOT_FOUND: - return StatusCanonicalCode.NOT_FOUND - if status == 429: # HTTPStatus.TOO_MANY_REQUESTS: - return StatusCanonicalCode.RESOURCE_EXHAUSTED - return StatusCanonicalCode.INVALID_ARGUMENT - if status <= 599: - if status == 501: # HTTPStatus.NOT_IMPLEMENTED: - return StatusCanonicalCode.UNIMPLEMENTED - if status == 503: # HTTPStatus.SERVICE_UNAVAILABLE: - return StatusCanonicalCode.UNAVAILABLE - if status == 504: # HTTPStatus.GATEWAY_TIMEOUT: - return StatusCanonicalCode.DEADLINE_EXCEEDED - return StatusCanonicalCode.INTERNAL - return StatusCanonicalCode.UNKNOWN - - def url_path_span_name(params: aiohttp.TraceRequestStartParams) -> str: """Extract a span name from the request URL path. diff --git a/ext/opentelemetry-ext-aiohttp-client/tests/test_aiohttp_client_integration.py b/ext/opentelemetry-ext-aiohttp-client/tests/test_aiohttp_client_integration.py index 8cf5048e588..8db20c227ec 100644 --- a/ext/opentelemetry-ext-aiohttp-client/tests/test_aiohttp_client_integration.py +++ b/ext/opentelemetry-ext-aiohttp-client/tests/test_aiohttp_client_integration.py @@ -98,43 +98,6 @@ async def default_handler(request): loop = asyncio.get_event_loop() return loop.run_until_complete(do_request()) - def test_http_status_to_canonical_code(self): - for status_code, expected in ( - (HTTPStatus.OK, StatusCanonicalCode.OK), - (HTTPStatus.ACCEPTED, StatusCanonicalCode.OK), - (HTTPStatus.IM_USED, StatusCanonicalCode.OK), - (HTTPStatus.MULTIPLE_CHOICES, StatusCanonicalCode.OK), - (HTTPStatus.BAD_REQUEST, StatusCanonicalCode.INVALID_ARGUMENT), - (HTTPStatus.UNAUTHORIZED, StatusCanonicalCode.UNAUTHENTICATED), - (HTTPStatus.FORBIDDEN, StatusCanonicalCode.PERMISSION_DENIED), - (HTTPStatus.NOT_FOUND, StatusCanonicalCode.NOT_FOUND), - ( - HTTPStatus.UNPROCESSABLE_ENTITY, - StatusCanonicalCode.INVALID_ARGUMENT, - ), - ( - HTTPStatus.TOO_MANY_REQUESTS, - StatusCanonicalCode.RESOURCE_EXHAUSTED, - ), - (HTTPStatus.NOT_IMPLEMENTED, StatusCanonicalCode.UNIMPLEMENTED), - (HTTPStatus.SERVICE_UNAVAILABLE, StatusCanonicalCode.UNAVAILABLE), - ( - HTTPStatus.GATEWAY_TIMEOUT, - StatusCanonicalCode.DEADLINE_EXCEEDED, - ), - ( - HTTPStatus.HTTP_VERSION_NOT_SUPPORTED, - StatusCanonicalCode.INTERNAL, - ), - (600, StatusCanonicalCode.UNKNOWN), - (99, StatusCanonicalCode.UNKNOWN), - ): - with self.subTest(status_code=status_code): - actual = opentelemetry.ext.aiohttp_client.http_status_to_canonical_code( - int(status_code) - ) - self.assertEqual(actual, expected, status_code) - def test_status_codes(self): for status_code, span_status in ( (HTTPStatus.OK, StatusCanonicalCode.OK), diff --git a/ext/opentelemetry-ext-dbapi/setup.cfg b/ext/opentelemetry-ext-dbapi/setup.cfg index e7ae7aa502e..3f1d90dabb9 100644 --- a/ext/opentelemetry-ext-dbapi/setup.cfg +++ b/ext/opentelemetry-ext-dbapi/setup.cfg @@ -41,6 +41,7 @@ package_dir= packages=find_namespace: install_requires = opentelemetry-api == 0.8.dev0 + opentelemetry-ext-utils == 0.8.dev0 wrapt >= 1.0.0, < 2.0.0 [options.extras_require] diff --git a/ext/opentelemetry-ext-dbapi/src/opentelemetry/ext/dbapi/__init__.py b/ext/opentelemetry-ext-dbapi/src/opentelemetry/ext/dbapi/__init__.py index a5fda62dea0..a27f63d274f 100644 --- a/ext/opentelemetry-ext-dbapi/src/opentelemetry/ext/dbapi/__init__.py +++ b/ext/opentelemetry-ext-dbapi/src/opentelemetry/ext/dbapi/__init__.py @@ -47,6 +47,7 @@ import wrapt from opentelemetry.ext.dbapi.version import __version__ +from opentelemetry.ext.utils import unwrap from opentelemetry.trace import SpanKind, Tracer, TracerProvider, get_tracer from opentelemetry.trace.status import Status, StatusCanonicalCode @@ -141,9 +142,7 @@ def unwrap_connect( connect_module: Module name where the connect method is available. connect_method_name: The connect method name. """ - conn = getattr(connect_module, connect_method_name, None) - if isinstance(conn, wrapt.ObjectProxy): - setattr(connect_module, connect_method_name, conn.__wrapped__) + unwrap(connect_module, connect_method_name) def instrument_connection( diff --git a/ext/opentelemetry-ext-jinja2/setup.cfg b/ext/opentelemetry-ext-jinja2/setup.cfg index f592870cfe6..85c93f1b35e 100644 --- a/ext/opentelemetry-ext-jinja2/setup.cfg +++ b/ext/opentelemetry-ext-jinja2/setup.cfg @@ -41,6 +41,7 @@ packages=find_namespace: install_requires = opentelemetry-api == 0.8.dev0 opentelemetry-auto-instrumentation == 0.8.dev0 + opentelemetry-ext-utils == 0.8.dev0 jinja2~=2.7 wrapt >= 1.0.0, < 2.0.0 diff --git a/ext/opentelemetry-ext-jinja2/src/opentelemetry/ext/jinja2/__init__.py b/ext/opentelemetry-ext-jinja2/src/opentelemetry/ext/jinja2/__init__.py index 4aabb832ba2..f28f40153b5 100644 --- a/ext/opentelemetry-ext-jinja2/src/opentelemetry/ext/jinja2/__init__.py +++ b/ext/opentelemetry-ext-jinja2/src/opentelemetry/ext/jinja2/__init__.py @@ -50,6 +50,7 @@ from opentelemetry.auto_instrumentation.instrumentor import BaseInstrumentor from opentelemetry.ext.jinja2.version import __version__ +from opentelemetry.ext.utils import unwrap from opentelemetry.trace import SpanKind, get_tracer from opentelemetry.trace.status import Status, StatusCanonicalCode @@ -115,12 +116,6 @@ def _wrap_load_template(tracer, wrapped, _, args, kwargs): ) -def _unwrap(obj, attr): - func = getattr(obj, attr, None) - if func and isinstance(func, ObjectProxy) and hasattr(func, "__wrapped__"): - setattr(obj, attr, func.__wrapped__) - - class Jinja2Instrumentor(BaseInstrumentor): """An instrumentor for jinja2 @@ -141,7 +136,7 @@ def _instrument(self, **kwargs): ) def _uninstrument(self, **kwargs): - _unwrap(jinja2.Template, "render") - _unwrap(jinja2.Template, "generate") - _unwrap(jinja2.Environment, "compile") - _unwrap(jinja2.Environment, "_load_template") + unwrap(jinja2.Template, "render") + unwrap(jinja2.Template, "generate") + unwrap(jinja2.Environment, "compile") + unwrap(jinja2.Environment, "_load_template") diff --git a/ext/opentelemetry-ext-redis/setup.cfg b/ext/opentelemetry-ext-redis/setup.cfg index 5ebd72f6d0a..8e7531cd6a4 100644 --- a/ext/opentelemetry-ext-redis/setup.cfg +++ b/ext/opentelemetry-ext-redis/setup.cfg @@ -41,6 +41,7 @@ package_dir= packages=find_namespace: install_requires = opentelemetry-api == 0.8.dev0 + opentelemetry-ext-utils == 0.8.dev0 opentelemetry-auto-instrumentation == 0.8.dev0 redis >= 2.6 wrapt >= 1.12.1 diff --git a/ext/opentelemetry-ext-redis/src/opentelemetry/ext/redis/__init__.py b/ext/opentelemetry-ext-redis/src/opentelemetry/ext/redis/__init__.py index e653936ca54..4dadc789296 100644 --- a/ext/opentelemetry-ext-redis/src/opentelemetry/ext/redis/__init__.py +++ b/ext/opentelemetry-ext-redis/src/opentelemetry/ext/redis/__init__.py @@ -55,6 +55,7 @@ _format_command_args, ) from opentelemetry.ext.redis.version import __version__ +from opentelemetry.ext.utils import unwrap _DEFAULT_SERVICE = "redis" _RAWCMD = "db.statement" @@ -68,12 +69,6 @@ def _set_connection_attributes(span, conn): span.set_attribute(key, value) -def _unwrap(obj, attr): - func = getattr(obj, attr, None) - if isinstance(func, ObjectProxy) and hasattr(func, "__wrapped__"): - setattr(obj, attr, func.__wrapped__) - - def _traced_execute_command(func, instance, args, kwargs): tracer = getattr(redis, "_opentelemetry_tracer") query = _format_command_args(args) @@ -145,19 +140,19 @@ def _instrument(self, **kwargs): def _uninstrument(self, **kwargs): if redis.VERSION < (3, 0, 0): - _unwrap(redis.StrictRedis, "execute_command") - _unwrap(redis.StrictRedis, "pipeline") - _unwrap(redis.Redis, "pipeline") - _unwrap( + unwrap(redis.StrictRedis, "execute_command") + unwrap(redis.StrictRedis, "pipeline") + unwrap(redis.Redis, "pipeline") + unwrap( redis.client.BasePipeline, # pylint:disable=no-member "execute", ) - _unwrap( + unwrap( redis.client.BasePipeline, # pylint:disable=no-member "immediate_execute_command", ) else: - _unwrap(redis.Redis, "execute_command") - _unwrap(redis.Redis, "pipeline") - _unwrap(redis.client.Pipeline, "execute") - _unwrap(redis.client.Pipeline, "immediate_execute_command") + unwrap(redis.Redis, "execute_command") + unwrap(redis.Redis, "pipeline") + unwrap(redis.client.Pipeline, "execute") + unwrap(redis.client.Pipeline, "immediate_execute_command") diff --git a/ext/opentelemetry-ext-requests/setup.cfg b/ext/opentelemetry-ext-requests/setup.cfg index 3fe0ef66d26..4a43075ff57 100644 --- a/ext/opentelemetry-ext-requests/setup.cfg +++ b/ext/opentelemetry-ext-requests/setup.cfg @@ -42,11 +42,13 @@ packages=find_namespace: install_requires = opentelemetry-api == 0.8.dev0 opentelemetry-auto-instrumentation == 0.8.dev0 + opentelemetry-ext-utils == 0.8.dev0 requests ~= 2.0 [options.extras_require] test = opentelemetry-test == 0.8.dev0 + opentelemetry-ext-utils == 0.8.dev0 httpretty ~= 1.0 [options.packages.find] diff --git a/ext/opentelemetry-ext-requests/src/opentelemetry/ext/requests/__init__.py b/ext/opentelemetry-ext-requests/src/opentelemetry/ext/requests/__init__.py index 1621c4a95e6..84c6bd40379 100644 --- a/ext/opentelemetry-ext-requests/src/opentelemetry/ext/requests/__init__.py +++ b/ext/opentelemetry-ext-requests/src/opentelemetry/ext/requests/__init__.py @@ -50,8 +50,9 @@ from opentelemetry import context, propagators, trace from opentelemetry.auto_instrumentation.instrumentor import BaseInstrumentor from opentelemetry.ext.requests.version import __version__ +from opentelemetry.ext.utils import http_status_to_canonical_code from opentelemetry.trace import SpanKind, get_tracer -from opentelemetry.trace.status import Status, StatusCanonicalCode +from opentelemetry.trace.status import Status # pylint: disable=unused-argument @@ -99,7 +100,7 @@ def instrumented_request(self, method, url, *args, **kwargs): span.set_attribute("http.status_code", result.status_code) span.set_attribute("http.status_text", result.reason) span.set_status( - Status(_http_status_to_canonical_code(result.status_code)) + Status(http_status_to_canonical_code(result.status_code)) ) if span_callback is not None: span_callback(span, result) @@ -126,37 +127,6 @@ def _uninstrument(): Session.request = original -def _http_status_to_canonical_code(code: int, allow_redirect: bool = True): - # pylint:disable=too-many-branches,too-many-return-statements - if code < 100: - return StatusCanonicalCode.UNKNOWN - if code <= 299: - return StatusCanonicalCode.OK - if code <= 399: - if allow_redirect: - return StatusCanonicalCode.OK - return StatusCanonicalCode.DEADLINE_EXCEEDED - if code <= 499: - if code == 401: # HTTPStatus.UNAUTHORIZED: - return StatusCanonicalCode.UNAUTHENTICATED - if code == 403: # HTTPStatus.FORBIDDEN: - return StatusCanonicalCode.PERMISSION_DENIED - if code == 404: # HTTPStatus.NOT_FOUND: - return StatusCanonicalCode.NOT_FOUND - if code == 429: # HTTPStatus.TOO_MANY_REQUESTS: - return StatusCanonicalCode.RESOURCE_EXHAUSTED - return StatusCanonicalCode.INVALID_ARGUMENT - if code <= 599: - if code == 501: # HTTPStatus.NOT_IMPLEMENTED: - return StatusCanonicalCode.UNIMPLEMENTED - if code == 503: # HTTPStatus.SERVICE_UNAVAILABLE: - return StatusCanonicalCode.UNAVAILABLE - if code == 504: # HTTPStatus.GATEWAY_TIMEOUT: - return StatusCanonicalCode.DEADLINE_EXCEEDED - return StatusCanonicalCode.INTERNAL - return StatusCanonicalCode.UNKNOWN - - class RequestsInstrumentor(BaseInstrumentor): """An instrumentor for requests See `BaseInstrumentor` diff --git a/ext/opentelemetry-ext-sqlalchemy/setup.cfg b/ext/opentelemetry-ext-sqlalchemy/setup.cfg index 68473b383fc..1c52ec80f39 100644 --- a/ext/opentelemetry-ext-sqlalchemy/setup.cfg +++ b/ext/opentelemetry-ext-sqlalchemy/setup.cfg @@ -42,6 +42,7 @@ packages=find_namespace: install_requires = opentelemetry-api == 0.8.dev0 opentelemetry-auto-instrumentation == 0.8.dev0 + opentelemetry-ext-utils == 0.8.dev0 wrapt >= 1.11.2 sqlalchemy diff --git a/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py b/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py index 05b384429b1..961ceb866db 100644 --- a/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py +++ b/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py @@ -53,16 +53,7 @@ _get_tracer, _wrap_create_engine, ) - - -def _unwrap(obj, attr): - func = getattr(obj, attr, None) - if ( - func - and isinstance(func, wrapt.ObjectProxy) - and hasattr(func, "__wrapped__") - ): - setattr(obj, attr, func.__wrapped__) +from opentelemetry.ext.utils import unwrap class SQLAlchemyInstrumentor(BaseInstrumentor): @@ -96,5 +87,5 @@ def _instrument(self, **kwargs): return None def _uninstrument(self, **kwargs): - _unwrap(sqlalchemy, "create_engine") - _unwrap(sqlalchemy.engine, "create_engine") + unwrap(sqlalchemy, "create_engine") + unwrap(sqlalchemy.engine, "create_engine") diff --git a/ext/opentelemetry-ext-utils/CHANGELOG.md b/ext/opentelemetry-ext-utils/CHANGELOG.md new file mode 100644 index 00000000000..33144da9132 --- /dev/null +++ b/ext/opentelemetry-ext-utils/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## Unreleased + +- Initial release \ No newline at end of file diff --git a/ext/opentelemetry-ext-utils/LICENSE b/ext/opentelemetry-ext-utils/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/ext/opentelemetry-ext-utils/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-utils/MANIFEST.in b/ext/opentelemetry-ext-utils/MANIFEST.in new file mode 100644 index 00000000000..aed3e33273b --- /dev/null +++ b/ext/opentelemetry-ext-utils/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-utils/README.rst b/ext/opentelemetry-ext-utils/README.rst new file mode 100644 index 00000000000..7f0cfb21a88 --- /dev/null +++ b/ext/opentelemetry-ext-utils/README.rst @@ -0,0 +1,20 @@ +OpenTelemetry Utility Package +============================= + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-utils.svg + :target: https://pypi.org/project/opentelemetry-ext-utils/ + +Installation +------------ + +:: + + pip install opentelemetry-ext-utils + + +References +---------- +* `OpenTelemetry Project `_ + diff --git a/ext/opentelemetry-ext-utils/setup.cfg b/ext/opentelemetry-ext-utils/setup.cfg new file mode 100644 index 00000000000..bb4f09f8ebf --- /dev/null +++ b/ext/opentelemetry-ext-utils/setup.cfg @@ -0,0 +1,50 @@ +# 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-utils +description = OpenTelemetry Utility package +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-utils +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 = + wrapt >= 1.0.0, < 2.0.0 + +[options.extras_require] +test = + opentelemetry-test == 0.8.dev0 + +[options.packages.find] +where = src diff --git a/ext/opentelemetry-ext-utils/setup.py b/ext/opentelemetry-ext-utils/setup.py new file mode 100644 index 00000000000..94ecda73d7d --- /dev/null +++ b/ext/opentelemetry-ext-utils/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", "utils", "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-utils/src/opentelemetry/ext/utils/__init__.py b/ext/opentelemetry-ext-utils/src/opentelemetry/ext/utils/__init__.py new file mode 100644 index 00000000000..152d09b601a --- /dev/null +++ b/ext/opentelemetry-ext-utils/src/opentelemetry/ext/utils/__init__.py @@ -0,0 +1,65 @@ +# 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. + +""" +Utility package for other opentelemetry extensions. +""" + +from wrapt import ObjectProxy + +from opentelemetry.trace.status import Status, StatusCanonicalCode + + +def http_status_to_canonical_code(status: int) -> StatusCanonicalCode: + """Converts an HTTP status code to an OpenTelemetry canonical status code + + Args: + status (int): HTTP status code + """ + # pylint:disable=too-many-branches,too-many-return-statements + if status < 100: + return StatusCanonicalCode.UNKNOWN + if status <= 399: + return StatusCanonicalCode.OK + if status <= 499: + if status == 401: # HTTPStatus.UNAUTHORIZED: + return StatusCanonicalCode.UNAUTHENTICATED + if status == 403: # HTTPStatus.FORBIDDEN: + return StatusCanonicalCode.PERMISSION_DENIED + if status == 404: # HTTPStatus.NOT_FOUND: + return StatusCanonicalCode.NOT_FOUND + if status == 429: # HTTPStatus.TOO_MANY_REQUESTS: + return StatusCanonicalCode.RESOURCE_EXHAUSTED + return StatusCanonicalCode.INVALID_ARGUMENT + if status <= 599: + if status == 501: # HTTPStatus.NOT_IMPLEMENTED: + return StatusCanonicalCode.UNIMPLEMENTED + if status == 503: # HTTPStatus.SERVICE_UNAVAILABLE: + return StatusCanonicalCode.UNAVAILABLE + if status == 504: # HTTPStatus.GATEWAY_TIMEOUT: + return StatusCanonicalCode.DEADLINE_EXCEEDED + return StatusCanonicalCode.INTERNAL + return StatusCanonicalCode.UNKNOWN + + +def unwrap(obj, attr: str): + """Given a function that was wrapped by wrapt.wrap_function_wrapper, unwrap it + + Args: + obj: Object that holds a reference to the wrapped function + attr (str): Name of the wrapped function + """ + func = getattr(obj, attr, None) + if func and isinstance(func, ObjectProxy) and hasattr(func, "__wrapped__"): + setattr(obj, attr, func.__wrapped__) diff --git a/ext/opentelemetry-ext-utils/src/opentelemetry/ext/utils/version.py b/ext/opentelemetry-ext-utils/src/opentelemetry/ext/utils/version.py new file mode 100644 index 00000000000..bcf6a357770 --- /dev/null +++ b/ext/opentelemetry-ext-utils/src/opentelemetry/ext/utils/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.8.dev0" diff --git a/ext/opentelemetry-ext-utils/tests/__init__.py b/ext/opentelemetry-ext-utils/tests/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/ext/opentelemetry-ext-utils/tests/test_utils.py b/ext/opentelemetry-ext-utils/tests/test_utils.py new file mode 100644 index 00000000000..fb888a80a23 --- /dev/null +++ b/ext/opentelemetry-ext-utils/tests/test_utils.py @@ -0,0 +1,56 @@ +# Copyright 2020, 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 http import HTTPStatus + +from opentelemetry.ext.utils import http_status_to_canonical_code +from opentelemetry.test.test_base import TestBase +from opentelemetry.trace.status import StatusCanonicalCode + + +class TestUtils(TestBase): + def test_http_status_to_canonical_code(self): + for status_code, expected in ( + (HTTPStatus.OK, StatusCanonicalCode.OK), + (HTTPStatus.ACCEPTED, StatusCanonicalCode.OK), + (HTTPStatus.IM_USED, StatusCanonicalCode.OK), + (HTTPStatus.MULTIPLE_CHOICES, StatusCanonicalCode.OK), + (HTTPStatus.BAD_REQUEST, StatusCanonicalCode.INVALID_ARGUMENT), + (HTTPStatus.UNAUTHORIZED, StatusCanonicalCode.UNAUTHENTICATED), + (HTTPStatus.FORBIDDEN, StatusCanonicalCode.PERMISSION_DENIED), + (HTTPStatus.NOT_FOUND, StatusCanonicalCode.NOT_FOUND), + ( + HTTPStatus.UNPROCESSABLE_ENTITY, + StatusCanonicalCode.INVALID_ARGUMENT, + ), + ( + HTTPStatus.TOO_MANY_REQUESTS, + StatusCanonicalCode.RESOURCE_EXHAUSTED, + ), + (HTTPStatus.NOT_IMPLEMENTED, StatusCanonicalCode.UNIMPLEMENTED), + (HTTPStatus.SERVICE_UNAVAILABLE, StatusCanonicalCode.UNAVAILABLE), + ( + HTTPStatus.GATEWAY_TIMEOUT, + StatusCanonicalCode.DEADLINE_EXCEEDED, + ), + ( + HTTPStatus.HTTP_VERSION_NOT_SUPPORTED, + StatusCanonicalCode.INTERNAL, + ), + (600, StatusCanonicalCode.UNKNOWN), + (99, StatusCanonicalCode.UNKNOWN), + ): + with self.subTest(status_code=status_code): + actual = http_status_to_canonical_code(int(status_code)) + self.assertEqual(actual, expected, status_code) diff --git a/ext/opentelemetry-ext-wsgi/setup.cfg b/ext/opentelemetry-ext-wsgi/setup.cfg index 87e117589c8..dd0f772ac22 100644 --- a/ext/opentelemetry-ext-wsgi/setup.cfg +++ b/ext/opentelemetry-ext-wsgi/setup.cfg @@ -41,6 +41,7 @@ package_dir= packages=find_namespace: install_requires = opentelemetry-api == 0.8.dev0 + opentelemetry-ext-utils == 0.8.dev0 [options.extras_require] test = diff --git a/ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py b/ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py index 61e8126c196..c9f469e9ae8 100644 --- a/ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py +++ b/ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py @@ -60,6 +60,7 @@ def hello(): import wsgiref.util as wsgiref_util from opentelemetry import context, propagators, trace +from opentelemetry.ext.utils import http_status_to_canonical_code from opentelemetry.ext.wsgi.version import __version__ from opentelemetry.trace.propagation import get_span_from_context from opentelemetry.trace.status import Status, StatusCanonicalCode @@ -87,37 +88,6 @@ def setifnotnone(dic, key, value): dic[key] = value -def http_status_to_canonical_code(code: int, allow_redirect: bool = True): - # pylint:disable=too-many-branches,too-many-return-statements - if code < 100: - return StatusCanonicalCode.UNKNOWN - if code <= 299: - return StatusCanonicalCode.OK - if code <= 399: - if allow_redirect: - return StatusCanonicalCode.OK - return StatusCanonicalCode.DEADLINE_EXCEEDED - if code <= 499: - if code == 401: # HTTPStatus.UNAUTHORIZED: - return StatusCanonicalCode.UNAUTHENTICATED - if code == 403: # HTTPStatus.FORBIDDEN: - return StatusCanonicalCode.PERMISSION_DENIED - if code == 404: # HTTPStatus.NOT_FOUND: - return StatusCanonicalCode.NOT_FOUND - if code == 429: # HTTPStatus.TOO_MANY_REQUESTS: - return StatusCanonicalCode.RESOURCE_EXHAUSTED - return StatusCanonicalCode.INVALID_ARGUMENT - if code <= 599: - if code == 501: # HTTPStatus.NOT_IMPLEMENTED: - return StatusCanonicalCode.UNIMPLEMENTED - if code == 503: # HTTPStatus.SERVICE_UNAVAILABLE: - return StatusCanonicalCode.UNAVAILABLE - if code == 504: # HTTPStatus.GATEWAY_TIMEOUT: - return StatusCanonicalCode.DEADLINE_EXCEEDED - return StatusCanonicalCode.INTERNAL - return StatusCanonicalCode.UNKNOWN - - def collect_request_attributes(environ): """Collects HTTP request attributes from the PEP3333-conforming WSGI environ and returns a dictionary to be used as span creation attributes.""" diff --git a/tox.ini b/tox.ini index abb1355be96..cf9e15c8ceb 100644 --- a/tox.ini +++ b/tox.ini @@ -87,6 +87,10 @@ envlist = py3{4,5,6,7,8}-test-ext-sqlite3 pypy3-test-ext-sqlite3 + ; opentelemetry-ext-utils + py3{4,5,6,7,8}-test-ext-utils + pypy3-test-ext-utils + ; opentelemetry-ext-wsgi py3{4,5,6,7,8}-test-ext-wsgi pypy3-test-ext-wsgi @@ -154,6 +158,7 @@ changedir = test-ext-pymysql: ext/opentelemetry-ext-pymysql/tests test-ext-asgi: ext/opentelemetry-ext-asgi/tests test-ext-sqlite3: ext/opentelemetry-ext-sqlite3/tests + test-ext-utils: ext/opentelemetry-ext-utils/tests test-ext-wsgi: ext/opentelemetry-ext-wsgi/tests test-ext-zipkin: ext/opentelemetry-ext-zipkin/tests test-ext-flask: ext/opentelemetry-ext-flask/tests @@ -172,18 +177,22 @@ commands_pre = test-auto-instrumentation: pip install {toxinidir}/opentelemetry-auto-instrumentation - example-app: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-requests {toxinidir}/ext/opentelemetry-ext-wsgi {toxinidir}/ext/opentelemetry-ext-flask {toxinidir}/docs/examples/opentelemetry-example-app + example-app: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-utils {toxinidir}/ext/opentelemetry-ext-requests {toxinidir}/ext/opentelemetry-ext-wsgi {toxinidir}/ext/opentelemetry-ext-flask {toxinidir}/docs/examples/opentelemetry-example-app - getting-started: pip install -e {toxinidir}/opentelemetry-auto-instrumentation -e {toxinidir}/ext/opentelemetry-ext-requests -e {toxinidir}/ext/opentelemetry-ext-wsgi -e {toxinidir}/ext/opentelemetry-ext-flask + getting-started: pip install -e {toxinidir}/opentelemetry-auto-instrumentation -e {toxinidir}/ext/opentelemetry-ext-utils -e {toxinidir}/ext/opentelemetry-ext-requests -e {toxinidir}/ext/opentelemetry-ext-wsgi -e {toxinidir}/ext/opentelemetry-ext-flask grpc: pip install {toxinidir}/ext/opentelemetry-ext-grpc[test] + wsgi,flask,django,asgi: pip install {toxinidir}/ext/opentelemetry-ext-utils wsgi,flask,django,asgi: pip install {toxinidir}/tests/util wsgi,flask,django: pip install {toxinidir}/ext/opentelemetry-ext-wsgi + flask,django: pip install {toxinidir}/opentelemetry-auto-instrumentation asgi: pip install {toxinidir}/ext/opentelemetry-ext-asgi flask: pip install {toxinidir}/ext/opentelemetry-ext-flask[test] + dbapi,mysql,psycopg2,pymysql,sqlite3: pip install {toxinidir}/ext/opentelemetry-ext-utils + dbapi: pip install {toxinidir}/ext/opentelemetry-ext-dbapi[test] django: pip install {toxinidir}/ext/opentelemetry-ext-django[test] @@ -202,13 +211,13 @@ commands_pre = sqlite3: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-dbapi {toxinidir}/ext/opentelemetry-ext-sqlite3[test] - redis: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-redis[test] + redis: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-utils {toxinidir}/ext/opentelemetry-ext-redis[test] - requests: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-requests[test] + requests: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-utils {toxinidir}/ext/opentelemetry-ext-requests[test] - jinja2: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-jinja2[test] + jinja2: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-utils {toxinidir}/ext/opentelemetry-ext-jinja2[test] - aiohttp-client: pip install {toxinidir}/opentelemetry-sdk {toxinidir}/ext/opentelemetry-ext-aiohttp-client + aiohttp-client: pip install {toxinidir}/opentelemetry-sdk {toxinidir}/ext/opentelemetry-ext-utils {toxinidir}/ext/opentelemetry-ext-aiohttp-client jaeger: pip install {toxinidir}/ext/opentelemetry-ext-jaeger @@ -218,7 +227,9 @@ commands_pre = zipkin: pip install {toxinidir}/ext/opentelemetry-ext-zipkin - sqlalchemy: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-sqlalchemy + sqlalchemy: pip install {toxinidir}/opentelemetry-auto-instrumentation {toxinidir}/ext/opentelemetry-ext-utils {toxinidir}/ext/opentelemetry-ext-sqlalchemy + + utils: pip install {toxinidir}/ext/opentelemetry-ext-utils ; In order to get a healthy coverage report, ; we have to install packages in editable mode. @@ -283,7 +294,7 @@ commands_pre = pip install -e {toxinidir}/opentelemetry-api \ -e {toxinidir}/opentelemetry-auto-instrumentation \ -e {toxinidir}/opentelemetry-sdk \ - -e {toxinidir}/opentelemetry-auto-instrumentation \ + -e {toxinidir}/ext/opentelemetry-ext-utils \ -e {toxinidir}/ext/opentelemetry-ext-requests \ -e {toxinidir}/ext/opentelemetry-ext-wsgi \ -e {toxinidir}/ext/opentelemetry-ext-flask