Add get_labels endpoint

Author: nikola-milikic

examples/get_labels.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python
+#
+# This script demonstrates how to use the `get_labels` function to retrieve metadata
+# about label names and render the output as a table.
+#
+
+import sys
+from sdcclient import SdcClient
+
+def render_labels_as_table(labels):
+    if not labels:
+        print("No labels found.")
+        return
+
+    # Calculate the maximum width for the label column
+    max_width = max(len(label) for label in labels)
+
+    # Create a horizontal separator
+    separator = "+" + "-" * (max_width + 2) + "+"
+
+    # Create the header row
+    header = f"| {'Label'.ljust(max_width)} |"
+
+    # Create the rows for each label
+    rows = [f"| {label.ljust(max_width)} |" for label in labels]
+
+    # 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) != 2:
+    print(('usage: %s <sysdig-token>' % 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)
+
+#
+# Optional matchers to filter the labels
+#
+match = [
+    'up'
+]  # Replace with a list of matchers if needed
+
+#
+# Optional limit
+#
+limit = 10  # Set to None to disable the limit
+
+#
+# Fetch labels
+#
+ok, response_json = sdclient.get_labels(match=match, limit=limit)
+
+#
+# Show the result
+#
+if ok:
+    #
+    # Read the response. The JSON looks like this:
+    #
+    # {
+    #     "status":   "success",
+    #     "data": [
+    #         "agent_id",
+    #         "k8s_app",
+    #         "kube_pod_uid",
+    #         "kubernetes_io_cluster_service",
+    #         "container_image_tag",
+    #         "cloud_provider_tag_team",
+    #         "cloud_provider_tag_expirationDate",
+    #         "kube_pod_label_kubernetes_azure_com_managedby",
+    #     ]
+    # }
+    #
+    labels = response_json.get("data", [])
+    render_labels_as_table(labels)
+else:
+    print("Error retrieving labels:", response_json)

sdcclient/_common.py

@@ -541,6 +541,31 @@ def get_series(self, match, start=None, end=None, limit=None):
         res = self.http.get(url, headers=self.hdrs, params=params)
         return self._request_result(res)
 
+    def get_labels(self, match=None, limit=None):
+        '''**Description**
+            Retrieve metadata about label names.
+
+        **Arguments**
+            - **match**: a list of PromQL matchers to filter the labels.
+            - **limit**: the maximum number of returned labels. A value of 0 disables the limit.
+
+        **Success Return Value**
+            A list of available labels.
+
+        **Examples**
+            - `examples/get_labels.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/labels"
+        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.