flexmetric 0.5.2__py3-none-any.whl → 0.5.3__py3-none-any.whl

{flexmetric-0.5.2.dist-info → flexmetric-0.5.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flexmetric
-Version: 0.5.2
+Version: 0.5.3
 Summary: A secure flexible Prometheus exporter for commands, databases, functions.
 Home-page: https://github.com/nikhillingadhal1999/flexmetric
 Author: Nikhil Lingadhal
@@ -33,25 +33,38 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-# FlexMetric
+FlexMetric is a lightweight, pluggable, and extensible Prometheus exporter that helps you collect, expose, and visualize custom metrics with minimal setup and maximum flexibility.
 
-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.
+With FlexMetric, you can:
 
----
+Run system commands and expose their output as metrics
+
+Execute SQL queries against databases like SQLite, PostgreSQL, and ClickHouse
+
+Call custom Python functions and export their results
 
-## Features
+Receive externally submitted metrics via a secure Flask-based API with optional HTTPS (TLS)
 
-- 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.
+All metrics are exposed in Prometheus-compatible format, making them ready for visualization in Grafana or any Prometheus-based monitoring stack.
+---
 
+Paste your rich text content here. You can paste directly from Word or other rich text sources.
+
+*   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** and monitor database statistics:
+    
+    * **SQLite** (lightweight, file-based databases)
+    * **PostgreSQL** (robust, production-grade relational databases)
+    * **ClickHouse** (high-performance, analytical databases)  
+* Potentially dangerous queries (e.g., `DROP`, `DELETE`, `TRUNCATE`) are blocked by default.
+*   Automatically discover and expose **Python function outputs** as metrics.
+*   Expose an optional **Flask API** (`/update_metric`) to receive and update external metrics **dynamically**.
+*   Modular and **easy to extend**—add your own **custom integrations** with minimal effort.
+*   Built-in **Prometheus-compatible HTTP server** (`/metrics`) with configurable port.
+*   Supports **HTTPS** to securely expose both the metrics endpoint and API. 
+*   Input **sanitization and validation** ensure only safe commands and queries are executed.
 
 ---
 
@@ -190,52 +203,99 @@ Filesystem      Size  Used Avail Use% Mounted on
 | `timeout_seconds` | Maximum time (in seconds) to wait for the command to complete. If it exceeds this time, the command is aborted.             |
 
 ## Database mode
+## 🔗 Supported Database Connections
+
+FlexMetric supports fetching and exposing metrics from multiple databases using a simple YAML-based configuration. This allows you to monitor data directly from your existing data sources without writing custom code.
+
+### ✅ Currently Supported Databases:
+
+| Database      | Type Name     | Description                                      |
+|--------------|---------------|--------------------------------------------------|
+| **SQLite**    | `sqlite`      | Lightweight, file-based relational database       |
+| **PostgreSQL** | `postgres`    | Robust, production-grade relational database      |
+| **ClickHouse** | `clickhouse`  | High-performance, analytical columnar database    |
+
+---
+
+### 📄 Example `database.yaml` Configuration:
 file - database.yaml
 ```yaml
 databases:
-  - id: "active_user_count"
+  - id: "local_sqlite"
+    type: "sqlite"
+    db_connection: "/path/to/example.db"
+
+  - id: "analytics_pg"
+    type: "postgres"
+    host: "localhost"
+    port: 5432
+    database: "metricsdb"
+    username: "postgres"
+    password: "postgres_password"
+    sslmode: "disable"
+    client_cert: "/path/to/cert.pem"
+    client_key: "/path/to/key.pem"
+    ca_cert: "/path/to/ca.pem"
+
+  - id: "clickhouse_cluster"
     type: "clickhouse"
     host: "localhost"
-    port: 8123
+    port: 8443
     username: "default"
-    password: ""
-    client_cert: ""
-    client_key: ""
-    ca_cert: ""
-
-  - id: "userdb"
-    type: "sqlite"
-    db_connection: "/path/to/my.db"
+    password: "clickhouse_password"
+    secure: true
+    client_cert: "/path/to/cert.pem"
+    client_key: "/path/to/key.pem"
+    ca_cert: "/path/to/ca.pem"
 ```
-file - queries.yaml
+
+## Supported Query Configuration
+
+FlexMetric allows you to define custom queries in a simple YAML format. Each query is linked to a database using the `database_id` and can expose the results as Prometheus metrics with flexible labeling and value extraction.
+
+### Example `queries.yaml` Configuration:
+
 ```yaml
 commands:
-  - id: "active_user_count"
-    type: "clickhouse"
-    database_id: "active_user_count"
+  - id: "active_user_count_pg"
+    type: "postgres"
+    database_id: "analytics_pg"
     query: |
       SELECT
         country AS country_name,
-        COUNT() AS active_user_count
+        COUNT(*) AS active_user_count
       FROM users
-      WHERE is_active = 1
-      GROUP BY country
+      WHERE is_active = true
+      GROUP BY country;
     main_label: "active_user_count"
     labels: ["country_name"]
     value_column: "active_user_count"
 
-  - id: "list_all_users_sqlite"
+  - id: "total_user_count_sqlite"
     type: "sqlite"
-    database_id: "userdb"
+    database_id: "local_sqlite"
+    query: |
+      SELECT
+        'all' AS user_group,
+        COUNT(*) AS total_user_count
+      FROM users;
+    main_label: "total_user_count"
+    labels: ["user_group"]
+    value_column: "total_user_count"
+
+  - id: "clickhouse_user_summary"
+    type: "clickhouse"
+    database_id: "clickhouse_cluster"
     query: |
       SELECT
-        id,
-        name
+        region AS region_name,
+        COUNT() AS user_count
       FROM users
-    main_label: "user_list"
-    labels: ["id", "name"]
-    value_column: "id"
-
+      WHERE status = 'active'
+      GROUP BY region;
+    main_label: "clickhouse_user_count"
+    labels: ["region_name"]
+    value_column: "user_count"
 ```
 ## Functions mode
 

{flexmetric-0.5.2.dist-info → flexmetric-0.5.3.dist-info}/RECORD

@@ -13,8 +13,8 @@ flexmetric/metric_process/process_commands.py,sha256=clGMQhLNcuJUO1gElpAS9Dyk0KU
 flexmetric/metric_process/prometheus_agent.py,sha256=pDPqiPtHLv1cfF6dPRNg2LtAhVF1UKf8MNZ_S9xuRQY,7712
 flexmetric/metric_process/queries_execution.py,sha256=ed8GnWbBdvCb7WfQOmeJdpR0DarF_EHbXBPc6tKaEyg,1229
 flexmetric/metric_process/views.py,sha256=BY695dCpTkJRc1KLC9RNpFTieFdHeHvyqyefmHhMauE,3297
-flexmetric-0.5.2.dist-info/METADATA,sha256=rDkws5sg0EbOrR9r_yoOp3ZhdM7av_7ddXMg9YIXFPw,11307
-flexmetric-0.5.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-flexmetric-0.5.2.dist-info/entry_points.txt,sha256=urVePn5EWr3JqNvkYP7OsB_h2_Bqvv-Wq1MJRBexm8A,79
-flexmetric-0.5.2.dist-info/top_level.txt,sha256=zBlrNwKhXUNhgu9RRZnXxYwYnmE-eocRe6wKSmQROA4,11
-flexmetric-0.5.2.dist-info/RECORD,,
+flexmetric-0.5.3.dist-info/METADATA,sha256=CVkAz_6fG6cJgoKN7e_GB-RxTBQJM1ehGz_s5p23Q8I,13820
+flexmetric-0.5.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flexmetric-0.5.3.dist-info/entry_points.txt,sha256=urVePn5EWr3JqNvkYP7OsB_h2_Bqvv-Wq1MJRBexm8A,79
+flexmetric-0.5.3.dist-info/top_level.txt,sha256=zBlrNwKhXUNhgu9RRZnXxYwYnmE-eocRe6wKSmQROA4,11
+flexmetric-0.5.3.dist-info/RECORD,,