Add get_label_values.py function.

Author: nikola-milikic

examples/get_label_values.py

@@ -0,0 +1,85 @@
+#!/usr/bin/env python
+#
+# This script demonstrates how to use the `get_label_values` function to retrieve values
+# for a specific label and render the output as a table.
+#
+
+import sys
+from sdcclient import SdcClient
+
+def render_label_values_as_table(label_values):
+    if not label_values:
+        print("No values found for the specified label.")
+        return
+
+    # Calculate the maximum width for the value column
+    max_width = max(len(value) for value in label_values)
+
+    # Create a horizontal separator
+    separator = "+" + "-" * (max_width + 2) + "+"
+
+    # Create the header row
+    header = f"| {'Value'.ljust(max_width)} |"
+
+    # Create the rows for each label value
+    rows = [f"| {value.ljust(max_width)} |" for value in label_values]
+
+    # Combine everything into a table
+    print(f"{separator}\n{header}\n{separator}\n" + "\n".join(rows) + f"\n{separator}")
+
+
+#
+# Parse arguments
+#
+if len(sys.argv) != 3:
+    print(('usage: %s <sysdig-token> <label-name>' % sys.argv[0]))
+    print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
+    sys.exit(1)
+
+sdc_token = sys.argv[1]
+
+sdclient = SdcClient(sdc_token)
+
+#
+# The label name to fetch values for
+#
+label_name = "job"
+
+#
+# Optional matchers to filter the label values
+#
+match = None  # Replace with a list of matchers if needed
+
+#
+# Optional limit
+#
+limit = 10  # Set to None to disable the limit
+
+#
+# Fetch label values
+#
+ok, response_json = sdclient.get_label_values(label_name, match=match, limit=limit)
+
+#
+# Show the result
+#
+if ok:
+    #
+    # Read the response. The JSON looks like this:
+    #
+    # {
+    #     "data": [
+    #         "fluentd-default",
+    #         "harbor-registry-default",
+    #         "k8s-cadvisor-default",
+    #         "k8s-kubelet-default",
+    #         "k8s-pods",
+    #         "k8s-pvc-default",
+    #     ],
+    #     "status": "success"
+    # }
+    #
+    label_values = response_json.get("data", [])
+    render_label_values_as_table(label_values)
+else:
+    print("Error retrieving label values:", response_json)

sdcclient/_common.py

@@ -566,6 +566,32 @@ def get_labels(self, match=None, limit=None):
         res = self.http.get(url, headers=self.hdrs, params=params)
         return self._request_result(res)
 
+    def get_label_values(self, label_name, match=None, limit=None):
+        '''**Description**
+            Retrieve the values for a specific label.
+
+        **Arguments**
+            - **label_name**: the name of the label to retrieve values for.
+            - **match**: a list of PromQL matchers to filter the label values.
+            - **limit**: the maximum number of returned values. A value of 0 disables the limit.
+
+        **Success Return Value**
+            A list of values for the specified label.
+
+        **Examples**
+            - `examples/get_label_values.py`
+        '''
+        params = {}
+
+        if match:
+            params["match[]"] = match  # `match` should be a list of matchers
+        if limit:
+            params["limit"] = limit
+
+        url = f"{self.url}/prometheus/api/v1/label/{label_name}/values"
+        res = self.http.get(url, headers=self.hdrs, params=params)
+        return self._request_result(res)
+
     def get_sysdig_captures(self, from_sec=None, to_sec=None, scope_filter=None):
         '''**Description**
             Returns the list of sysdig captures for the user.