swchmonclient 0.1.0__tar.gz

swchmonclient-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+*.so
+.Python
+.venv/
+.env
+.pytest_cache/
+.coverage
+htmlcov/
+build/
+dist/
+*.egg-info/
+k3s.yaml

swchmonclient-0.1.0/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.

swchmonclient-0.1.0/PKG-INFO

@@ -0,0 +1,318 @@
+Metadata-Version: 2.4
+Name: swchmonclient
+Version: 0.1.0
+Summary: Kubernetes manifest deploy, readiness monitoring, threaded exporter integration, and cleanup tooling.
+Author-email: Márk Emődi <mark.emodi@sztaki.hun-ren.hu>
+License: Apache-2.0
+License-File: LICENSE
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: jinja2>=3.0
+Requires-Dist: kubernetes>=26.0.0
+Requires-Dist: python-dotenv>=1.2.2
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: stomp-py>=8.2.0
+Description-Content-Type: text/markdown
+
+# swchmonclient
+
+A Python library for deploying the monitoring stack and consuming metric events over STOMP in the Swarmchestrate project.
+
+## Install
+
+```bash
+pip install swchmonclient
+uv add swchmonclient
+```
+
+## Overview
+
+- Metrics defined in the SAT are monitored by EMS.
+- Composite metrics and SLOs are consumed from the central EPM.
+- Raw metrics can be consumed from the local EPA, an explicit list of nodes, or all nodes discovered from Kubernetes.
+- The library buffers metric values until `query_metric_values(...)` or `query_metric_values_raw(...)` is called.
+- Returned samples are consumed from the in-memory buffers.
+
+
+## Quick Example
+
+```python
+from swchmonclient import (
+    deploy_monitoring,
+    query_metric_values,
+    query_metric_values_raw,
+    subscribe_metric,
+    subscribe_metric_raw,
+    undeploy_monitoring,
+    unsubscribe_metric,
+)
+
+deploy_monitoring("./k3s.yaml", "tosca_metrics_ze.yaml", "http://optimusdb.example/swarmkb")
+subscribe_metric("/topic/mysample_metric")
+recent_values = query_metric_values("/topic/mysample_metric", seconds=60)
+subscribe_metric_raw("/topic/myraw_metric", ["10.0.0.1", "10.0.0.2"])
+subscribe_metric_raw("/topic/myraw_metric", "all")
+subscribe_metric_raw("/topic/myraw_metric", "local")
+raw_values = query_metric_values_raw("/topic/myraw_metric", seconds=60)
+unsubscribe_metric("/topic/mysample_metric")
+unsubscribe_metric("/topic/myraw_metric")
+undeploy_monitoring(
+    "./k3s.yaml",
+    "tosca_metrics_ze.yaml",
+    "http://optimusdb.example/swarmkb",
+    namespace="default",
+)
+```
+
+## Raw Metric Subscriptions
+
+`subscribe_metric_raw(metric, node)` supports three selector modes:
+
+- `["10.0.0.1", "10.0.0.2"]` starts one raw listener per explicit node/IP
+- `"all"` resolves all Kubernetes VM private IPs internally
+- `"local"` resolves the current machine's private IP and starts one raw listener for it
+
+Raw subscriptions connect directly to the resolved node IPs. Read buffered raw samples with:
+
+```python
+raw_values = query_metric_values_raw("cpu_util_instance", seconds=60)
+```
+
+The returned structure is grouped by node/IP:
+
+```python
+{
+    "10.0.0.1": [
+        {"timestamp": 1716712345.12, "value": 42.0},
+    ],
+}
+```
+
+Each raw metric on each node/IP keeps up to 1000 cached samples, dropping the oldest entries first when the buffer fills.
+
+If you subscribe multiple raw metrics for the same node/IP, the library reuses the same raw listener thread for that node and dynamically subscribes the additional metric topics on that connection.
+
+## API Reference
+
+### `deploy_monitoring(kubeconfig_path: str | None, sat_file: str, optimusdb_url: str, logger: logging.Logger | None = None) -> int`
+
+Deploys the standard monitoring stack manifests.
+
+If `./manifests/emsconfig.yaml` or `./manifests/ems+netdata-k3s_parametric.yaml` is missing locally, the library downloads it from the `v0.1.0` release assets before deployment. When a local copy already exists, it validates the content against the release asset, logs whether it matches, and replaces the file if it differs.
+
+| Parameter | Required | Type | Description |
+| --- | --- | --- | --- |
+| `kubeconfig_path` | No | `str \| None` | Path to the kubeconfig file. If omitted, the default kubeconfig / in-cluster fallback is used. |
+| `sat_file` | Yes | `str` | SAT file path injected into the templated manifest. |
+| `optimusdb_url` | Yes | `str` | OptimusDB URL injected into the templated manifest. |
+| `logger` | No | `logging.Logger \| None` | Custom logger. If omitted, stdout logging is configured automatically. |
+
+**Output:** process-style exit code: `0` on success, `1` if one or more deploy steps fail.
+
+### `undeploy_monitoring(kubeconfig_path: str | None, sat_file: str, optimusdb_url: str, namespace: str | None = None, logger: logging.Logger | None = None) -> int`
+
+Undeploys the standard monitoring stack manifests and the related cleanup resources.
+
+Like deployment, undeploy ensures the two required monitoring manifests are available locally, logs whether existing local copies match the published release assets, and refreshes differing files from the release.
+
+| Parameter | Required | Type | Description |
+| --- | --- | --- | --- |
+| `kubeconfig_path` | No | `str \| None` | Path to the kubeconfig file. If omitted, the default kubeconfig / in-cluster fallback is used. |
+| `sat_file` | Yes | `str` | SAT file path used to render the templated manifest before undeploy. |
+| `optimusdb_url` | Yes | `str` | OptimusDB URL used to render the templated manifest before undeploy. |
+| `namespace` | No | `str \| None` | Namespace override for deleting namespaced resources. If omitted, manifest/default namespaces are used. |
+| `logger` | No | `logging.Logger \| None` | Custom logger. If omitted, stdout logging is configured automatically. |
+
+**Output:** process-style exit code: `0` on success, `1` if one or more undeploy steps fail.
+
+### `subscribe_metric(metric: str) -> str`
+
+Starts or reuses the shared standard metric listener for the requested metric topic.
+
+| Parameter | Required | Type | Description |
+| --- | --- | --- | --- |
+| `metric` | Yes | `str` | Metric name or full topic destination. Plain names are normalized to `/topic/<metric>`. |
+
+**Output:** `str` thread name of the shared listener, currently `metric-listener`.
+
+### `subscribe_metric_raw(metric: str, node: list[str] | str, cache_size: int | None = None) -> dict[str, str]`
+
+Starts raw metric listeners that connect directly to node IPs.
+
+| Parameter | Required | Type | Description |
+| --- | --- | --- | --- |
+| `metric` | Yes | `str` | Metric name or full topic destination. Plain names are normalized to `/topic/<metric>`. |
+| `node` | Yes | `list[str] \| str` | Raw node selector. Use an explicit node/IP list, `"all"` for all Kubernetes VM private IPs, or `"local"` for the current machine's private IP. |
+| `cache_size` | No | `int \| None` | Per raw metric per node sample buffer size. If omitted, the default value `1000` is used. |
+
+**Output:** `dict[str, str]` mapping each resolved node/IP to the listener thread name started for it.
+
+**Notes:**
+- Starts one raw listener thread per resolved node/IP and reuses it for additional raw metrics on that same node/IP.
+- Raw subscriptions connect directly to each resolved node/IP instead of `STOMP_HOST`.
+- Mixing `subscribe_metric(...)` and `subscribe_metric_raw(...)` for the same metric is rejected.
+- For `node="all"`, Kubernetes config is resolved automatically from the default kubeconfig, `KUBECONFIG`, common local files such as `./k3s.yaml`, or in-cluster config.
+
+### `query_metric_values(metric: str, seconds: int) -> list[Any]`
+
+Returns buffered metric values received within the last `seconds` seconds and consumes those returned samples.
+
+| Parameter | Required | Type | Description |
+| --- | --- | --- | --- |
+| `metric` | Yes | `str` | Metric name or full topic destination. |
+| `seconds` | Yes | `int` | Time window to read from. Must be non-negative. |
+
+```python
+[42.0, 41.7]
+```
+
+### `query_metric_values_raw(metric: str, seconds: int) -> dict[str, list[dict[str, Any]]]`
+
+Returns buffered raw metric values received within the last `seconds` seconds and consumes those returned samples.
+
+| Parameter | Required | Type | Description |
+| --- | --- | --- | --- |
+| `metric` | Yes | `str` | Metric name or full topic destination. |
+| `seconds` | Yes | `int` | Time window to read from. Must be non-negative. |
+
+**Output:**
+
+```python
+{
+    "10.0.0.1": [
+        {"timestamp": 1716712345.12, "value": 42.0},
+    ],
+}
+```
+
+### `unsubscribe_metric(metric: str, nodes: list[str] | None = None) -> None`
+
+Stops metric listeners or removes node-specific subscriptions, depending on the subscription mode.
+
+| Parameter | Required | Type | Description |
+| --- | --- | --- | --- |
+| `metric` | Yes | `str` | Metric name or full topic destination. |
+| `nodes` | No | `list[str] \| None` | For raw subscriptions, stops only the listed node/IP listeners. For standard subscriptions, blocks those nodes from future samples. If omitted, removes the full subscription. |
+
+**Output:** no return value.
+
+**Behavior summary:**
+- Standard metric + no `nodes`: stop the shared listener when the last standard metric is removed.
+- Standard metric + `nodes`: keep the listener running, but ignore future samples from those nodes.
+- Raw metric + no `nodes`: stop all raw listeners for that metric.
+- Raw metric + `nodes`: stop only the listed raw node/IP listeners and remove their cached data buckets.
+
+## Examples
+
+Runnable examples are available under `examples/`:
+
+- `examples/deploy_example.py`
+- `examples/undeploy_example.py`
+- `examples/subscribe_cpu_util_instance_example.py`
+- `examples/subscribe_cpu_util_instance_raw_example.py`
+
+## Simple Snippets
+
+### `deploy_monitoring`
+
+```python
+from swchmonclient import deploy_monitoring
+
+exit_code = deploy_monitoring("./k3s.yaml", "tosca_metrics_ze.yaml", "http://optimusdb.example/swarmkb")
+```
+
+### `undeploy_monitoring`
+
+```python
+from swchmonclient import undeploy_monitoring
+
+exit_code = undeploy_monitoring(
+    "./k3s.yaml",
+    "tosca_metrics_ze.yaml",
+    "http://optimusdb.example/swarmkb",
+    namespace="default",
+)
+```
+
+### `subscribe_metric`
+
+```python
+from swchmonclient import subscribe_metric
+
+thread_name = subscribe_metric("cpu_util_instance")
+print(thread_name)
+```
+
+### `subscribe_metric_raw`
+
+```python
+from swchmonclient import subscribe_metric_raw
+
+threads = subscribe_metric_raw("cpu_util_instance", "local")
+# or: subscribe_metric_raw("cpu_util_instance", "local", cache_size=500)
+# or: subscribe_metric_raw("cpu_util_instance", "all")
+# or: subscribe_metric_raw("cpu_util_instance", ["10.0.0.1", "10.0.0.2"])
+print(threads)
+```
+
+### `query_metric_values`
+
+```python
+from swchmonclient import query_metric_values
+
+standard_values = query_metric_values("cpu_util_instance", seconds=60)
+```
+
+### `query_metric_values_raw`
+
+```python
+from swchmonclient import query_metric_values_raw
+
+raw_values = query_metric_values_raw("cpu_util_instance", seconds=60)
+```
+
+### `unsubscribe_metric`
+
+```python
+from swchmonclient import unsubscribe_metric
+
+unsubscribe_metric("cpu_util_instance")
+# or: unsubscribe_metric("cpu_util_instance", nodes=["10.0.0.1"])
+```
+
+
+## Development
+
+```bash
+uv sync
+uv build
+```
+
+### Switching between in-cluster and local development
+
+The STOMP listener reads `STOMP_HOST` and `STOMP_PORT` from `.env`, so you can switch environments without changing code.
+
+Use the bundled profiles:
+
+```bash
+./scripts/use-cluster-env.sh
+./scripts/use-dev-env.sh
+```
+
+- `use-cluster-env.sh` writes `.env` with `emsserver-ems-server:61610`
+- `use-dev-env.sh` writes `.env` with `127.0.0.1:61610`
+
+When running outside the cluster, start a port-forward to the ClusterIP service:
+
+```bash
+./scripts/use-dev-env.sh
+./scripts/port-forward-emsserver.sh
+```
+
+If the service is not in `default`, pass the namespace explicitly:
+
+```bash
+./scripts/port-forward-emsserver.sh monitoring
+```