flexmetric 0.3.1__tar.gz → 0.3.3__tar.gz

{flexmetric-0.3.1 → flexmetric-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flexmetric
-Version: 0.3.1
+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
@@ -156,8 +156,31 @@ commands:
   - name: disk_usage
     command: df -h
     label: path
+    label_column: -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`           | 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
@@ -173,6 +196,8 @@ queries:
     label: table
     label_value: users
 ```
+## Functions mode
+
 executable_functions.txt 
 ```
 function_name_1

{flexmetric-0.3.1 → flexmetric-0.3.3}/README.md

@@ -123,8 +123,31 @@ commands:
   - name: disk_usage
     command: df -h
     label: path
+    label_column: -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`           | 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
@@ -140,6 +163,8 @@ queries:
     label: table
     label_value: users
 ```
+## Functions mode
+
 executable_functions.txt 
 ```
 function_name_1

{flexmetric-0.3.1 → flexmetric-0.3.3}/flexmetric.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flexmetric
-Version: 0.3.1
+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
@@ -156,8 +156,31 @@ commands:
   - name: disk_usage
     command: df -h
     label: path
+    label_column: -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`           | 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
@@ -173,6 +196,8 @@ queries:
     label: table
     label_value: users
 ```
+## Functions mode
+
 executable_functions.txt 
 ```
 function_name_1

{flexmetric-0.3.1 → flexmetric-0.3.3}/setup.py

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