flexmetric 0.3.2__py3-none-any.whl → 0.3.3__py3-none-any.whl

{flexmetric-0.3.2.dist-info → flexmetric-0.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flexmetric
-Version: 0.3.2
+Version: 0.3.3
 Summary: A secure flexible Prometheus exporter for commands, databases, functions, and scripts.
 Home-page: https://github.com/nikhillingadhal1999/flexmetric
 Author: Nikhil Lingadhal
@@ -160,6 +160,27 @@ commands:
     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`           | The **name** of the metric (`disk_usage`). This is the metric name seen in Prometheus. |
+| `command`        | The **shell command** to execute (`df -h` in this case).                    |
+| `label`          | The **label name** to attach to the metric (`path`).                        |
+| `label_column`   | The **column index** from the command's output to use as the label. Here `-1` means the **last column** (typically the mount path in `df -h`). |
+| `value_column`   | The **column index** from the command's output to extract the **numeric value**. Here `4` refers to the fifth column, which is usually the **Use%** in `df -h`. |
+| `timeout_seconds`| How long (in seconds) to wait for the command before timing out. Here it's set to `60` seconds. |
+
+## Database mode
+
 ```yaml
 databases:
   - name: mydb
@@ -175,6 +196,8 @@ queries:
     label: table
     label_value: users
 ```
+## Functions mode
+
 executable_functions.txt 
 ```
 function_name_1

{flexmetric-0.3.2.dist-info → flexmetric-0.3.3.dist-info}/RECORD

@@ -11,8 +11,8 @@ flexmetric/metric_process/expiring_queue.py,sha256=1oC0MjloitPiRo7yDgVarz81ETEQa
 flexmetric/metric_process/process_commands.py,sha256=QAsR5uXt6rku_lTrBCfslerpqW0hMLSffzUFmxPC-fw,3556
 flexmetric/metric_process/prometheus_agent.py,sha256=hjPmNhJiB-844CgIcaw5A-VLmJqyMwQ_j1e_GI-UPSo,7422
 flexmetric/metric_process/views.py,sha256=05UbGBrAkEn_aJq7qBb_1yphCfnXiTqmXFLznMMpkN8,1194
-flexmetric-0.3.2.dist-info/METADATA,sha256=0imUzfRyM5YKgh-KWA9rtaiZ3ogZyScZLUAQFKH6dH0,8691
-flexmetric-0.3.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-flexmetric-0.3.2.dist-info/entry_points.txt,sha256=urVePn5EWr3JqNvkYP7OsB_h2_Bqvv-Wq1MJRBexm8A,79
-flexmetric-0.3.2.dist-info/top_level.txt,sha256=zBlrNwKhXUNhgu9RRZnXxYwYnmE-eocRe6wKSmQROA4,11
-flexmetric-0.3.2.dist-info/RECORD,,
+flexmetric-0.3.3.dist-info/METADATA,sha256=C6LEjLX8FxXysm4SvZ016r8m1IvxKEHllgeJrWtTcp8,9921
+flexmetric-0.3.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flexmetric-0.3.3.dist-info/entry_points.txt,sha256=urVePn5EWr3JqNvkYP7OsB_h2_Bqvv-Wq1MJRBexm8A,79
+flexmetric-0.3.3.dist-info/top_level.txt,sha256=zBlrNwKhXUNhgu9RRZnXxYwYnmE-eocRe6wKSmQROA4,11
+flexmetric-0.3.3.dist-info/RECORD,,