From e99705e40c69eb5faf41a33747a3ed89aa985f35 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Sat, 2 May 2020 21:30:28 -0700 Subject: [PATCH 01/16] ext/system-metrics: adding instrumentation to collect system metrics Adding an extension to provide users an easy mechanism to collect metrics for their system. As part of this change, I also added an InMemoryMetricsExporter. I ended up adding meter_provider and memory_metrics_exporter to TestBase --- .../CHANGELOG.md | 5 + ext/opentelemetry-ext-system-metrics/LICENSE | 201 +++++++++++++++++ .../MANIFEST.in | 9 + .../README.rst | 23 ++ .../setup.cfg | 51 +++++ ext/opentelemetry-ext-system-metrics/setup.py | 26 +++ .../ext/system_metrics/__init__.py | 165 ++++++++++++++ .../ext/system_metrics/version.py | 15 ++ .../tests/__init__.py | 0 .../tests/test_system_metrics.py | 212 ++++++++++++++++++ .../export/in_memory_metrics_exporter.py | 49 ++++ .../util/src/opentelemetry/test/test_base.py | 21 +- tox.ini | 11 +- 13 files changed, 785 insertions(+), 3 deletions(-) create mode 100644 ext/opentelemetry-ext-system-metrics/CHANGELOG.md create mode 100644 ext/opentelemetry-ext-system-metrics/LICENSE create mode 100644 ext/opentelemetry-ext-system-metrics/MANIFEST.in create mode 100644 ext/opentelemetry-ext-system-metrics/README.rst create mode 100644 ext/opentelemetry-ext-system-metrics/setup.cfg create mode 100644 ext/opentelemetry-ext-system-metrics/setup.py create mode 100644 ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py create mode 100644 ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py create mode 100644 ext/opentelemetry-ext-system-metrics/tests/__init__.py create mode 100644 ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py create mode 100644 opentelemetry-sdk/src/opentelemetry/sdk/metrics/export/in_memory_metrics_exporter.py diff --git a/ext/opentelemetry-ext-system-metrics/CHANGELOG.md b/ext/opentelemetry-ext-system-metrics/CHANGELOG.md new file mode 100644 index 00000000000..33144da9132 --- /dev/null +++ b/ext/opentelemetry-ext-system-metrics/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## Unreleased + +- Initial release \ No newline at end of file diff --git a/ext/opentelemetry-ext-system-metrics/LICENSE b/ext/opentelemetry-ext-system-metrics/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/ext/opentelemetry-ext-system-metrics/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-system-metrics/MANIFEST.in b/ext/opentelemetry-ext-system-metrics/MANIFEST.in new file mode 100644 index 00000000000..aed3e33273b --- /dev/null +++ b/ext/opentelemetry-ext-system-metrics/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-system-metrics/README.rst b/ext/opentelemetry-ext-system-metrics/README.rst new file mode 100644 index 00000000000..e5a1e57c065 --- /dev/null +++ b/ext/opentelemetry-ext-system-metrics/README.rst @@ -0,0 +1,23 @@ +OpenTelemetry System Metrics Instrumentation +============================================ + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-system-metrics.svg + :target: https://pypi.org/project/opentelemetry-ext-system-metrics/ + +Instrumentation to collect system performance metrics. + + +Installation +------------ + +:: + + pip install opentelemetry-ext-system-metrics + + +References +---------- +* `OpenTelemetry Project `_ + diff --git a/ext/opentelemetry-ext-system-metrics/setup.cfg b/ext/opentelemetry-ext-system-metrics/setup.cfg new file mode 100644 index 00000000000..ce9738529c8 --- /dev/null +++ b/ext/opentelemetry-ext-system-metrics/setup.cfg @@ -0,0 +1,51 @@ +# 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-system-metrics +description = OpenTelemetry System Metrics Instrumentation +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-system-metrics +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 = + opentelemetry-api == 0.7.dev0 + psutil + +[options.extras_require] +test = + opentelemetry-test == 0.7.dev0 + +[options.packages.find] +where = src diff --git a/ext/opentelemetry-ext-system-metrics/setup.py b/ext/opentelemetry-ext-system-metrics/setup.py new file mode 100644 index 00000000000..370399094dd --- /dev/null +++ b/ext/opentelemetry-ext-system-metrics/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", "system_metrics", "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-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py new file mode 100644 index 00000000000..c8606c8eb9c --- /dev/null +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py @@ -0,0 +1,165 @@ +# 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. +""" +Instrument to report system (CPU, memory, network) and +process (CPU, memory, garbage collection) metrics. + +Usage +----- + +.. code:: python + + from opentelemetry.ext.system_metrics import SystemMetrics + from opentelemetry.sdk.metrics.export import ConsoleMetricsExporter + from opentelemetry.sdk.metrics.export.controller import PushController + + exporter = ConsoleMetricsExporter() + SystemMetrics(exporter) + + # metrics are collected asynchrnously + input("...") + +API +--- +""" + +import gc +import os +import typing + +import psutil + +from opentelemetry import metrics +from opentelemetry.sdk.metrics.export import MetricsExporter +from opentelemetry.sdk.metrics.export.controller import PushController + +_DEFAULT_INTERVAL = 30 + + +class SystemMetrics: + def __init__( + self, + exporter: MetricsExporter, + interval: int = _DEFAULT_INTERVAL, + labels: typing.Optional[typing.Dict[str, str]] = None, + ): + labels = {} if labels is None else labels + self.meter = metrics.get_meter(__name__) + self.controller = PushController( + meter=self.meter, exporter=exporter, interval=interval + ) + self._proc = psutil.Process(os.getpid()) + self._labels = labels + + self.meter.register_observer( + callback=self._get_system_memory, + name="system.mem", + description="System memory", + unit="bytes", + value_type=int, + label_keys=self._labels.keys(), + ) + + self.meter.register_observer( + callback=self._get_system_cpu, + name="system.cpu", + description="System CPU", + unit="seconds", + value_type=float, + label_keys=self._labels.keys(), + ) + + self.meter.register_observer( + callback=self._get_network_bytes, + name="system.net.bytes", + description="System network bytes", + unit="bytes", + value_type=int, + label_keys=self._labels.keys(), + ) + + self.meter.register_observer( + callback=self._get_runtime_memory, + name="runtime.python.mem", + description="Runtime memory", + unit="bytes", + value_type=int, + label_keys=self._labels.keys(), + ) + + self.meter.register_observer( + callback=self._get_runtime_gc_count, + name="runtime.python.gc.count", + description="Runtime: gc objects", + unit="objects", + value_type=int, + label_keys=self._labels.keys(), + ) + + def _get_system_memory(self, observer: metrics.Observer) -> None: + """Observer callback for memory available + Args: + observer: the observer to update + """ + system_memory = psutil.virtual_memory() + for key, value in system_memory._asdict().items(): + if not isinstance(value, int): + continue + labels = {"type": key} + observer.observe(value, labels) + + def _get_system_cpu(self, observer: metrics.Observer) -> None: + """Observer callback for system cpu + Args: + observer: the observer to update + """ + cpu_times = psutil.cpu_times() + for key, value in cpu_times._asdict().items(): + labels = {"type": key} + observer.observe(value, labels) + + def _get_network_bytes(self, observer: metrics.Observer) -> None: + """Observer callback for network bytes + Args: + observer: the observer to update + """ + net_io = psutil.net_io_counters() + _metrics = [ + "bytes_recv", + "bytes_sent", + ] + for metric in _metrics: + labels = {"type": metric} + observer.observe(getattr(net_io, metric), labels) + + def _get_runtime_memory(self, observer: metrics.Observer) -> None: + """Observer callback for runtime memory + Args: + observer: the observer to update + """ + proc_memory = self._proc.memory_info() + for key, value in proc_memory._asdict().items(): + labels = {"type": key} + observer.observe(value, labels) + + def _get_runtime_gc_count(self, observer: metrics.Observer) -> None: + """Observer callback for garbage collection + + Args: + observer: the observer to update + """ + gc_count = gc.get_count() + for index, count in enumerate(gc_count): + labels = {"count": str(index)} + observer.observe(count, labels) diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py new file mode 100644 index 00000000000..86c61362ab5 --- /dev/null +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/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.7.dev0" diff --git a/ext/opentelemetry-ext-system-metrics/tests/__init__.py b/ext/opentelemetry-ext-system-metrics/tests/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py new file mode 100644 index 00000000000..0786eb8c70f --- /dev/null +++ b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py @@ -0,0 +1,212 @@ +# 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 collections import namedtuple +from unittest import mock + +from opentelemetry import metrics +from opentelemetry.ext.system_metrics import SystemMetrics +from opentelemetry.sdk.metrics import Observer +from opentelemetry.test.test_base import TestBase + + +class TestSystemMetrics(TestBase): + def test_system_metrics_constructor(self): + # ensure the observers have been registered + meter = metrics.get_meter(__name__) + with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: + mock_get_meter.return_value = meter + SystemMetrics(self.memory_metrics_exporter) + self.assertEqual(len(meter.observers), 5) + + @mock.patch("psutil.cpu_times") + def test_system_cpu(self, mock_cpu_times): + CPUTimes = namedtuple("CPUTimes", ["user", "nice", "system", "idle"]) + mock_cpu_times.return_value = CPUTimes( + user=332277.48, nice=0.0, system=309836.43, idle=6724698.94 + ) + + meter = self.meter_provider.get_meter(__name__) + with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: + mock_get_meter.return_value = meter + system_metrics = SystemMetrics(self.memory_metrics_exporter) + # pylint: disable=protected-access + observer = Observer( + None, "test-name", "test-desc", "test-unit", float, meter, + ) + system_metrics._get_system_cpu(observer) + self.assertEqual( + observer.aggregators[(("type", "user"),)].current, 332277.48 + ) + self.assertEqual( + observer.aggregators[(("type", "nice"),)].current, 0.0 + ) + self.assertEqual( + observer.aggregators[(("type", "system"),)].current, 309836.43 + ) + self.assertEqual( + observer.aggregators[(("type", "idle"),)].current, 6724698.94 + ) + + @mock.patch("psutil.virtual_memory") + def test_system_memory(self, mock_virtual_memory): + VirtualMemory = namedtuple( + "VirtualMemory", + [ + "total", + "available", + "percent", + "used", + "free", + "active", + "inactive", + "wired", + ], + ) + mock_virtual_memory.return_value = VirtualMemory( + total=17179869184, + available=5520928768, + percent=67.9, + used=10263990272, + free=266964992, + active=5282459648, + inactive=5148700672, + wired=4981530624, + ) + + meter = self.meter_provider.get_meter(__name__) + with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: + mock_get_meter.return_value = meter + system_metrics = SystemMetrics(self.memory_metrics_exporter) + # pylint: disable=protected-access + observer = Observer( + None, "test-name", "test-desc", "test-unit", int, meter, + ) + system_metrics._get_system_memory(observer) + self.assertEqual( + observer.aggregators[(("type", "total"),)].current, 17179869184 + ) + self.assertEqual( + observer.aggregators[(("type", "available"),)].current, + 5520928768, + ) + self.assertEqual( + observer.aggregators[(("type", "used"),)].current, 10263990272 + ) + self.assertEqual( + observer.aggregators[(("type", "free"),)].current, 266964992 + ) + self.assertEqual( + observer.aggregators[(("type", "active"),)].current, 5282459648 + ) + self.assertEqual( + observer.aggregators[(("type", "inactive"),)].current, + 5148700672, + ) + self.assertEqual( + observer.aggregators[(("type", "wired"),)].current, 4981530624 + ) + self.assertNotIn((("type", "percent"),), observer.aggregators) + + @mock.patch("psutil.net_io_counters") + def test_network_bytes(self, mock_net_io_counters): + NetworkIO = namedtuple( + "NetworkIO", + ["bytes_sent", "bytes_recv", "packets_recv", "packets_sent"], + ) + mock_net_io_counters.return_value = NetworkIO( + bytes_sent=23920188416, + bytes_recv=46798894080, + packets_sent=53127118, + packets_recv=53205738, + ) + + meter = self.meter_provider.get_meter(__name__) + with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: + mock_get_meter.return_value = meter + system_metrics = SystemMetrics(self.memory_metrics_exporter) + # pylint: disable=protected-access + observer = Observer( + None, "test-name", "test-desc", "test-unit", int, meter, + ) + system_metrics._get_network_bytes(observer) + self.assertEqual( + observer.aggregators[(("type", "bytes_recv"),)].current, + 46798894080, + ) + self.assertEqual( + observer.aggregators[(("type", "bytes_sent"),)].current, + 23920188416, + ) + + def test_runtime_memory(self): + meter = self.meter_provider.get_meter(__name__) + with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: + mock_get_meter.return_value = meter + system_metrics = SystemMetrics(self.memory_metrics_exporter) + + with mock.patch.object( + system_metrics._proc, # pylint: disable=protected-access + "memory_info", + ) as mock_runtime_memory: + RuntimeMemory = namedtuple( + "RuntimeMemory", ["rss", "vms", "pfaults", "pageins"], + ) + mock_runtime_memory.return_value = RuntimeMemory( + rss=9777152, vms=4385665024, pfaults=2631, pageins=49 + ) + observer = Observer( + None, "test-name", "test-desc", "test-unit", int, meter, + ) + # pylint: disable=protected-access + system_metrics._get_runtime_memory(observer) + self.assertEqual( + observer.aggregators[(("type", "rss"),)].current, 9777152, + ) + self.assertEqual( + observer.aggregators[(("type", "vms"),)].current, + 4385665024, + ) + self.assertEqual( + observer.aggregators[(("type", "pfaults"),)].current, 2631, + ) + self.assertEqual( + observer.aggregators[(("type", "pageins"),)].current, 49, + ) + + @mock.patch("gc.get_count") + def test_runtime_gc_count(self, mock_gc): + mock_gc.return_value = [ + 100, # gen0 + 50, # gen1 + 10, # gen2 + ] + meter = self.meter_provider.get_meter(__name__) + with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: + mock_get_meter.return_value = meter + system_metrics = SystemMetrics(self.memory_metrics_exporter) + observer = Observer( + None, "test-name", "test-desc", "test-unit", int, meter, + ) + # pylint: disable=protected-access + system_metrics._get_runtime_gc_count(observer) + self.assertEqual( + observer.aggregators[(("count", "0"),)].current, 100 + ) + self.assertEqual( + observer.aggregators[(("count", "1"),)].current, 50 + ) + self.assertEqual( + observer.aggregators[(("count", "2"),)].current, 10 + ) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/export/in_memory_metrics_exporter.py b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/export/in_memory_metrics_exporter.py new file mode 100644 index 00000000000..13ae93e3f04 --- /dev/null +++ b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/export/in_memory_metrics_exporter.py @@ -0,0 +1,49 @@ +# 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 threading +from typing import Sequence + +from . import MetricsExporter, MetricsExportResult, MetricRecord + + +class InMemoryMetricsExporter(MetricsExporter): + """ Implementation of `MetricsExporter` thta stores metrics in memory. + + This class can be used for testing purposes. It stores exported metrics + in a list in memory that can be retrieved using the + :func:`.get_exported_metrics` method. + """ + + def __init__(self): + self._exported_metrics = [] + self._stopped = False + self._lock = threading.Lock() + + def clear(self): + """Clear list of collected metrics.""" + with self._lock: + self._exported_metrics.clear() + + def export( + self, metric_records: Sequence[MetricRecord] + ) -> "MetricsExportResult": + with self._lock: + self._exported_metrics.extend(metric_records) + return MetricsExportResult.SUCCESS + + def get_exported_metrics(self): + """Get list of collected metrics.""" + with self._lock: + return tuple(self._exported_metrics) diff --git a/tests/util/src/opentelemetry/test/test_base.py b/tests/util/src/opentelemetry/test/test_base.py index ca015ff0110..0744d0466d0 100644 --- a/tests/util/src/opentelemetry/test/test_base.py +++ b/tests/util/src/opentelemetry/test/test_base.py @@ -16,7 +16,13 @@ import unittest from contextlib import contextmanager +from opentelemetry import metrics as metrics_api from opentelemetry import trace as trace_api +from opentelemetry.sdk.metrics import MeterProvider +from opentelemetry.sdk.metrics import export as metrics_export +from opentelemetry.sdk.metrics.export.in_memory_metrics_exporter import ( + InMemoryMetricsExporter, +) from opentelemetry.sdk.trace import TracerProvider, export from opentelemetry.sdk.trace.export.in_memory_span_exporter import ( InMemorySpanExporter, @@ -26,14 +32,19 @@ class TestBase(unittest.TestCase): @classmethod def setUpClass(cls): - cls.original_provider = trace_api.get_tracer_provider() + cls.original_tracer_provider = trace_api.get_tracer_provider() result = cls.create_tracer_provider() cls.tracer_provider, cls.memory_exporter = result trace_api.set_tracer_provider(cls.tracer_provider) + cls.original_meter_provider = metrics_api.get_meter_provider() + result = cls.create_meter_provider() + cls.meter_provider, cls.memory_metrics_exporter = result + metrics_api.set_meter_provider(cls.meter_provider) @classmethod def tearDownClass(cls): - trace_api.set_tracer_provider(cls.original_provider) + trace_api.set_tracer_provider(cls.original_tracer_provider) + metrics_api.set_meter_provider(cls.original_meter_provider) def setUp(self): self.memory_exporter.clear() @@ -62,6 +73,12 @@ def create_tracer_provider(**kwargs): return tracer_provider, memory_exporter + @staticmethod + def create_meter_provider(**kwargs): + meter_provider = MeterProvider(**kwargs) + memory_exporter = InMemoryMetricsExporter() + return meter_provider, memory_exporter + @staticmethod @contextmanager def disable_logging(highest_level=logging.CRITICAL): diff --git a/tox.ini b/tox.ini index 1570df787c6..19a4f1e2bdc 100644 --- a/tox.ini +++ b/tox.ini @@ -95,6 +95,10 @@ envlist = py3{4,5,6,7,8}-test-ext-redis pypy3-test-ext-redis + ; opentelemetry-ext-system-metrics + py3{4,5,6,7,8}-test-ext-system-metrics + pypy3-test-ext-system-metrics + ; Coverage is temporarily disabled for pypy3 due to the pytest bug. ; pypy3-coverage @@ -142,6 +146,7 @@ changedir = test-opentracing-shim: ext/opentelemetry-ext-opentracing-shim/tests test-ext-sqlalchemy: ext/opentelemetry-ext-sqlalchemy/tests test-ext-redis: ext/opentelemetry-ext-redis/tests + test-ext-system-metrics: ext/opentelemetry-ext-system-metrics/tests commands_pre = ; Install without -e to test the actual installation @@ -207,6 +212,9 @@ commands_pre = sqlalchemy: pip install {toxinidir}/opentelemetry-auto-instrumentation sqlalchemy: pip install {toxinidir}/ext/opentelemetry-ext-sqlalchemy + system-metrics: pip install {toxinidir}/opentelemetry-auto-instrumentation + system-metrics: pip install {toxinidir}/ext/opentelemetry-ext-system-metrics[test] + ; In order to get a healthy coverage report, ; we have to install packages in editable mode. coverage: python {toxinidir}/scripts/eachdist.py install --editable @@ -303,7 +311,8 @@ commands_pre = -e {toxinidir}/ext/opentelemetry-ext-pymongo \ -e {toxinidir}/ext/opentelemetry-ext-pymysql \ -e {toxinidir}/ext/opentelemetry-ext-sqlalchemy \ - -e {toxinidir}/ext/opentelemetry-ext-redis + -e {toxinidir}/ext/opentelemetry-ext-redis \ + -e {toxinidir}/ext/opentelemetry-ext-system-metrics docker-compose up -d python check_availability.py commands = From 39af1c330d81a3e69172caf4e4c3784cbce70f1e Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Wed, 6 May 2020 14:47:51 -0700 Subject: [PATCH 02/16] fix lint and disable test for pypy --- ext/opentelemetry-ext-system-metrics/setup.cfg | 2 +- .../sdk/metrics/export/in_memory_metrics_exporter.py | 2 +- tox.ini | 3 ++- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/setup.cfg b/ext/opentelemetry-ext-system-metrics/setup.cfg index ce9738529c8..726583e7e05 100644 --- a/ext/opentelemetry-ext-system-metrics/setup.cfg +++ b/ext/opentelemetry-ext-system-metrics/setup.cfg @@ -41,11 +41,11 @@ package_dir= packages=find_namespace: install_requires = opentelemetry-api == 0.7.dev0 - psutil [options.extras_require] test = opentelemetry-test == 0.7.dev0 + psutil ~= 5.7.0 [options.packages.find] where = src diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/export/in_memory_metrics_exporter.py b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/export/in_memory_metrics_exporter.py index 13ae93e3f04..a97799f3bbc 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/export/in_memory_metrics_exporter.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/export/in_memory_metrics_exporter.py @@ -15,7 +15,7 @@ import threading from typing import Sequence -from . import MetricsExporter, MetricsExportResult, MetricRecord +from . import MetricRecord, MetricsExporter, MetricsExportResult class InMemoryMetricsExporter(MetricsExporter): diff --git a/tox.ini b/tox.ini index 19a4f1e2bdc..e27acb71dcb 100644 --- a/tox.ini +++ b/tox.ini @@ -97,7 +97,8 @@ envlist = ; opentelemetry-ext-system-metrics py3{4,5,6,7,8}-test-ext-system-metrics - pypy3-test-ext-system-metrics + ; ext-system-metrics intentionally excluded from pypy3 + ; known limitation: gc.get_count won't work under pypy ; Coverage is temporarily disabled for pypy3 due to the pytest bug. ; pypy3-coverage From 1bc093d79e804d0d1a1835e5776d671046eae199 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 7 May 2020 08:53:29 -0700 Subject: [PATCH 03/16] use labels passed into constructor + feedback from review --- .../CHANGELOG.md | 2 +- .../README.rst | 1 + .../ext/system_metrics/__init__.py | 39 +++++++++++++------ .../util/src/opentelemetry/test/test_base.py | 1 - 4 files changed, 30 insertions(+), 13 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/CHANGELOG.md b/ext/opentelemetry-ext-system-metrics/CHANGELOG.md index 33144da9132..2f3c3ab3821 100644 --- a/ext/opentelemetry-ext-system-metrics/CHANGELOG.md +++ b/ext/opentelemetry-ext-system-metrics/CHANGELOG.md @@ -2,4 +2,4 @@ ## Unreleased -- Initial release \ No newline at end of file +- Initial release (https://github.com/open-telemetry/opentelemetry-python/pull/652) diff --git a/ext/opentelemetry-ext-system-metrics/README.rst b/ext/opentelemetry-ext-system-metrics/README.rst index e5a1e57c065..796f3f13f26 100644 --- a/ext/opentelemetry-ext-system-metrics/README.rst +++ b/ext/opentelemetry-ext-system-metrics/README.rst @@ -19,5 +19,6 @@ Installation References ---------- +* `OpenTelemetry System Metrics Instrumentation `_ * `OpenTelemetry Project `_ diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py index c8606c8eb9c..f2467531ee0 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py @@ -22,7 +22,6 @@ from opentelemetry.ext.system_metrics import SystemMetrics from opentelemetry.sdk.metrics.export import ConsoleMetricsExporter - from opentelemetry.sdk.metrics.export.controller import PushController exporter = ConsoleMetricsExporter() SystemMetrics(exporter) @@ -61,6 +60,18 @@ def __init__( ) self._proc = psutil.Process(os.getpid()) self._labels = labels + self._system_memory_labels = {} + self._system_cpu_labels = {} + self._network_bytes_labels = {} + self._runtime_memory_labels = {} + self._runtime_gc_labels = {} + # create the label set for each observer once + for key, value in self._labels.items(): + self._system_memory_labels[key] = value + self._system_cpu_labels[key] = value + self._network_bytes_labels[key] = value + self._runtime_memory_labels[key] = value + self._runtime_gc_labels[key] = value self.meter.register_observer( callback=self._get_system_memory, @@ -109,6 +120,7 @@ def __init__( def _get_system_memory(self, observer: metrics.Observer) -> None: """Observer callback for memory available + Args: observer: the observer to update """ @@ -116,21 +128,23 @@ def _get_system_memory(self, observer: metrics.Observer) -> None: for key, value in system_memory._asdict().items(): if not isinstance(value, int): continue - labels = {"type": key} - observer.observe(value, labels) + self._system_memory_labels["type"] = key + observer.observe(value, self._system_memory_labels) def _get_system_cpu(self, observer: metrics.Observer) -> None: """Observer callback for system cpu + Args: observer: the observer to update """ cpu_times = psutil.cpu_times() for key, value in cpu_times._asdict().items(): - labels = {"type": key} - observer.observe(value, labels) + self._system_cpu_labels["type"] = key + observer.observe(value, self._system_cpu_labels) def _get_network_bytes(self, observer: metrics.Observer) -> None: """Observer callback for network bytes + Args: observer: the observer to update """ @@ -140,18 +154,21 @@ def _get_network_bytes(self, observer: metrics.Observer) -> None: "bytes_sent", ] for metric in _metrics: - labels = {"type": metric} - observer.observe(getattr(net_io, metric), labels) + self._network_bytes_labels["type"] = metric + observer.observe( + getattr(net_io, metric), self._network_bytes_labels + ) def _get_runtime_memory(self, observer: metrics.Observer) -> None: """Observer callback for runtime memory + Args: observer: the observer to update """ proc_memory = self._proc.memory_info() for key, value in proc_memory._asdict().items(): - labels = {"type": key} - observer.observe(value, labels) + self._runtime_memory_labels["type"] = key + observer.observe(value, self._runtime_memory_labels) def _get_runtime_gc_count(self, observer: metrics.Observer) -> None: """Observer callback for garbage collection @@ -161,5 +178,5 @@ def _get_runtime_gc_count(self, observer: metrics.Observer) -> None: """ gc_count = gc.get_count() for index, count in enumerate(gc_count): - labels = {"count": str(index)} - observer.observe(count, labels) + self._runtime_gc_labels["count"] = str(index) + observer.observe(count, self._runtime_gc_labels) diff --git a/tests/util/src/opentelemetry/test/test_base.py b/tests/util/src/opentelemetry/test/test_base.py index 0744d0466d0..0e24487363a 100644 --- a/tests/util/src/opentelemetry/test/test_base.py +++ b/tests/util/src/opentelemetry/test/test_base.py @@ -19,7 +19,6 @@ from opentelemetry import metrics as metrics_api from opentelemetry import trace as trace_api from opentelemetry.sdk.metrics import MeterProvider -from opentelemetry.sdk.metrics import export as metrics_export from opentelemetry.sdk.metrics.export.in_memory_metrics_exporter import ( InMemoryMetricsExporter, ) From ccc56d6b7f656b3ed1197ee7da43536697e10ae8 Mon Sep 17 00:00:00 2001 From: alrex Date: Thu, 7 May 2020 08:56:39 -0700 Subject: [PATCH 04/16] Update ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Mauricio Vásquez --- .../src/opentelemetry/ext/system_metrics/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py index f2467531ee0..db3b544171a 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py @@ -26,7 +26,7 @@ exporter = ConsoleMetricsExporter() SystemMetrics(exporter) - # metrics are collected asynchrnously + # metrics are collected asynchronously input("...") API From e04a472265347e018da6bfea5e8a8a4adf82c02e Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 7 May 2020 08:55:18 -0700 Subject: [PATCH 05/16] adding doc entry --- docs/ext/system_metrics/system_metrics.rst | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/ext/system_metrics/system_metrics.rst diff --git a/docs/ext/system_metrics/system_metrics.rst b/docs/ext/system_metrics/system_metrics.rst new file mode 100644 index 00000000000..db6f9da70f4 --- /dev/null +++ b/docs/ext/system_metrics/system_metrics.rst @@ -0,0 +1,7 @@ +OpenTelemetry System Metrics Instrumentation +============================================ + +.. automodule:: opentelemetry.ext.system_metrics + :members: + :undoc-members: + :show-inheritance: From e79f0e9d2e23b2671a9407adb9417b259f4f28c5 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 19 May 2020 12:56:21 -0700 Subject: [PATCH 06/16] bump version number --- ext/opentelemetry-ext-system-metrics/setup.cfg | 4 ++-- .../src/opentelemetry/ext/system_metrics/version.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/setup.cfg b/ext/opentelemetry-ext-system-metrics/setup.cfg index 726583e7e05..7e163026a5c 100644 --- a/ext/opentelemetry-ext-system-metrics/setup.cfg +++ b/ext/opentelemetry-ext-system-metrics/setup.cfg @@ -40,11 +40,11 @@ package_dir= =src packages=find_namespace: install_requires = - opentelemetry-api == 0.7.dev0 + opentelemetry-api == 0.8.dev0 [options.extras_require] test = - opentelemetry-test == 0.7.dev0 + opentelemetry-test == 0.8.dev0 psutil ~= 5.7.0 [options.packages.find] diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py index 86c61362ab5..bcf6a357770 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "0.7.dev0" +__version__ = "0.8.dev0" From 35151b0deb9fec6c9494011e8f58d33bfaa4cdee Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 19 May 2020 13:31:18 -0700 Subject: [PATCH 07/16] fix docs --- docs-requirements.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs-requirements.txt b/docs-requirements.txt index 55b647402f6..3ef63c86f83 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -4,7 +4,7 @@ sphinx-autodoc-typehints~=1.10.2 # Required by ext packages ddtrace>=0.34.0 -aiohttp ~= 3.0 +aiohttp~= 3.0 Deprecated>=1.2.6 django>=2.2 PyMySQL~=0.9.3 @@ -17,4 +17,5 @@ pymongo~=3.1 redis>=2.6 sqlalchemy>=1.0 thrift>=0.10.0 -wrapt >=1.0.0,<2.0.0 +wrapt>=1.0.0,<2.0.0 +psutil~=5.7.0 From 048856f016a787a60bb3092a4325ad598dc1930e Mon Sep 17 00:00:00 2001 From: alrex Date: Tue, 26 May 2020 09:11:27 -0700 Subject: [PATCH 08/16] Apply suggestions from code review Co-authored-by: Diego Hurtado --- .../src/opentelemetry/ext/system_metrics/__init__.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py index db3b544171a..8d8e8a0b72a 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py @@ -43,23 +43,21 @@ from opentelemetry.sdk.metrics.export import MetricsExporter from opentelemetry.sdk.metrics.export.controller import PushController -_DEFAULT_INTERVAL = 30 class SystemMetrics: def __init__( self, exporter: MetricsExporter, - interval: int = _DEFAULT_INTERVAL, + interval: int = 30, labels: typing.Optional[typing.Dict[str, str]] = None, ): - labels = {} if labels is None else labels + self._labels = {} if labels is None else labels self.meter = metrics.get_meter(__name__) self.controller = PushController( meter=self.meter, exporter=exporter, interval=interval ) self._proc = psutil.Process(os.getpid()) - self._labels = labels self._system_memory_labels = {} self._system_cpu_labels = {} self._network_bytes_labels = {} From e7d6a251dd79109a9a282c682cd6a358a23e4338 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 26 May 2020 15:32:00 -0700 Subject: [PATCH 09/16] move psutil requirement to install_requires --- ext/opentelemetry-ext-system-metrics/setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ext/opentelemetry-ext-system-metrics/setup.cfg b/ext/opentelemetry-ext-system-metrics/setup.cfg index 7e163026a5c..b55d723bff9 100644 --- a/ext/opentelemetry-ext-system-metrics/setup.cfg +++ b/ext/opentelemetry-ext-system-metrics/setup.cfg @@ -41,11 +41,11 @@ package_dir= packages=find_namespace: install_requires = opentelemetry-api == 0.8.dev0 + psutil ~= 5.7.0 [options.extras_require] test = opentelemetry-test == 0.8.dev0 - psutil ~= 5.7.0 [options.packages.find] where = src From 58b0e298f81b6d9b08d52fc1f6f6faba1de017c2 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 26 May 2020 15:32:11 -0700 Subject: [PATCH 10/16] test observer names --- .../tests/test_system_metrics.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py index 0786eb8c70f..7589548dabd 100644 --- a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py +++ b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py @@ -29,6 +29,16 @@ def test_system_metrics_constructor(self): mock_get_meter.return_value = meter SystemMetrics(self.memory_metrics_exporter) self.assertEqual(len(meter.observers), 5) + observer_names = [ + "system.mem", + "system.cpu", + "system.net.bytes", + "runtime.python.mem", + "runtime.python.gc.count", + ] + for observer in meter.observers: + self.assertIn(observer.name, observer_names) + observer_names.remove(observer.name) @mock.patch("psutil.cpu_times") def test_system_cpu(self, mock_cpu_times): From 775baa954ece6e1e4ebdb101a3b132c2c6c703cb Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 26 May 2020 16:13:20 -0700 Subject: [PATCH 11/16] only report metrics available on all platforms --- .../ext/system_metrics/__init__.py | 44 +++++++++++++------ .../tests/test_system_metrics.py | 20 --------- 2 files changed, 31 insertions(+), 33 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py index 8d8e8a0b72a..4ff37e992b5 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py @@ -44,7 +44,6 @@ from opentelemetry.sdk.metrics.export.controller import PushController - class SystemMetrics: def __init__( self, @@ -123,11 +122,17 @@ def _get_system_memory(self, observer: metrics.Observer) -> None: observer: the observer to update """ system_memory = psutil.virtual_memory() - for key, value in system_memory._asdict().items(): - if not isinstance(value, int): - continue - self._system_memory_labels["type"] = key - observer.observe(value, self._system_memory_labels) + _metrics = [ + "total", + "available", + "used", + "free", + ] + for metric in _metrics: + self._system_memory_labels["type"] = metric + observer.observe( + getattr(system_memory, metric), self._system_memory_labels + ) def _get_system_cpu(self, observer: metrics.Observer) -> None: """Observer callback for system cpu @@ -135,10 +140,17 @@ def _get_system_cpu(self, observer: metrics.Observer) -> None: Args: observer: the observer to update """ + _metrics = [ + "user", + "system", + "idle", + ] cpu_times = psutil.cpu_times() - for key, value in cpu_times._asdict().items(): - self._system_cpu_labels["type"] = key - observer.observe(value, self._system_cpu_labels) + for metric in _metrics: + self._system_cpu_labels["type"] = metric + observer.observe( + getattr(cpu_times, metric), self._system_cpu_labels + ) def _get_network_bytes(self, observer: metrics.Observer) -> None: """Observer callback for network bytes @@ -146,11 +158,11 @@ def _get_network_bytes(self, observer: metrics.Observer) -> None: Args: observer: the observer to update """ - net_io = psutil.net_io_counters() _metrics = [ "bytes_recv", "bytes_sent", ] + net_io = psutil.net_io_counters() for metric in _metrics: self._network_bytes_labels["type"] = metric observer.observe( @@ -163,10 +175,16 @@ def _get_runtime_memory(self, observer: metrics.Observer) -> None: Args: observer: the observer to update """ + _metrics = [ + "rss", + "vms", + ] proc_memory = self._proc.memory_info() - for key, value in proc_memory._asdict().items(): - self._runtime_memory_labels["type"] = key - observer.observe(value, self._runtime_memory_labels) + for metric in _metrics: + self._runtime_memory_labels["type"] = metric + observer.observe( + getattr(proc_memory, metric), self._runtime_memory_labels + ) def _get_runtime_gc_count(self, observer: metrics.Observer) -> None: """Observer callback for garbage collection diff --git a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py index 7589548dabd..77256b014cf 100644 --- a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py +++ b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py @@ -59,9 +59,6 @@ def test_system_cpu(self, mock_cpu_times): self.assertEqual( observer.aggregators[(("type", "user"),)].current, 332277.48 ) - self.assertEqual( - observer.aggregators[(("type", "nice"),)].current, 0.0 - ) self.assertEqual( observer.aggregators[(("type", "system"),)].current, 309836.43 ) @@ -117,17 +114,6 @@ def test_system_memory(self, mock_virtual_memory): self.assertEqual( observer.aggregators[(("type", "free"),)].current, 266964992 ) - self.assertEqual( - observer.aggregators[(("type", "active"),)].current, 5282459648 - ) - self.assertEqual( - observer.aggregators[(("type", "inactive"),)].current, - 5148700672, - ) - self.assertEqual( - observer.aggregators[(("type", "wired"),)].current, 4981530624 - ) - self.assertNotIn((("type", "percent"),), observer.aggregators) @mock.patch("psutil.net_io_counters") def test_network_bytes(self, mock_net_io_counters): @@ -188,12 +174,6 @@ def test_runtime_memory(self): observer.aggregators[(("type", "vms"),)].current, 4385665024, ) - self.assertEqual( - observer.aggregators[(("type", "pfaults"),)].current, 2631, - ) - self.assertEqual( - observer.aggregators[(("type", "pageins"),)].current, 49, - ) @mock.patch("gc.get_count") def test_runtime_gc_count(self, mock_gc): From 0c4b5e455150735e8eabd26c201b3d478f4772f2 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Wed, 27 May 2020 11:23:14 -0700 Subject: [PATCH 12/16] refactor test to use in-memory exporter --- .../tests/test_system_metrics.py | 140 +++++++----------- 1 file changed, 53 insertions(+), 87 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py index 77256b014cf..85f505f5db4 100644 --- a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py +++ b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py @@ -22,6 +22,10 @@ class TestSystemMetrics(TestBase): + def setUp(self): + super().setUp() + self.memory_metrics_exporter.clear() + def test_system_metrics_constructor(self): # ensure the observers have been registered meter = metrics.get_meter(__name__) @@ -40,6 +44,25 @@ def test_system_metrics_constructor(self): self.assertIn(observer.name, observer_names) observer_names.remove(observer.name) + def _assert_metrics(self, system_metrics, expected): + system_metrics.controller.tick() + assertions = 0 + for metric in self.memory_metrics_exporter._exported_metrics: + if metric.labels in expected: + self.assertEqual( + metric.aggregator.checkpoint.last, expected[metric.labels], + ) + assertions += 1 + self.assertEqual(len(expected), assertions) + + def _test_metrics(self, expected): + meter = self.meter_provider.get_meter(__name__) + + with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: + mock_get_meter.return_value = meter + system_metrics = SystemMetrics(self.memory_metrics_exporter) + self._assert_metrics(system_metrics, expected) + @mock.patch("psutil.cpu_times") def test_system_cpu(self, mock_cpu_times): CPUTimes = namedtuple("CPUTimes", ["user", "nice", "system", "idle"]) @@ -47,24 +70,12 @@ def test_system_cpu(self, mock_cpu_times): user=332277.48, nice=0.0, system=309836.43, idle=6724698.94 ) - meter = self.meter_provider.get_meter(__name__) - with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: - mock_get_meter.return_value = meter - system_metrics = SystemMetrics(self.memory_metrics_exporter) - # pylint: disable=protected-access - observer = Observer( - None, "test-name", "test-desc", "test-unit", float, meter, - ) - system_metrics._get_system_cpu(observer) - self.assertEqual( - observer.aggregators[(("type", "user"),)].current, 332277.48 - ) - self.assertEqual( - observer.aggregators[(("type", "system"),)].current, 309836.43 - ) - self.assertEqual( - observer.aggregators[(("type", "idle"),)].current, 6724698.94 - ) + expected = { + (("type", "user"),): 332277.48, + (("type", "system"),): 309836.43, + (("type", "idle"),): 6724698.94, + } + self._test_metrics(expected) @mock.patch("psutil.virtual_memory") def test_system_memory(self, mock_virtual_memory): @@ -92,28 +103,13 @@ def test_system_memory(self, mock_virtual_memory): wired=4981530624, ) - meter = self.meter_provider.get_meter(__name__) - with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: - mock_get_meter.return_value = meter - system_metrics = SystemMetrics(self.memory_metrics_exporter) - # pylint: disable=protected-access - observer = Observer( - None, "test-name", "test-desc", "test-unit", int, meter, - ) - system_metrics._get_system_memory(observer) - self.assertEqual( - observer.aggregators[(("type", "total"),)].current, 17179869184 - ) - self.assertEqual( - observer.aggregators[(("type", "available"),)].current, - 5520928768, - ) - self.assertEqual( - observer.aggregators[(("type", "used"),)].current, 10263990272 - ) - self.assertEqual( - observer.aggregators[(("type", "free"),)].current, 266964992 - ) + expected = { + (("type", "total"),): 17179869184, + (("type", "used"),): 10263990272, + (("type", "available"),): 5520928768, + (("type", "free"),): 266964992, + } + self._test_metrics(expected) @mock.patch("psutil.net_io_counters") def test_network_bytes(self, mock_net_io_counters): @@ -128,23 +124,11 @@ def test_network_bytes(self, mock_net_io_counters): packets_recv=53205738, ) - meter = self.meter_provider.get_meter(__name__) - with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: - mock_get_meter.return_value = meter - system_metrics = SystemMetrics(self.memory_metrics_exporter) - # pylint: disable=protected-access - observer = Observer( - None, "test-name", "test-desc", "test-unit", int, meter, - ) - system_metrics._get_network_bytes(observer) - self.assertEqual( - observer.aggregators[(("type", "bytes_recv"),)].current, - 46798894080, - ) - self.assertEqual( - observer.aggregators[(("type", "bytes_sent"),)].current, - 23920188416, - ) + expected = { + (("type", "bytes_recv"),): 46798894080, + (("type", "bytes_sent"),): 23920188416, + } + self._test_metrics(expected) def test_runtime_memory(self): meter = self.meter_provider.get_meter(__name__) @@ -162,18 +146,11 @@ def test_runtime_memory(self): mock_runtime_memory.return_value = RuntimeMemory( rss=9777152, vms=4385665024, pfaults=2631, pageins=49 ) - observer = Observer( - None, "test-name", "test-desc", "test-unit", int, meter, - ) - # pylint: disable=protected-access - system_metrics._get_runtime_memory(observer) - self.assertEqual( - observer.aggregators[(("type", "rss"),)].current, 9777152, - ) - self.assertEqual( - observer.aggregators[(("type", "vms"),)].current, - 4385665024, - ) + expected = { + (("type", "rss"),): 9777152, + (("type", "vms"),): 4385665024, + } + self._assert_metrics(system_metrics, expected) @mock.patch("gc.get_count") def test_runtime_gc_count(self, mock_gc): @@ -182,21 +159,10 @@ def test_runtime_gc_count(self, mock_gc): 50, # gen1 10, # gen2 ] - meter = self.meter_provider.get_meter(__name__) - with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: - mock_get_meter.return_value = meter - system_metrics = SystemMetrics(self.memory_metrics_exporter) - observer = Observer( - None, "test-name", "test-desc", "test-unit", int, meter, - ) - # pylint: disable=protected-access - system_metrics._get_runtime_gc_count(observer) - self.assertEqual( - observer.aggregators[(("count", "0"),)].current, 100 - ) - self.assertEqual( - observer.aggregators[(("count", "1"),)].current, 50 - ) - self.assertEqual( - observer.aggregators[(("count", "2"),)].current, 10 - ) + + expected = { + (("count", "0"),): 100, + (("count", "1"),): 50, + (("count", "2"),): 10, + } + self._test_metrics(expected) From b094635fc60e1e7adb5642a83707942582fd02b4 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Wed, 27 May 2020 11:47:06 -0700 Subject: [PATCH 13/16] support a config parameter to allow users to configure metrics they care about --- .../ext/system_metrics/__init__.py | 54 +++++++------------ 1 file changed, 20 insertions(+), 34 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py index 4ff37e992b5..7385e6d4e71 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py @@ -50,12 +50,22 @@ def __init__( exporter: MetricsExporter, interval: int = 30, labels: typing.Optional[typing.Dict[str, str]] = None, + config: typing.Optional[typing.Dict[str, typing.List[str]]] = None, ): self._labels = {} if labels is None else labels self.meter = metrics.get_meter(__name__) self.controller = PushController( meter=self.meter, exporter=exporter, interval=interval ) + if config is None: + self._config = { + "system_memory": ["total", "available", "used", "free"], + "system_cpu": ["user", "system", "idle"], + "network_bytes": ["bytes_recv", "bytes_sent"], + "runtime_memory": ["rss", "vms"], + } + else: + self._config = config self._proc = psutil.Process(os.getpid()) self._system_memory_labels = {} self._system_cpu_labels = {} @@ -76,7 +86,6 @@ def __init__( description="System memory", unit="bytes", value_type=int, - label_keys=self._labels.keys(), ) self.meter.register_observer( @@ -85,7 +94,6 @@ def __init__( description="System CPU", unit="seconds", value_type=float, - label_keys=self._labels.keys(), ) self.meter.register_observer( @@ -94,7 +102,6 @@ def __init__( description="System network bytes", unit="bytes", value_type=int, - label_keys=self._labels.keys(), ) self.meter.register_observer( @@ -103,7 +110,6 @@ def __init__( description="Runtime memory", unit="bytes", value_type=int, - label_keys=self._labels.keys(), ) self.meter.register_observer( @@ -112,7 +118,6 @@ def __init__( description="Runtime: gc objects", unit="objects", value_type=int, - label_keys=self._labels.keys(), ) def _get_system_memory(self, observer: metrics.Observer) -> None: @@ -122,13 +127,7 @@ def _get_system_memory(self, observer: metrics.Observer) -> None: observer: the observer to update """ system_memory = psutil.virtual_memory() - _metrics = [ - "total", - "available", - "used", - "free", - ] - for metric in _metrics: + for metric in self._config["system_memory"]: self._system_memory_labels["type"] = metric observer.observe( getattr(system_memory, metric), self._system_memory_labels @@ -140,16 +139,11 @@ def _get_system_cpu(self, observer: metrics.Observer) -> None: Args: observer: the observer to update """ - _metrics = [ - "user", - "system", - "idle", - ] cpu_times = psutil.cpu_times() - for metric in _metrics: - self._system_cpu_labels["type"] = metric + for _type in self._config["system_cpu"]: + self._system_cpu_labels["type"] = _type observer.observe( - getattr(cpu_times, metric), self._system_cpu_labels + getattr(cpu_times, _type), self._system_cpu_labels ) def _get_network_bytes(self, observer: metrics.Observer) -> None: @@ -158,15 +152,11 @@ def _get_network_bytes(self, observer: metrics.Observer) -> None: Args: observer: the observer to update """ - _metrics = [ - "bytes_recv", - "bytes_sent", - ] net_io = psutil.net_io_counters() - for metric in _metrics: - self._network_bytes_labels["type"] = metric + for _type in self._config["network_bytes"]: + self._network_bytes_labels["type"] = _type observer.observe( - getattr(net_io, metric), self._network_bytes_labels + getattr(net_io, _type), self._network_bytes_labels ) def _get_runtime_memory(self, observer: metrics.Observer) -> None: @@ -175,15 +165,11 @@ def _get_runtime_memory(self, observer: metrics.Observer) -> None: Args: observer: the observer to update """ - _metrics = [ - "rss", - "vms", - ] proc_memory = self._proc.memory_info() - for metric in _metrics: - self._runtime_memory_labels["type"] = metric + for _type in self._config["runtime_memory"]: + self._runtime_memory_labels["type"] = _type observer.observe( - getattr(proc_memory, metric), self._runtime_memory_labels + getattr(proc_memory, _type), self._runtime_memory_labels ) def _get_runtime_gc_count(self, observer: metrics.Observer) -> None: From 90565e580ad6c3d0ad630660eb64d52f729a3d54 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Wed, 27 May 2020 12:52:59 -0700 Subject: [PATCH 14/16] adding runtime cpu --- .../ext/system_metrics/__init__.py | 32 +++++++++- .../tests/test_system_metrics.py | 58 +++++++++++++++---- 2 files changed, 78 insertions(+), 12 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py index 7385e6d4e71..91e1df32d51 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py @@ -13,7 +13,14 @@ # limitations under the License. """ Instrument to report system (CPU, memory, network) and -process (CPU, memory, garbage collection) metrics. +process (CPU, memory, garbage collection) metrics. By default, the +following metrics are configured: + "system_memory": ["total", "available", "used", "free"], + "system_cpu": ["user", "system", "idle"], + "network_bytes": ["bytes_recv", "bytes_sent"], + "runtime_memory": ["rss", "vms"], + "runtime_cpu": ["user", "system"], + Usage ----- @@ -63,6 +70,7 @@ def __init__( "system_cpu": ["user", "system", "idle"], "network_bytes": ["bytes_recv", "bytes_sent"], "runtime_memory": ["rss", "vms"], + "runtime_cpu": ["user", "system"], } else: self._config = config @@ -71,6 +79,7 @@ def __init__( self._system_cpu_labels = {} self._network_bytes_labels = {} self._runtime_memory_labels = {} + self._runtime_cpu_labels = {} self._runtime_gc_labels = {} # create the label set for each observer once for key, value in self._labels.items(): @@ -112,6 +121,14 @@ def __init__( value_type=int, ) + self.meter.register_observer( + callback=self._get_runtime_cpu, + name="runtime.python.cpu", + description="Runtime CPU", + unit="seconds", + value_type=float, + ) + self.meter.register_observer( callback=self._get_runtime_gc_count, name="runtime.python.gc.count", @@ -172,6 +189,19 @@ def _get_runtime_memory(self, observer: metrics.Observer) -> None: getattr(proc_memory, _type), self._runtime_memory_labels ) + def _get_runtime_cpu(self, observer: metrics.Observer) -> None: + """Observer callback for runtime CPU + + Args: + observer: the observer to update + """ + proc_cpu = self._proc.cpu_times() + for _type in self._config["runtime_cpu"]: + self._runtime_cpu_labels["type"] = _type + observer.observe( + getattr(proc_cpu, _type), self._runtime_cpu_labels + ) + def _get_runtime_gc_count(self, observer: metrics.Observer) -> None: """Observer callback for garbage collection diff --git a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py index 85f505f5db4..fadc1dd562d 100644 --- a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py +++ b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py @@ -32,36 +32,44 @@ def test_system_metrics_constructor(self): with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: mock_get_meter.return_value = meter SystemMetrics(self.memory_metrics_exporter) - self.assertEqual(len(meter.observers), 5) + self.assertEqual(len(meter.observers), 6) observer_names = [ "system.mem", "system.cpu", "system.net.bytes", "runtime.python.mem", + "runtime.python.cpu", "runtime.python.gc.count", ] for observer in meter.observers: self.assertIn(observer.name, observer_names) observer_names.remove(observer.name) - def _assert_metrics(self, system_metrics, expected): + def _assert_metrics(self, observer_name, system_metrics, expected): system_metrics.controller.tick() assertions = 0 - for metric in self.memory_metrics_exporter._exported_metrics: - if metric.labels in expected: + for ( + metric + ) in ( + self.memory_metrics_exporter._exported_metrics # pylint: disable=protected-access + ): + if ( + metric.labels in expected + and metric.metric.name == observer_name + ): self.assertEqual( metric.aggregator.checkpoint.last, expected[metric.labels], ) assertions += 1 self.assertEqual(len(expected), assertions) - def _test_metrics(self, expected): + def _test_metrics(self, observer_name, expected): meter = self.meter_provider.get_meter(__name__) with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: mock_get_meter.return_value = meter system_metrics = SystemMetrics(self.memory_metrics_exporter) - self._assert_metrics(system_metrics, expected) + self._assert_metrics(observer_name, system_metrics, expected) @mock.patch("psutil.cpu_times") def test_system_cpu(self, mock_cpu_times): @@ -75,7 +83,7 @@ def test_system_cpu(self, mock_cpu_times): (("type", "system"),): 309836.43, (("type", "idle"),): 6724698.94, } - self._test_metrics(expected) + self._test_metrics("system.cpu", expected) @mock.patch("psutil.virtual_memory") def test_system_memory(self, mock_virtual_memory): @@ -109,7 +117,7 @@ def test_system_memory(self, mock_virtual_memory): (("type", "available"),): 5520928768, (("type", "free"),): 266964992, } - self._test_metrics(expected) + self._test_metrics("system.mem", expected) @mock.patch("psutil.net_io_counters") def test_network_bytes(self, mock_net_io_counters): @@ -128,7 +136,7 @@ def test_network_bytes(self, mock_net_io_counters): (("type", "bytes_recv"),): 46798894080, (("type", "bytes_sent"),): 23920188416, } - self._test_metrics(expected) + self._test_metrics("system.net.bytes", expected) def test_runtime_memory(self): meter = self.meter_provider.get_meter(__name__) @@ -150,7 +158,35 @@ def test_runtime_memory(self): (("type", "rss"),): 9777152, (("type", "vms"),): 4385665024, } - self._assert_metrics(system_metrics, expected) + self._assert_metrics( + "runtime.python.mem", system_metrics, expected + ) + + def test_runtime_cpu(self): + meter = self.meter_provider.get_meter(__name__) + with mock.patch("opentelemetry.metrics.get_meter") as mock_get_meter: + mock_get_meter.return_value = meter + system_metrics = SystemMetrics(self.memory_metrics_exporter) + + with mock.patch.object( + system_metrics._proc, # pylint: disable=protected-access + "cpu_times", + ) as mock_runtime_cpu_times: + RuntimeCPU = namedtuple( + "RuntimeCPU", ["user", "nice", "system"] + ) + mock_runtime_cpu_times.return_value = RuntimeCPU( + user=100.48, nice=0.0, system=200.43 + ) + + expected = { + (("type", "user"),): 100.48, + (("type", "system"),): 200.43, + } + + self._assert_metrics( + "runtime.python.cpu", system_metrics, expected + ) @mock.patch("gc.get_count") def test_runtime_gc_count(self, mock_gc): @@ -165,4 +201,4 @@ def test_runtime_gc_count(self, mock_gc): (("count", "1"),): 50, (("count", "2"),): 10, } - self._test_metrics(expected) + self._test_metrics("runtime.python.gc.count", expected) From fe751ea2468c366515f7f4e2640304aa97534ab1 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Wed, 27 May 2020 13:10:10 -0700 Subject: [PATCH 15/16] fix lint and docs --- .../src/opentelemetry/ext/system_metrics/__init__.py | 11 ++++++----- .../tests/test_system_metrics.py | 1 - 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py index 91e1df32d51..181ce2720a7 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py @@ -15,11 +15,12 @@ Instrument to report system (CPU, memory, network) and process (CPU, memory, garbage collection) metrics. By default, the following metrics are configured: - "system_memory": ["total", "available", "used", "free"], - "system_cpu": ["user", "system", "idle"], - "network_bytes": ["bytes_recv", "bytes_sent"], - "runtime_memory": ["rss", "vms"], - "runtime_cpu": ["user", "system"], + +"system_memory": ["total", "available", "used", "free"], +"system_cpu": ["user", "system", "idle"], +"network_bytes": ["bytes_recv", "bytes_sent"], +"runtime_memory": ["rss", "vms"], +"runtime_cpu": ["user", "system"], Usage diff --git a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py index fadc1dd562d..70ead2c5152 100644 --- a/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py +++ b/ext/opentelemetry-ext-system-metrics/tests/test_system_metrics.py @@ -17,7 +17,6 @@ from opentelemetry import metrics from opentelemetry.ext.system_metrics import SystemMetrics -from opentelemetry.sdk.metrics import Observer from opentelemetry.test.test_base import TestBase From 04605022a6f41f25399cfa720cc3bf45453d2823 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Fri, 29 May 2020 13:37:15 -0700 Subject: [PATCH 16/16] fixing version, adding configuration example --- ext/opentelemetry-ext-system-metrics/setup.cfg | 4 ++-- .../src/opentelemetry/ext/system_metrics/__init__.py | 10 ++++++++++ .../src/opentelemetry/ext/system_metrics/version.py | 2 +- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/ext/opentelemetry-ext-system-metrics/setup.cfg b/ext/opentelemetry-ext-system-metrics/setup.cfg index b55d723bff9..25515eaf0d3 100644 --- a/ext/opentelemetry-ext-system-metrics/setup.cfg +++ b/ext/opentelemetry-ext-system-metrics/setup.cfg @@ -40,12 +40,12 @@ package_dir= =src packages=find_namespace: install_requires = - opentelemetry-api == 0.8.dev0 + opentelemetry-api == 0.9.dev0 psutil ~= 5.7.0 [options.extras_require] test = - opentelemetry-test == 0.8.dev0 + opentelemetry-test == 0.9.dev0 [options.packages.find] where = src diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py index 181ce2720a7..88f36f4ac48 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/__init__.py @@ -37,6 +37,16 @@ # metrics are collected asynchronously input("...") + # to configure custom metrics + configuration = { + "system_memory": ["total", "available", "used", "free", "active", "inactive", "wired"], + "system_cpu": ["user", "nice", "system", "idle"], + "network_bytes": ["bytes_recv", "bytes_sent"], + "runtime_memory": ["rss", "vms"], + "runtime_cpu": ["user", "system"], + } + SystemMetrics(exporter, config=configuration) + API --- """ diff --git a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py index bcf6a357770..603bf0b7e5f 100644 --- a/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py +++ b/ext/opentelemetry-ext-system-metrics/src/opentelemetry/ext/system_metrics/version.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "0.8.dev0" +__version__ = "0.9.dev0"