flexmetric 0.2.0__tar.gz → 0.3.0__tar.gz

{flexmetric-0.2.0 → flexmetric-0.3.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: flexmetric
-Version: 0.2.0
-Summary: A flexible Prometheus exporter for commands, databases, functions, and scripts.
+Version: 0.3.0
+Summary: A secure flexible Prometheus exporter for commands, databases, functions, and scripts.
 Home-page: https://github.com/nikhillingadhal1999/custom_prometheus_agent
 Author: Nikhil Lingadhal
 License: MIT
@@ -29,18 +29,23 @@ Dynamic: summary
 
 # FlexMetric
 
-FlexMetric is a lightweight, flexible, and extensible Prometheus exporter that allows you to expose system metrics, database query results, Python function outputs, and externally submitted metrics via an optional Flask API as Prometheus-compatible metrics—with minimal setup and maximum customization.
+FlexMetric is a lightweight, flexible, and extensible Prometheus exporter that allows you to securely expose system metrics, database query results, Python function outputs, and externally submitted metrics—via an optional Flask API with HTTPS support—as Prometheus-compatible metrics, all with minimal setup and maximum customization.
 
 ---
 
 ## Features
 
-- Run shell commands and expose the results as Prometheus metrics.
-- Execute SQL queries (e.g., SQLite) and monitor database statistics.
+- Run shell commands and expose the results as Prometheus metrics.  
+  ➔ **Harmful commands (e.g., file deletion, system shutdown) are blocked for safety.**
+- Execute SQL queries (e.g., SQLite) and monitor database statistics.  
+  ➔ **Potentially dangerous queries (e.g., `DROP`, `DELETE`, `TRUNCATE`) are not allowed.**
 - Automatically discover and expose Python function outputs as metrics.
 - Expose an optional **Flask API** (`/update_metric`) to receive external metrics dynamically.
 - Modular and easy to extend—add your own custom integrations.
 - Built-in Prometheus HTTP server (`/metrics`) with configurable port.
+- **Supports HTTPS** to securely expose both metrics and API endpoints.
+- **Input sanitization** is performed to ensure only safe commands and queries are executed.
+
 
 ---
 
@@ -86,7 +91,7 @@ To use the Flask API for submitting external metrics, you need to start the agen
 ### Start FlexMetric with Flask API
 
 ```bash
-flexmetric --expose-api --flask-port <port> --flask-host <host> --metrics-port <metrics-port>
+flexmetric --expose-api --port <port> --host <host>
 ```
 
 ## Example: Running FlexMetric with Flask API
@@ -94,11 +99,11 @@ flexmetric --expose-api --flask-port <port> --flask-host <host> --metrics-port <
 To run FlexMetric with both Prometheus metrics and the Flask API enabled:
 
 ```bash
-flexmetric --expose-api --flask-port 5000 --flask-host 0.0.0.0 --port 8000
+flexmetric --expose-api --port 5000 --host 0.0.0.0
 ```
 
 Prometheus metrics exposed at:
-http://localhost:8000/metrics
+http://localhost:5000/metrics
 
 Flask API exposed at:
 http://localhost:5000/update_metric
@@ -116,6 +121,30 @@ curl -X POST http://localhost:5000/update_metric \
 
 ```
 
+### Using flex metrics in secure mode
+
+```bash
+flexmetric --port 5000 --host 0.0.0.0 --enable-https --ssl-cert=cert.pem --ssl-key=key.pem
+```
+Prometheus metrics exposed at:
+https://localhost:5000/metrics
+
+Flask API exposed at:
+https://localhost:5000/update_metric
+
+### Submitting a Metric to the Flask API
+```bash
+curl -k -X POST https://localhost:5000/update_metric \
+-H "Content-Type: application/json" \
+-d '{
+  "result": [
+    { "label": "cpu_usage", "value": 42.5 }
+  ],
+  "labels": ["cpu"]
+}'
+
+```
+
 ### commands.yaml
 
 ```yaml
@@ -181,11 +210,13 @@ The following command-line options are available when running FlexMetric:
 | `--queries-config`   | Path to queries YAML file                                 | `queries.yaml`             |
 | `--functions`        | Enable Python functions mode                              |                            |
 | `--functions-file`   | Path to functions file                                    | `executable_functions.txt` |
-| `--scripts`          | Enable shell scripts mode                                 |                            |
-| `--scripts-config`   | Path to scripts YAML file                                 | `scripts.yaml`             |
 | `--expose-api`       | Enable Flask API mode to receive external metrics         |                            |
 | `--flask-port`       | Port for the Flask API (`/update_metric`)                 | `5000`                     |
 | `--flask-host`       | Hostname for the Flask API                                | `0.0.0.0`                  |
+| `--enable-https`     | Enable HTTPS for the Flask API                            |                            |
+| `--ssl-cert`         | Path to SSL certificate file (`cert.pem`)                 |                            |
+| `--ssl-key`          | Path to SSL private key file (`key.pem`)                  |                            |
+
 ### Example Command:
 
 ```bash

{flexmetric-0.2.0 → flexmetric-0.3.0}/README.md

@@ -1,17 +1,22 @@
 # FlexMetric
 
-FlexMetric is a lightweight, flexible, and extensible Prometheus exporter that allows you to expose system metrics, database query results, Python function outputs, and externally submitted metrics via an optional Flask API as Prometheus-compatible metrics—with minimal setup and maximum customization.
+FlexMetric is a lightweight, flexible, and extensible Prometheus exporter that allows you to securely expose system metrics, database query results, Python function outputs, and externally submitted metrics—via an optional Flask API with HTTPS support—as Prometheus-compatible metrics, all with minimal setup and maximum customization.
 
 ---
 
 ## Features
 
-- Run shell commands and expose the results as Prometheus metrics.
-- Execute SQL queries (e.g., SQLite) and monitor database statistics.
+- Run shell commands and expose the results as Prometheus metrics.  
+  ➔ **Harmful commands (e.g., file deletion, system shutdown) are blocked for safety.**
+- Execute SQL queries (e.g., SQLite) and monitor database statistics.  
+  ➔ **Potentially dangerous queries (e.g., `DROP`, `DELETE`, `TRUNCATE`) are not allowed.**
 - Automatically discover and expose Python function outputs as metrics.
 - Expose an optional **Flask API** (`/update_metric`) to receive external metrics dynamically.
 - Modular and easy to extend—add your own custom integrations.
 - Built-in Prometheus HTTP server (`/metrics`) with configurable port.
+- **Supports HTTPS** to securely expose both metrics and API endpoints.
+- **Input sanitization** is performed to ensure only safe commands and queries are executed.
+
 
 ---
 
@@ -57,7 +62,7 @@ To use the Flask API for submitting external metrics, you need to start the agen
 ### Start FlexMetric with Flask API
 
 ```bash
-flexmetric --expose-api --flask-port <port> --flask-host <host> --metrics-port <metrics-port>
+flexmetric --expose-api --port <port> --host <host>
 ```
 
 ## Example: Running FlexMetric with Flask API
@@ -65,11 +70,11 @@ flexmetric --expose-api --flask-port <port> --flask-host <host> --metrics-port <
 To run FlexMetric with both Prometheus metrics and the Flask API enabled:
 
 ```bash
-flexmetric --expose-api --flask-port 5000 --flask-host 0.0.0.0 --port 8000
+flexmetric --expose-api --port 5000 --host 0.0.0.0
 ```
 
 Prometheus metrics exposed at:
-http://localhost:8000/metrics
+http://localhost:5000/metrics
 
 Flask API exposed at:
 http://localhost:5000/update_metric
@@ -87,6 +92,30 @@ curl -X POST http://localhost:5000/update_metric \
 
 ```
 
+### Using flex metrics in secure mode
+
+```bash
+flexmetric --port 5000 --host 0.0.0.0 --enable-https --ssl-cert=cert.pem --ssl-key=key.pem
+```
+Prometheus metrics exposed at:
+https://localhost:5000/metrics
+
+Flask API exposed at:
+https://localhost:5000/update_metric
+
+### Submitting a Metric to the Flask API
+```bash
+curl -k -X POST https://localhost:5000/update_metric \
+-H "Content-Type: application/json" \
+-d '{
+  "result": [
+    { "label": "cpu_usage", "value": 42.5 }
+  ],
+  "labels": ["cpu"]
+}'
+
+```
+
 ### commands.yaml
 
 ```yaml
@@ -152,11 +181,13 @@ The following command-line options are available when running FlexMetric:
 | `--queries-config`   | Path to queries YAML file                                 | `queries.yaml`             |
 | `--functions`        | Enable Python functions mode                              |                            |
 | `--functions-file`   | Path to functions file                                    | `executable_functions.txt` |
-| `--scripts`          | Enable shell scripts mode                                 |                            |
-| `--scripts-config`   | Path to scripts YAML file                                 | `scripts.yaml`             |
 | `--expose-api`       | Enable Flask API mode to receive external metrics         |                            |
 | `--flask-port`       | Port for the Flask API (`/update_metric`)                 | `5000`                     |
 | `--flask-host`       | Hostname for the Flask API                                | `0.0.0.0`                  |
+| `--enable-https`     | Enable HTTPS for the Flask API                            |                            |
+| `--ssl-cert`         | Path to SSL certificate file (`cert.pem`)                 |                            |
+| `--ssl-key`          | Path to SSL private key file (`key.pem`)                  |                            |
+
 ### Example Command:
 
 ```bash

{flexmetric-0.2.0 → flexmetric-0.3.0}/flexmetric/metric_process/prometheus_agent.py

@@ -11,7 +11,11 @@ from flexmetric.metric_process.database_processing import process_database_queri
 from flexmetric.metric_process.expiring_queue import metric_queue
 import argparse
 import os
-from flexmetric.metric_process.views import run_flask
+from flexmetric.metric_process.views import (
+    run_flask,
+    add_update_metric_route,
+    secure_flask_run,
+)
 import sched
 import threading
 
@@ -77,16 +81,25 @@ def arguments():
         "--port", type=int, default=8000, help="port on which exportor runs"
     )
     parser.add_argument(
-        "--flask-host",
+        "--host",
         type=str,
         default="0.0.0.0",
         help="The hostname or IP address on which to run the Flask server (default: 0.0.0.0)",
     )
     parser.add_argument(
-        "--flask-port",
-        type=int,
-        default=5000,
-        help="The port number on which to run the Flask server (default: 5000)",
+        "--enable-https",
+        action="store_true",
+        help="Enable HTTPS for Flask API using SSL certificates.",
+    )
+    parser.add_argument(
+        "--ssl-cert",
+        type=str,
+        help="Path to the SSL certificate file (cert.pem) for HTTPS.",
+    )
+    parser.add_argument(
+        "--ssl-key",
+        type=str,
+        help="Path to the SSL private key file (key.pem) for HTTPS.",
     )
 
     return parser.parse_args()
@@ -111,7 +124,9 @@ gauges = {}
 def validate_required_files(mode_name, required_files):
     missing = [desc for desc, path in required_files.items() if path == None]
     if missing:
-        print(f"Missing {', '.join(missing)} for '{mode_name}' mode. Skipping...")
+        logger.error(
+            f"Missing {', '.join(missing)} for '{mode_name}' mode. Skipping..."
+        )
         return False
 
     return True
@@ -147,7 +162,8 @@ def validate_all_modes(args):
                 "functions-file": args.functions_file,
             },
         ),
-        (args.expose_api, "expose-api", {})
+        (args.expose_api, "expose-api", {}),
+        (args.enable_https,"enable-https",{"ssl-cert":args.ssl_cert,"ssl-key" :args.ssl_key})
     ]
 
     for is_enabled, mode_name, files in mode_validations:
@@ -161,7 +177,6 @@ def validate_all_modes(args):
 def measure(args):
     exec_result = []
     queue_items = metric_queue.pop_all()
-    print("QUEUE_ITEMS : ", queue_items)
     if len(queue_items) != 0:
         exec_result.extend(queue_items)
     if args.database:
@@ -186,7 +201,6 @@ def measure(args):
         else:
             gauge = gauges[gauge_name]
         for result in results:
-            print(result, isinstance(result["label"], list))
             if isinstance(result["label"], str):
                 try:
                     gauge.labels(result["label"]).set(
@@ -211,23 +225,24 @@ def start_scheduler(args):
 
 def main():
     args = arguments()
-    print("Validating configuration...")
+    logger.info("Validating configuration...")
     if not validate_all_modes(args):
-        print("No valid modes with proper configuration found. Exiting.")
+        logger.error("No valid modes with proper configuration found. Exiting.")
         exit(1)
 
-    print(f"Starting Prometheus metrics server on port {args.port}...")
-    print("Starting server")
-    start_http_server(args.port)
+    logger.info(f"Starting Prometheus metrics server on port {args.port}...")
+    logger.info("Starting server")
+    # start_http_server(args.port)
+
     scheduler_thread = threading.Thread(
         target=start_scheduler, args=(args,), daemon=True
     )
     scheduler_thread.start()
     if args.expose_api:
-        run_flask(args.flask_host, args.flask_port)
+        add_update_metric_route()
+    if args.enable_https:
+        secure_flask_run(args)
     else:
-        while True:
-            time.sleep(2)
-
+        run_flask(args.host, args.port)
 
 main()

flexmetric-0.3.0/flexmetric/metric_process/views.py

@@ -0,0 +1,38 @@
+from flask import Flask, request, jsonify, Response
+from flexmetric.metric_process.expiring_queue import metric_queue
+import argparse
+from prometheus_client import generate_latest, REGISTRY, CONTENT_TYPE_LATEST
+
+app = Flask(__name__)
+
+
+@app.route('/metrics')
+def metrics():
+    return Response(generate_latest(REGISTRY), mimetype=CONTENT_TYPE_LATEST)
+
+
+def add_update_metric_route():
+    @app.route("/update_metric", methods=["POST"])
+    def update_metric():
+        try:
+            data = request.get_json()
+
+            if not data or "result" not in data or not isinstance(data["result"], list):
+                return jsonify({"status": "no"}), 400
+
+            for item in data["result"]:
+                if "label" not in item or "value" not in item:
+                    return jsonify({"status": "no"}), 400
+
+            metric_queue.put(data)
+            print(metric_queue)
+            return jsonify({"status": "success"}), 200
+
+        except Exception:
+            return jsonify({"status": "no"}), 500
+
+
+def run_flask(host, port):
+    app.run(host=host, port=port)
+def secure_flask_run(args):
+    app.run(host=args.host, port=args.port, ssl_context=(args.ssl_cert, args.ssl_key))

{flexmetric-0.2.0 → flexmetric-0.3.0}/flexmetric.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: flexmetric
-Version: 0.2.0
-Summary: A flexible Prometheus exporter for commands, databases, functions, and scripts.
+Version: 0.3.0
+Summary: A secure flexible Prometheus exporter for commands, databases, functions, and scripts.
 Home-page: https://github.com/nikhillingadhal1999/custom_prometheus_agent
 Author: Nikhil Lingadhal
 License: MIT
@@ -29,18 +29,23 @@ Dynamic: summary
 
 # FlexMetric
 
-FlexMetric is a lightweight, flexible, and extensible Prometheus exporter that allows you to expose system metrics, database query results, Python function outputs, and externally submitted metrics via an optional Flask API as Prometheus-compatible metrics—with minimal setup and maximum customization.
+FlexMetric is a lightweight, flexible, and extensible Prometheus exporter that allows you to securely expose system metrics, database query results, Python function outputs, and externally submitted metrics—via an optional Flask API with HTTPS support—as Prometheus-compatible metrics, all with minimal setup and maximum customization.
 
 ---
 
 ## Features
 
-- Run shell commands and expose the results as Prometheus metrics.
-- Execute SQL queries (e.g., SQLite) and monitor database statistics.
+- Run shell commands and expose the results as Prometheus metrics.  
+  ➔ **Harmful commands (e.g., file deletion, system shutdown) are blocked for safety.**
+- Execute SQL queries (e.g., SQLite) and monitor database statistics.  
+  ➔ **Potentially dangerous queries (e.g., `DROP`, `DELETE`, `TRUNCATE`) are not allowed.**
 - Automatically discover and expose Python function outputs as metrics.
 - Expose an optional **Flask API** (`/update_metric`) to receive external metrics dynamically.
 - Modular and easy to extend—add your own custom integrations.
 - Built-in Prometheus HTTP server (`/metrics`) with configurable port.
+- **Supports HTTPS** to securely expose both metrics and API endpoints.
+- **Input sanitization** is performed to ensure only safe commands and queries are executed.
+
 
 ---
 
@@ -86,7 +91,7 @@ To use the Flask API for submitting external metrics, you need to start the agen
 ### Start FlexMetric with Flask API
 
 ```bash
-flexmetric --expose-api --flask-port <port> --flask-host <host> --metrics-port <metrics-port>
+flexmetric --expose-api --port <port> --host <host>
 ```
 
 ## Example: Running FlexMetric with Flask API
@@ -94,11 +99,11 @@ flexmetric --expose-api --flask-port <port> --flask-host <host> --metrics-port <
 To run FlexMetric with both Prometheus metrics and the Flask API enabled:
 
 ```bash
-flexmetric --expose-api --flask-port 5000 --flask-host 0.0.0.0 --port 8000
+flexmetric --expose-api --port 5000 --host 0.0.0.0
 ```
 
 Prometheus metrics exposed at:
-http://localhost:8000/metrics
+http://localhost:5000/metrics
 
 Flask API exposed at:
 http://localhost:5000/update_metric
@@ -116,6 +121,30 @@ curl -X POST http://localhost:5000/update_metric \
 
 ```
 
+### Using flex metrics in secure mode
+
+```bash
+flexmetric --port 5000 --host 0.0.0.0 --enable-https --ssl-cert=cert.pem --ssl-key=key.pem
+```
+Prometheus metrics exposed at:
+https://localhost:5000/metrics
+
+Flask API exposed at:
+https://localhost:5000/update_metric
+
+### Submitting a Metric to the Flask API
+```bash
+curl -k -X POST https://localhost:5000/update_metric \
+-H "Content-Type: application/json" \
+-d '{
+  "result": [
+    { "label": "cpu_usage", "value": 42.5 }
+  ],
+  "labels": ["cpu"]
+}'
+
+```
+
 ### commands.yaml
 
 ```yaml
@@ -181,11 +210,13 @@ The following command-line options are available when running FlexMetric:
 | `--queries-config`   | Path to queries YAML file                                 | `queries.yaml`             |
 | `--functions`        | Enable Python functions mode                              |                            |
 | `--functions-file`   | Path to functions file                                    | `executable_functions.txt` |
-| `--scripts`          | Enable shell scripts mode                                 |                            |
-| `--scripts-config`   | Path to scripts YAML file                                 | `scripts.yaml`             |
 | `--expose-api`       | Enable Flask API mode to receive external metrics         |                            |
 | `--flask-port`       | Port for the Flask API (`/update_metric`)                 | `5000`                     |
 | `--flask-host`       | Hostname for the Flask API                                | `0.0.0.0`                  |
+| `--enable-https`     | Enable HTTPS for the Flask API                            |                            |
+| `--ssl-cert`         | Path to SSL certificate file (`cert.pem`)                 |                            |
+| `--ssl-key`          | Path to SSL private key file (`key.pem`)                  |                            |
+
 ### Example Command:
 
 ```bash

{flexmetric-0.2.0 → flexmetric-0.3.0}/setup.py

@@ -2,9 +2,9 @@ from setuptools import setup, find_packages
 
 setup(
     name="flexmetric",
-    version="0.2.0",
+    version="0.3.0",
     author="Nikhil Lingadhal",
-    description="A flexible Prometheus exporter for commands, databases, functions, and scripts.",
+    description="A secure flexible Prometheus exporter for commands, databases, functions, and scripts.",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     url="https://github.com/nikhillingadhal1999/custom_prometheus_agent",

flexmetric-0.2.0/flexmetric/metric_process/views.py

@@ -1,29 +0,0 @@
-from flask import Flask, request, jsonify
-from flexmetric.metric_process.expiring_queue import metric_queue
-import argparse
-
-app = Flask(__name__)
-
-
-@app.route("/update_metric", methods=["POST"])
-def update_metric():
-    try:
-        data = request.get_json()
-
-        if not data or "result" not in data or not isinstance(data["result"], list):
-            return jsonify({"status": "no"}), 400
-
-        for item in data["result"]:
-            if "label" not in item or "value" not in item:
-                return jsonify({"status": "no"}), 400
-
-        metric_queue.put(data)
-        print(metric_queue)
-        return jsonify({"status": "success"}), 200
-
-    except Exception:
-        return jsonify({"status": "no"}), 500
-
-
-def run_flask(host, port):
-    app.run(host=host, port=port)