flexmetric 0.3.2__tar.gz → 0.4.0__tar.gz

{flexmetric-0.3.2 → flexmetric-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flexmetric
-Version: 0.3.2
+Version: 0.4.0
 Summary: A secure flexible Prometheus exporter for commands, databases, functions, and scripts.
 Home-page: https://github.com/nikhillingadhal1999/flexmetric
 Author: Nikhil Lingadhal
@@ -155,11 +155,33 @@ curl -k -X POST https://localhost:5000/update_metric \
 commands:
   - name: disk_usage
     command: df -h
-    label: path
-    label_column: -1
+    main_label: disk_usage_filesystem_mount_point
+    labels: ["filesystem", "mounted"]
+    label_columns: [0, -1]
     value_column: 4
     timeout_seconds: 60
 ```
+Example to select label_column and value_column
+
+```bash
+Filesystem      Size  Used Avail Use% Mounted on
+/dev/sda1        50G   20G   28G  42% /
+/dev/sdb1       100G   10G   85G  10% /data
+```
+## Fields description
+
+| Field             | Description                                                                                                                |
+|-------------------|----------------------------------------------------------------------------------------------------------------------------|
+| `name`            | A **nickname** you give to this check. It's just for your reference to know what this command is doing (e.g., `"disk_usage"`). |
+| `command`         | The **actual shell command** to run (e.g., `"df -h"`). It fetches the data you want to monitor.                             |
+| `main_label`      | The **metric name** that will appear in Prometheus. This is what you will query to see the metric values.                  |
+| `labels`          | A list of **label names** used to describe different dimensions of the metric (e.g., `["filesystem", "mounted"]`).         |
+| `label_columns`   | A list of **column indexes** from the command’s output to extract the label values (e.g., `[0, -1]` for first and last column). |
+| `value_column`    | The **column index** from the command's output to extract the **numeric value** (the actual metric value, e.g., disk usage). |
+| `timeout_seconds` | Maximum time (in seconds) to wait for the command to complete. If it exceeds this time, the command is aborted.             |
+
+## Database mode
+
 ```yaml
 databases:
   - name: mydb
@@ -167,14 +189,16 @@ databases:
     db_connection: /path/to/my.db
 ````
 ```yaml
-queries:
+commands:
   - name: user_count
-    db_type: sqlite
-    db_name: mydb
+    database: userdb
     query: "SELECT COUNT(*) FROM users;"
-    label: table
-    label_value: users
+    main_label: database_user_count
+    labels: ["database_name", "table_name"]
+    label_values: ["userdb", "users"]
 ```
+## Functions mode
+
 executable_functions.txt 
 ```
 function_name_1
@@ -188,9 +212,10 @@ When using the `--functions` mode, each Python function you define is expected t
 ```python
 {
     'result': [
-        {'label': <label_or_labels>, 'value': <numeric_value>}
+        { 'label': [label_value1, label_value2, ...], 'value': numeric_value }
     ],
-    'labels': [<label_name_1>]
+    'labels': [label_name1, label_name2, ...],
+    'main_label': 'your_main_metric_name'
 }
 ```
 

{flexmetric-0.3.2 → flexmetric-0.4.0}/README.md

@@ -122,11 +122,33 @@ curl -k -X POST https://localhost:5000/update_metric \
 commands:
   - name: disk_usage
     command: df -h
-    label: path
-    label_column: -1
+    main_label: disk_usage_filesystem_mount_point
+    labels: ["filesystem", "mounted"]
+    label_columns: [0, -1]
     value_column: 4
     timeout_seconds: 60
 ```
+Example to select label_column and value_column
+
+```bash
+Filesystem      Size  Used Avail Use% Mounted on
+/dev/sda1        50G   20G   28G  42% /
+/dev/sdb1       100G   10G   85G  10% /data
+```
+## Fields description
+
+| Field             | Description                                                                                                                |
+|-------------------|----------------------------------------------------------------------------------------------------------------------------|
+| `name`            | A **nickname** you give to this check. It's just for your reference to know what this command is doing (e.g., `"disk_usage"`). |
+| `command`         | The **actual shell command** to run (e.g., `"df -h"`). It fetches the data you want to monitor.                             |
+| `main_label`      | The **metric name** that will appear in Prometheus. This is what you will query to see the metric values.                  |
+| `labels`          | A list of **label names** used to describe different dimensions of the metric (e.g., `["filesystem", "mounted"]`).         |
+| `label_columns`   | A list of **column indexes** from the command’s output to extract the label values (e.g., `[0, -1]` for first and last column). |
+| `value_column`    | The **column index** from the command's output to extract the **numeric value** (the actual metric value, e.g., disk usage). |
+| `timeout_seconds` | Maximum time (in seconds) to wait for the command to complete. If it exceeds this time, the command is aborted.             |
+
+## Database mode
+
 ```yaml
 databases:
   - name: mydb
@@ -134,14 +156,16 @@ databases:
     db_connection: /path/to/my.db
 ````
 ```yaml
-queries:
+commands:
   - name: user_count
-    db_type: sqlite
-    db_name: mydb
+    database: userdb
     query: "SELECT COUNT(*) FROM users;"
-    label: table
-    label_value: users
+    main_label: database_user_count
+    labels: ["database_name", "table_name"]
+    label_values: ["userdb", "users"]
 ```
+## Functions mode
+
 executable_functions.txt 
 ```
 function_name_1
@@ -155,9 +179,10 @@ When using the `--functions` mode, each Python function you define is expected t
 ```python
 {
     'result': [
-        {'label': <label_or_labels>, 'value': <numeric_value>}
+        { 'label': [label_value1, label_value2, ...], 'value': numeric_value }
     ],
-    'labels': [<label_name_1>]
+    'labels': [label_name1, label_name2, ...],
+    'main_label': 'your_main_metric_name'
 }
 ```
 

{flexmetric-0.3.2 → flexmetric-0.4.0}/flexmetric/metric_process/database_processing.py

@@ -60,8 +60,10 @@ def process_database_queries(queries_file, databases_file):
 
             db_path = db_conf["db_connection"]
             query = cmd["query"]
-            label = cmd["label"]
-            label_value = cmd["label_value"]
+            labels = cmd.get('labels', [])
+            label_values = cmd.get('label_values', [])
+            main_label = cmd.get('main_label', 'default_db_metric')
+
             # check if query is safe
             if is_safe_query(query):
                 value = execute_sqlite_query(db_path, query)
@@ -69,20 +71,20 @@ def process_database_queries(queries_file, databases_file):
                 print(f"[WARN] Unsupported query type: {query}")
                 return None
 
-            if value is not None:
-                result = {
-                    "result": [{"label": label_value, "value": value}],
-                    "labels": [label],
-                }
-                all_results.append(result)
-            else:
-                print(
-                    f"[INFO] No result for command '{cmd['name']}' on database '{cmd['database']}'"
-                )
-
+            if not isinstance(label_values, list):
+                label_values = [label_values]
+
+            result = {
+                'result': [{
+                    'label': label_values,
+                    'value': value
+                }],
+                'labels': labels,
+                'main_label': main_label
+            }
+            all_results.append(result)
         except Exception as e:
             print(
                 f"[ERROR] Processing command '{cmd.get('name', 'unknown')}' failed: {e}"
             )
-
     return all_results

{flexmetric-0.3.2 → flexmetric-0.4.0}/flexmetric/metric_process/process_commands.py

@@ -55,24 +55,40 @@ def parse_command_output(raw_output, label_column, value_column, fixed_label_val
 
 def process_single_command(cmd_info):
     command = cmd_info['command']
-    label_name = cmd_info['label']
     timeout = cmd_info.get('timeout_seconds', 30)
-    label_column = cmd_info.get('label_column', -1)
+    labels = cmd_info.get('labels', [])
+    label_columns = cmd_info.get('label_columns', [])
     value_column = cmd_info.get('value_column', 0)
-    fixed_label_value = cmd_info.get('label_value')
+    main_label = cmd_info.get('main_label', 'default_metric')
 
     raw_output = execute_command_with_timeout(command, timeout)
-    if raw_output == '':
+    if not raw_output:
         logger.warning(f"No results for command {command}")
         return None
 
-    result_list = parse_command_output(raw_output, label_column, value_column, fixed_label_value)
-
+    lines = raw_output.strip().split('\n')
+    if not lines:
+        logger.error(f"No valid lines returned from command: {command}")
+        return None
+    result_list = []
+    for line in lines:
+        parts = line.split()
+        try:
+            label_columns_value = []
+            for value in label_columns:
+                label_columns_value.append(parts[value])
+            result_list.append({ "label": label_columns_value, "value": parts[value_column] })
+        except Exception as e:
+            logger.error(f"Error parsing line: '{line}' → {e}")
+            continue
     return {
         'result': result_list,
-        'labels': [label_name]
+        'labels': labels,
+        'main_label': main_label
     }
 
+
+
 def is_command_safe(command):
     blacklist = ['rm', 'reboot', 'shutdown', 'halt', 'poweroff', 'mkfs', 'dd']
     for dangerous_cmd in blacklist:

{flexmetric-0.3.2 → flexmetric-0.4.0}/flexmetric/metric_process/prometheus_agent.py

@@ -190,27 +190,37 @@ def measure(args):
         if cmd_results != None:
             exec_result.extend(cmd_results)
     global gauges
+
     for data in exec_result:
         results = data["result"]
         labels = data["labels"]
-        gauge_name = "_".join(labels).lower() + "_gauge"
-        # print(labels)
+        main_label_value = data.get("main_label", "default_main")
+        gauge_name = main_label_value.lower() + "_gauge"
+
         if gauge_name not in gauges:
             gauge = Gauge(gauge_name, f"{gauge_name} for different metrics", labels)
             gauges[gauge_name] = gauge
         else:
             gauge = gauges[gauge_name]
+
         for result in results:
-            if isinstance(result["label"], str):
-                try:
-                    gauge.labels(result["label"]).set(
-                        convert_to_data_type(result["value"])
-                    )
-                except Exception as ex:
-                    logger.error("Cannot pass string")
-            elif isinstance(result["label"], list):
-                label_dict = dict(zip(labels, result["label"]))
+            label_values = result["label"]
+
+            if not isinstance(label_values, list):
+                # Automatically wrap single label into list for consistency
+                label_values = [label_values]
+
+            if len(label_values) != len(labels):
+                logger.error(f"Label mismatch: expected {len(labels)} values but got {len(label_values)}")
+                continue
+
+            label_dict = dict(zip(labels, label_values))
+            # print(label_dict)
+
+            try:
                 gauge.labels(**label_dict).set(convert_to_data_type(result["value"]))
+            except Exception as ex:
+                logger.error(f"Failed to set gauge for labels {label_dict}: {ex}")
 
 
 def scheduled_measure(args):
@@ -244,5 +254,6 @@ def main():
         secure_flask_run(args)
     else:
         run_flask(args.host, args.port)
-
-main()
+# # args = arguments()
+# # measure(args)
+# main()

flexmetric-0.4.0/flexmetric/metric_process/views.py

@@ -0,0 +1,54 @@
+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()
+
+            # Validate top-level structure
+            if not data or "result" not in data or "labels" not in data or "main_label" not in data:
+                return jsonify({"status": "invalid structure"}), 400
+
+            result = data["result"]
+            labels = data["labels"]
+            main_label = data["main_label"]
+
+            # Validate types
+            if not isinstance(result, list) or not isinstance(labels, list) or not isinstance(main_label, str):
+                return jsonify({"status": "invalid types"}), 400
+
+            for item in result:
+                if "label" not in item or "value" not in item:
+                    return jsonify({"status": "invalid result item"}), 400
+                if not isinstance(item["label"], list):
+                    return jsonify({"status": "label must be list"}), 400
+
+                if len(item["label"]) != len(labels):
+                    return jsonify({"status": "label count mismatch"}), 400
+
+            # If everything is valid, queue the data
+            metric_queue.put(data)
+            print(metric_queue)
+
+            return jsonify({"status": "success"}), 200
+
+        except Exception as e:
+            return jsonify({"status": "error", "message": str(e)}), 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.3.2 → flexmetric-0.4.0}/flexmetric.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flexmetric
-Version: 0.3.2
+Version: 0.4.0
 Summary: A secure flexible Prometheus exporter for commands, databases, functions, and scripts.
 Home-page: https://github.com/nikhillingadhal1999/flexmetric
 Author: Nikhil Lingadhal
@@ -155,11 +155,33 @@ curl -k -X POST https://localhost:5000/update_metric \
 commands:
   - name: disk_usage
     command: df -h
-    label: path
-    label_column: -1
+    main_label: disk_usage_filesystem_mount_point
+    labels: ["filesystem", "mounted"]
+    label_columns: [0, -1]
     value_column: 4
     timeout_seconds: 60
 ```
+Example to select label_column and value_column
+
+```bash
+Filesystem      Size  Used Avail Use% Mounted on
+/dev/sda1        50G   20G   28G  42% /
+/dev/sdb1       100G   10G   85G  10% /data
+```
+## Fields description
+
+| Field             | Description                                                                                                                |
+|-------------------|----------------------------------------------------------------------------------------------------------------------------|
+| `name`            | A **nickname** you give to this check. It's just for your reference to know what this command is doing (e.g., `"disk_usage"`). |
+| `command`         | The **actual shell command** to run (e.g., `"df -h"`). It fetches the data you want to monitor.                             |
+| `main_label`      | The **metric name** that will appear in Prometheus. This is what you will query to see the metric values.                  |
+| `labels`          | A list of **label names** used to describe different dimensions of the metric (e.g., `["filesystem", "mounted"]`).         |
+| `label_columns`   | A list of **column indexes** from the command’s output to extract the label values (e.g., `[0, -1]` for first and last column). |
+| `value_column`    | The **column index** from the command's output to extract the **numeric value** (the actual metric value, e.g., disk usage). |
+| `timeout_seconds` | Maximum time (in seconds) to wait for the command to complete. If it exceeds this time, the command is aborted.             |
+
+## Database mode
+
 ```yaml
 databases:
   - name: mydb
@@ -167,14 +189,16 @@ databases:
     db_connection: /path/to/my.db
 ````
 ```yaml
-queries:
+commands:
   - name: user_count
-    db_type: sqlite
-    db_name: mydb
+    database: userdb
     query: "SELECT COUNT(*) FROM users;"
-    label: table
-    label_value: users
+    main_label: database_user_count
+    labels: ["database_name", "table_name"]
+    label_values: ["userdb", "users"]
 ```
+## Functions mode
+
 executable_functions.txt 
 ```
 function_name_1
@@ -188,9 +212,10 @@ When using the `--functions` mode, each Python function you define is expected t
 ```python
 {
     'result': [
-        {'label': <label_or_labels>, 'value': <numeric_value>}
+        { 'label': [label_value1, label_value2, ...], 'value': numeric_value }
     ],
-    'labels': [<label_name_1>]
+    'labels': [label_name1, label_name2, ...],
+    'main_label': 'your_main_metric_name'
 }
 ```
 

{flexmetric-0.3.2 → flexmetric-0.4.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="flexmetric",
-    version="0.3.2",
+    version="0.4.0",
     author="Nikhil Lingadhal",
     description="A secure flexible Prometheus exporter for commands, databases, functions, and scripts.",
     long_description=open("README.md").read(),

flexmetric-0.3.2/flexmetric/metric_process/views.py

@@ -1,38 +0,0 @@
-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))