Add utils file in opentelemetry-instrumentation

Author: cnnradams

opentelemetry-instrumentation/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Rename opentelemetry-auto-instrumentation to opentelemetry-instrumentation,
+  and console script `opentelemetry-auto-instrumentation` to `opentelemetry-instrument`
+
 ## 0.8b0
 
 Released 2020-05-27

opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py

@@ -0,0 +1,67 @@
+# 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 wrapt import ObjectProxy
+
+from opentelemetry.trace.status import Status, StatusCanonicalCode
+
+
+def http_status_to_canonical_code(
+    status: int, allow_redirect: bool = True
+) -> 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 <= 299:
+        return StatusCanonicalCode.OK
+    if status <= 399:
+        if allow_redirect:
+            return StatusCanonicalCode.OK
+        return StatusCanonicalCode.DEADLINE_EXCEEDED
+    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__)

opentelemetry-instrumentation/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.instrumentation.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)