diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index a92446b998..9fcd9c7b5b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -24,7 +24,7 @@ jobs: fail-fast: false # ensures the entire test matrix is run, even if one permutation fails matrix: python-version: [ py37, py38, py39, py310, py311, pypy3 ] - package: ["instrumentation", "distro", "exporter", "sdkextension", "propagator"] + package: ["instrumentation", "distro", "exporter", "sdkextension", "propagator", "resource"] os: [ ubuntu-20.04 ] steps: - name: Checkout Contrib Repo @ SHA - ${{ github.sha }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 068a067dd1..c8824fc336 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -54,6 +54,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#1434](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1434)) - `opentelemetry-instrumentation-confluent-kafka` Add support for the latest versions of the library. ([#1468](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1468)) +- `opentelemetry-resource-detector-kubernetes` Add support resource detection of kubernetes properties. + ([#1489](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1489)) ### Fixed diff --git a/docs/conf.py b/docs/conf.py index 93d5b7cdca..f866a5ca20 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,7 +54,17 @@ if isdir(join(sdk_ext, f)) ] -sys.path[:0] = exp_dirs + instr_dirs + sdk_ext_dirs + prop_dirs +resource_ext = "../resource" +resource_ext_dirs = [ + os.path.abspath("/".join(["../resource", f, "src"])) + for f in listdir(resource_ext) + if isdir(join(resource_ext, f)) +] + + +sys.path[:0] = ( + exp_dirs + instr_dirs + sdk_ext_dirs + prop_dirs + resource_ext_dirs +) # -- Project information ----------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 44fbfc1188..2a037c79bf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,7 @@ installed separately via pip: pip install opentelemetry-exporter-{exporter} pip install opentelemetry-instrumentation-{instrumentation} pip install opentelemetry-sdk-extension-{sdkextension} + pip install opentelemetry-resource-detector-{containers} A complete list of packages can be found at the `Contrib repo instrumentation `_ @@ -33,7 +34,7 @@ Extensions Visit `OpenTelemetry Registry `_ to find a lot of related projects like exporters, instrumentation libraries, tracer -implementations, etc. +implementations, resource etc. Installing Cutting Edge Packages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -51,6 +52,7 @@ install pip install -e ./instrumentation/opentelemetry-instrumentation-flask pip install -e ./instrumentation/opentelemetry-instrumentation-botocore pip install -e ./sdk-extension/opentelemetry-sdk-extension-aws + pip install -e ./resource/opentelemetry-resource-detector-kubernetes .. toctree:: @@ -85,6 +87,15 @@ install sdk-extension/** +.. toctree:: + :maxdepth: 2 + :caption: OpenTelemetry Resource Detectors + :name: Resource Detectors + :glob: + + resource/** + + Indices and tables ------------------ diff --git a/docs/resource/kubernetes/kubernetes.rst b/docs/resource/kubernetes/kubernetes.rst new file mode 100644 index 0000000000..a416d8ff4f --- /dev/null +++ b/docs/resource/kubernetes/kubernetes.rst @@ -0,0 +1,7 @@ +OpenTelemetry Python - Resource detector kubernetes +==================================================== + +.. automodule:: opentelemetry.resource.detector.kubernetes + :members: + :undoc-members: + :show-inheritance: diff --git a/resource/opentelemetry-resource-detector-kubernetes/LICENSE b/resource/opentelemetry-resource-detector-kubernetes/LICENSE new file mode 100644 index 0000000000..1ef7dad2c5 --- /dev/null +++ b/resource/opentelemetry-resource-detector-kubernetes/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 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. diff --git a/resource/opentelemetry-resource-detector-kubernetes/MANIFEST.rst b/resource/opentelemetry-resource-detector-kubernetes/MANIFEST.rst new file mode 100644 index 0000000000..aed3e33273 --- /dev/null +++ b/resource/opentelemetry-resource-detector-kubernetes/MANIFEST.rst @@ -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/resource/opentelemetry-resource-detector-kubernetes/README.rst b/resource/opentelemetry-resource-detector-kubernetes/README.rst new file mode 100644 index 0000000000..5b59000eea --- /dev/null +++ b/resource/opentelemetry-resource-detector-kubernetes/README.rst @@ -0,0 +1,48 @@ +OpenTelemetry Resources for container-detectors-kubernetes +========================================================== + +|pypi| + +.. |pypi| image:: TODO + :target: TODO + + +This library provides k8s pod property (k8s.id) detection features +which can help in identifying the problems in app - infra correlation +for apps running on k8s + +Installation +------------ + +:: + + pip install opentelemetry-resource-detector-kubernetes + +---------------------------- + +Below is the give example for `opentelemetry-resource-detector-kubernetes` + +.. code-block:: python + + import opentelemetry.trace as trace + from opentelemetry.sdk.trace import TracerProvider + from opentelemetry.resource.detector.kubernetes import ( + KubernetesResourceDetector, + ) + from opentelemetry.sdk.resources import get_aggregated_resources + + trace.set_tracer_provider( + TracerProvider( + resource=get_aggregated_resources( + [ + KubernetesResourceDetector(), + ] + ), + ) + ) + + +References +---------- + +* `OpenTelemetry Project `_ diff --git a/resource/opentelemetry-resource-detector-kubernetes/pyproject.toml b/resource/opentelemetry-resource-detector-kubernetes/pyproject.toml new file mode 100644 index 0000000000..89f61641c4 --- /dev/null +++ b/resource/opentelemetry-resource-detector-kubernetes/pyproject.toml @@ -0,0 +1,50 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "opentelemetry-resource-detector-kubernetes" +dynamic = ["version"] +description = "An Kubernetes resource detector library" +readme = "README.rst" +license = "Apache-2.0" +requires-python = ">=3.7" +authors = [ + { name = "OpenTelemetry Authors", email = "cncf-opentelemetry-contributors@lists.cncf.io" }, +] +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", +] +dependencies = [ + "opentelemetry-sdk ~= 1.12", +] + +[project.optional-dependencies] +test = [] + +[project.entry-points.opentelemetry_resource_detector] +kubernetes = "opentelemetry.resource.detector.kubernetes:KubernetesResourceDetector" + +[project.urls] +Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/resource/opentelemetry-resource-detector-kubernetes" + +[tool.hatch.version] +path = "src/opentelemetry/resource/detector/kubernetes/version.py" + +[tool.hatch.build.targets.sdist] +include = [ + "/src", + "/tests", +] + +[tool.hatch.build.targets.wheel] +packages = ["src/opentelemetry"] diff --git a/resource/opentelemetry-resource-detector-kubernetes/src/opentelemetry/resource/detector/kubernetes/__init__.py b/resource/opentelemetry-resource-detector-kubernetes/src/opentelemetry/resource/detector/kubernetes/__init__.py new file mode 100644 index 0000000000..80307f3918 --- /dev/null +++ b/resource/opentelemetry-resource-detector-kubernetes/src/opentelemetry/resource/detector/kubernetes/__init__.py @@ -0,0 +1,116 @@ +# 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 logging +import os + +from opentelemetry.sdk.resources import Resource, ResourceDetector +from opentelemetry.semconv.resource import ResourceAttributes + +logger = logging.getLogger(__name__) +DEFAULT_CGROUP_V1_PATH = "/proc/self/mountinfo" +DEFAULT_CGROUP_V2_PATH = "/proc/self/cgroup" +KUBERNETES_SECRET_PATH = "/var/run/secrets/kubernetes.io" +_POD_ID_LENGTH = 36 +_CONTAINER_ID_LENGTH = 64 + + +def is_container_on_kubernetes() -> bool: + # Kubernetes manages the /etc/hosts file inside the pods' containers, + # using a distinctive header, see https://github.com/kubernetes/kubernetes/commit/fd72938dd569bd041f11a76eecfe9b8b4bcf5ae8 + with open("/etc/hosts", "r", encoding="utf8") as hosts_file: + first_line = hosts_file.readline() + return "Kubernetes" in first_line or os.path.exists( + KUBERNETES_SECRET_PATH + ) + + +def get_kubenertes_pod_uid_v1(): + pod_id = None + try: + with open( + DEFAULT_CGROUP_V1_PATH, encoding="utf8" + ) as container_info_file: + for raw_line in container_info_file.readlines(): + line = raw_line.strip() + # Subsequent IDs should be the same, exit if found one + if len(line) > _POD_ID_LENGTH and "/pods/" in line: + pod_id = line.split("/pods/")[1][:_POD_ID_LENGTH] + break + except FileNotFoundError as exception: + logger.warning("Failed to get k8 id. Exception: %s}", exception) + return pod_id + + +def get_kubenertes_pod_uid_v2(): + pod_id = None + try: + with open( + DEFAULT_CGROUP_V2_PATH, encoding="utf8" + ) as container_info_file: + for raw_line in container_info_file.readlines(): + line = raw_line.strip() + # Subsequent IDs should be the same, exit if found one + if len(line) > _CONTAINER_ID_LENGTH: + line_info = line.split("/") + if ( + len(line_info) > 2 + and line_info[-2][:3] == "pod" + and len(line_info[-2]) == _POD_ID_LENGTH + 3 + ): + pod_id = line_info[-2][3 : 3 + _POD_ID_LENGTH] + else: + pod_id = line_info[-2] + break + except FileNotFoundError as exception: + logger.warning("Failed to get k8 id. Exception: %s}", exception) + return pod_id + + +class KubernetesResourceDetector(ResourceDetector): + """Detects attribute values only available when the app is running on kubernetes + container and returns a resource object. + """ + + def detect(self) -> "Resource": + try: + pod_resource = Resource.get_empty() + if is_container_on_kubernetes(): + pod_uid = ( + get_kubenertes_pod_uid_v1() or get_kubenertes_pod_uid_v2() + ) + if pod_uid: + pod_resource = pod_resource.merge( + Resource( + { + ResourceAttributes.K8S_POD_UID: pod_uid, + } + ) + ) + else: + logger.warning( + "Could not confirm process is running on kubernetes cluster." + ) + return pod_resource + + # pylint: disable=broad-except + except Exception as exception: + if self.raise_on_error: + raise exception + + logger.warning( + "Failed to get pod ID on kubernetes cluster: %s.", + exception, + ) + return Resource.get_empty() diff --git a/resource/opentelemetry-resource-detector-kubernetes/src/opentelemetry/resource/detector/kubernetes/version.py b/resource/opentelemetry-resource-detector-kubernetes/src/opentelemetry/resource/detector/kubernetes/version.py new file mode 100644 index 0000000000..7b82da2b85 --- /dev/null +++ b/resource/opentelemetry-resource-detector-kubernetes/src/opentelemetry/resource/detector/kubernetes/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__ = "1.0.0" diff --git a/resource/opentelemetry-resource-detector-kubernetes/tests/__init__.py b/resource/opentelemetry-resource-detector-kubernetes/tests/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/resource/opentelemetry-resource-detector-kubernetes/tests/test_kubernetes.py b/resource/opentelemetry-resource-detector-kubernetes/tests/test_kubernetes.py new file mode 100644 index 0000000000..a2713357f2 --- /dev/null +++ b/resource/opentelemetry-resource-detector-kubernetes/tests/test_kubernetes.py @@ -0,0 +1,257 @@ +# 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 mock_open, patch + +from opentelemetry import trace as trace_api +from opentelemetry.resource.detector.kubernetes import ( + KubernetesResourceDetector, + get_kubenertes_pod_uid_v1, + get_kubenertes_pod_uid_v2, + is_container_on_kubernetes, +) +from opentelemetry.sdk.resources import Resource, get_aggregated_resources +from opentelemetry.semconv.resource import ResourceAttributes +from opentelemetry.test.wsgitestutil import WsgiTestBase + +MockKubernetesResourceAttributes = { + ResourceAttributes.K8S_POD_UID: "ecc2f8af-7742-4087-aeb1-4601bf25e1df", +} + + +def simple_wsgi(environ, start_response): + assert isinstance(environ, dict) + start_response("200 OK", [("Content-Type", "text/plain")]) + return b"*" + + +class KubernetesResourceDetectorTest(WsgiTestBase): + @patch( + "opentelemetry.resource.detector.kubernetes.get_kubenertes_pod_uid_v1", + return_value=f"{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}", + ) + @patch( + "opentelemetry.resource.detector.kubernetes.get_kubenertes_pod_uid_v2", + return_value=f"{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}", + ) + @patch( + "opentelemetry.resource.detector.kubernetes.is_container_on_kubernetes", + return_value=True, + ) + def test_simple_detector( + self, + mock_get_kubenertes_pod_uid_v1, + mock_get_kubenertes_pod_uid_v2, + mock_is_container_on_kubernetes, + ): + actual = KubernetesResourceDetector().detect() + self.assertEqual( + actual.attributes[ResourceAttributes.K8S_POD_UID], + MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID], + ) + + @patch( + "opentelemetry.resource.detector.kubernetes.get_kubenertes_pod_uid_v1", + side_effect=Exception("Test"), + ) + def test_without_k8s_pod(self, mock_get_kubenertes_pod_uid_v1): + actual = KubernetesResourceDetector().detect() + self.assertEqual(Resource.get_empty(), actual) + + @patch( + "builtins.open", + new_callable=mock_open, + read_data=f"""564 446 0:164 / / rw,relatime master:190 - overlay overlay rw,lowerdir=/var/lib/docker/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +565 564 0:166 / /proc rw,nosuid,nodev,noexec,relatime - proc proc rw +566 564 0:338 / /dev rw,nosuid - tmpfs tmpfs rw,size=65536k,mode=755 +567 566 0:339 / /dev/pts rw,nosuid,noexec,relatime - devpts devpts rw,gid=5,mode=620,ptmxmode=666 +568 564 0:161 / /sys ro,nosuid,nodev,noexec,relatime - sysfs sysfs ro +569 568 0:30 / /sys/fs/cgroup ro,nosuid,nodev,noexec,relatime - cgroup2 cgroup rw +570 566 0:157 / /dev/mqueue rw,nosuid,nodev,noexec,relatime - mqueue mqueue rw +571 566 254:1 /docker/volumes/minikube/_data/lib/kubelet/pods/{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/containers/my-shell/0447d6c5 /dev/termination-log rw,relatime - ext4 /dev/vda1 rw +572 564 254:1 /docker/volumes/minikube/_data/lib/docker/containers/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +573 564 254:1 /docker/volumes/minikube/_data/lib/docker/containers/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +574 564 254:1 /docker/volumes/minikube/_data/lib/kubelet/pods/{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/etc-hosts /etc/hosts rw,relatime - ext4 /dev/vda1 rw +575 566 0:156 / /bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +576 564 0:153 / /bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +447 566 0:339 /0 /bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +448 565 0:166 /bus /bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +450 565 0:166 /irq /bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +451 565 0:166 /sys /bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +452 565 0:166 /sysrq-trigger /bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +""", + ) + @patch( + "opentelemetry.resource.detector.kubernetes.is_container_on_kubernetes", + return_value=True, + ) + def test_get_kubenertes_pod_uid_v1( + self, mock_open_func, mock_is_container_on_kubernetes + ): + actual_pod_uid = get_kubenertes_pod_uid_v1() + self.assertEqual( + actual_pod_uid, + MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID], + ) + + @patch( + "builtins.open", + new_callable=mock_open, + read_data=f"""14:name=systemd:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +13:rdma:/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +12:pids:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +11:hugetlb:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +10:net_prio:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +9:perf_event:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +8:net_cls:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +7:freezer:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +6:devices:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +5:memory:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +4:blkio:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +3:cpuacct:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +2:cpu:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +1:cpuset:/docker/c24aa3879860ee981d29f0492aef1e39c45d7c7fcdff7bd2050047d0bd390311/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +0::/kubepods/besteffort/pod{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}/bogusPodIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked +""", + ) + @patch( + "opentelemetry.resource.detector.kubernetes.is_container_on_kubernetes", + return_value=True, + ) + def test_get_kubenertes_pod_uid_v2( + self, mock_open_func, mock_is_container_on_kubernetes + ): + actual_pod_uid = get_kubenertes_pod_uid_v2() + self.assertEqual( + actual_pod_uid, + MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID], + ) + + @patch( + "opentelemetry.resource.detector.kubernetes.get_kubenertes_pod_uid_v1", + return_value=f"{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}", + ) + @patch( + "opentelemetry.resource.detector.kubernetes.get_kubenertes_pod_uid_v2", + return_value=f"{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}", + ) + @patch( + "opentelemetry.resource.detector.kubernetes.is_container_on_kubernetes", + return_value=True, + ) + def test_k8_id_as_span_attribute( + self, + mock_get_kubenertes_pod_uid_v1, + mock_get_kubenertes_pod_uid_v2, + mock_is_container_on_kubernetes, + ): + tracer_provider, exporter = self.create_tracer_provider( + resource=get_aggregated_resources([KubernetesResourceDetector()]) + ) + tracer = tracer_provider.get_tracer(__name__) + + with tracer.start_as_current_span( + "test", kind=trace_api.SpanKind.SERVER + ) as _: + response = simple_wsgi(self.environ, self.start_response) + self.assertEqual(response, b"*") + span_list = exporter.get_finished_spans() + self.assertEqual( + span_list[0].resource.attributes["k8s.pod.uid"], + MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID], + ) + + def test_k8_without_container_as_span_attribute(self): + tracer_provider, exporter = self.create_tracer_provider( + resource=get_aggregated_resources([KubernetesResourceDetector()]) + ) + tracer = tracer_provider.get_tracer(__name__) + + with tracer.start_as_current_span( + "Test", kind=trace_api.SpanKind.SERVER + ) as _: + response = simple_wsgi(self.environ, self.start_response) + self.assertEqual(response, b"*") + span_list = exporter.get_finished_spans() + self.assertTrue("k8s.pod.uid" not in span_list[0].resource.attributes) + + @patch( + "opentelemetry.resource.detector.kubernetes.get_kubenertes_pod_uid_v1", + return_value=f"{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}", + ) + @patch( + "opentelemetry.resource.detector.kubernetes.is_container_on_kubernetes", + return_value=True, + ) + def test_k8_id_as_span_attribute_with_mountinfo_v1( + self, mock_get_kubenertes_pod_uid_v1, mock_is_container_on_kubernetes + ): + tracer_provider, exporter = self.create_tracer_provider( + resource=get_aggregated_resources([KubernetesResourceDetector()]) + ) + tracer = tracer_provider.get_tracer(__name__) + + with tracer.start_as_current_span( + "Test", kind=trace_api.SpanKind.SERVER + ) as _: + response = simple_wsgi(self.environ, self.start_response) + self.assertEqual(response, b"*") + span_list = exporter.get_finished_spans() + self.assertEqual( + span_list[0].resource.attributes["k8s.pod.uid"], + MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID], + ) + + @patch( + "opentelemetry.resource.detector.kubernetes.get_kubenertes_pod_uid_v2", + return_value=f"{MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID]}", + ) + @patch( + "opentelemetry.resource.detector.kubernetes.is_container_on_kubernetes", + return_value=True, + ) + def test_k8_id_as_span_attribute_with_cgroup_v2( + self, mock_get_kubenertes_pod_uid_v2, mock_is_container_on_kubernetes + ): + tracer_provider, exporter = self.create_tracer_provider( + resource=get_aggregated_resources([KubernetesResourceDetector()]) + ) + tracer = tracer_provider.get_tracer(__name__) + + with tracer.start_as_current_span( + "Test", kind=trace_api.SpanKind.SERVER + ) as _: + response = simple_wsgi(self.environ, self.start_response) + self.assertEqual(response, b"*") + span_list = exporter.get_finished_spans() + self.assertEqual( + span_list[0].resource.attributes["k8s.pod.uid"], + MockKubernetesResourceAttributes[ResourceAttributes.K8S_POD_UID], + ) + + @patch( + "builtins.open", + new_callable=mock_open, + read_data="""# Kubernetes-managed hosts file (host network). +127.0.0.1 localhost +::1 localhost ip6-localhost ip6-loopback +fe00::0 ip6-localnet +ff00::0 ip6-mcastprefix +ff02::1 ip6-allnodes +ff02::2 ip6-allrouters +""", + ) + def test_is_container_on_kubernetes(self, mock_open_func): + patch_response = is_container_on_kubernetes() + self.assertTrue(patch_response) diff --git a/tox.ini b/tox.ini index 4cd6fa02f5..6ff5f7b1fb 100644 --- a/tox.ini +++ b/tox.ini @@ -10,6 +10,10 @@ envlist = py3{7,8,9,10,11}-test-sdkextension-aws pypy3-test-sdkextension-aws + ; opentelemetry-resource-detector-kubernetes + py3{7,8,9,10,11}-test-resource-detector-kubernetes + pypy3-test-resource-detector-kubernetes + ; opentelemetry-distro py3{7,8,9,10,11}-test-distro pypy3-test-distro @@ -311,6 +315,7 @@ changedir = test-instrumentation-httpx{18,21}: instrumentation/opentelemetry-instrumentation-httpx/tests test-util-http: util/opentelemetry-util-http/tests test-sdkextension-aws: sdk-extension/opentelemetry-sdk-extension-aws/tests + test-resource-detector-kubernetes: resource/opentelemetry-resource-detector-kubernetes/tests test-propagator-aws: propagator/opentelemetry-propagator-aws-xray/tests test-propagator-ot-trace: propagator/opentelemetry-propagator-ot-trace/tests test-exporter-richconsole: exporter/opentelemetry-exporter-richconsole/tests @@ -418,6 +423,8 @@ commands_pre = sdkextension-aws: pip install {toxinidir}/sdk-extension/opentelemetry-sdk-extension-aws[test] + resource-detector-kubernetes: pip install {toxinidir}/resource/opentelemetry-resource-detector-kubernetes[test] + http: pip install {toxinidir}/util/opentelemetry-util-http[test] ; In order to get a health coverage report, propagator-ot-trace: pip install {toxinidir}/propagator/opentelemetry-propagator-ot-trace[test] @@ -523,6 +530,7 @@ commands_pre = python -m pip install -e {toxinidir}/exporter/opentelemetry-exporter-richconsole[test] python -m pip install -e {toxinidir}/exporter/opentelemetry-exporter-prometheus-remote-write[test] python -m pip install -e {toxinidir}/sdk-extension/opentelemetry-sdk-extension-aws[test] + python -m pip install -e {toxinidir}/resource/opentelemetry-resource-detector-kubernetes[test] python -m pip install -e {toxinidir}/propagator/opentelemetry-propagator-aws-xray[test] python -m pip install -e {toxinidir}/propagator/opentelemetry-propagator-ot-trace[test] python -m pip install -e {toxinidir}/opentelemetry-distro[test]