Optional url

CHANGES.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 2.0.0
+
+- Changed prometheus url to be optional.
+  (Existing actions passing url as an empty string must be updated by removing the url parameter.)
+
 # 1.0.0
 
 * Drop Python 2.7 support

actions/lib/prometheus.py

@@ -6,6 +6,7 @@
 except ImportError:
     from urllib3.exceptions import InsecureRequestWarning
 from st2common.runners.base_action import Action
+
 requests.packages.urllib3.disable_warnings(InsecureRequestWarning)  # pylint: disable=no-member
 
 

actions/query.py

@@ -7,7 +7,7 @@ class PrometheusQuery(PrometheusAPI):
     def __init__(self, config):
         super(PrometheusQuery, self).__init__(config=config)
 
-    def run(self, query, url):
-        url_temp = self.url if url == "" else url
+    def run(self, query, url=None):
+        url_temp = self.url if url is None else url
         endpoint = "{}/api/v1/query".format(url_temp)
         return True, self._get(endpoint, params={"query": query})

actions/query.yaml

@@ -12,3 +12,4 @@ parameters:
   url:
     description: "Prometheus Url"
     type: string
+    required: false

actions/series.py

@@ -7,8 +7,8 @@ class PrometheusSeries(PrometheusAPI):
     def __init__(self, config):
         super(PrometheusSeries, self).__init__(config=config)
 
-    def run(self, queries, url):
+    def run(self, queries, url=None):
         params = ['match[]=' + query for __, query in queries.iteritems()]
-        url_temp = self.url if url == "" else url
+        url_temp = self.url if url is None else url
         endpoint = "{}/api/v1/series?{}".format(url_temp, '&'.join(params))
         return True, self._get(endpoint, None)

actions/series.yaml

@@ -1,14 +1,12 @@
 ---
-
 name: series
 description: 'Query Prometheus Series API'
-
 runner_type: python-script
 entry_point: series.py
-
 parameters:
   queries:
     type: object
   url:
-    description: "Prometheus Url"
+    description: "Prometheus URL"
     type: string
+    required: false

actions/targets.py

@@ -7,7 +7,7 @@ class PrometheusTarget(PrometheusAPI):
     def __init__(self, config):
         super(PrometheusTarget, self).__init__(config=config)
 
-    def run(self, url):
-        url_temp = self.url if url == "" else url
+    def run(self, url=None):
+        url_temp = self.url if url is None else url
         endpoint = "{}/api/v1/targets".format(url_temp)
         return True, self._get(endpoint, None)

actions/targets.yaml

@@ -1,12 +1,10 @@
 ---
-
-name: Targets
+name: targets
 description: 'Prometheus Targets API'
-
 runner_type: python-script
 entry_point: targets.py
-
 parameters:
   url:
-    description: "Prometheus Url"
+    description: "Prometheus URL"
     type: string
+    required: false

config.schema.yaml

@@ -1,7 +1,5 @@
 ---
-
 url:
   description: "Prometheus Url"
   type: string
   required: true
-

pack.yaml

@@ -6,7 +6,7 @@ keywords:
     - prometheus
     - monitoring
     - metrics
-version: 1.0.0
+version: 2.0.0
 python_versions:
     - "3"
 author: Daniel Chamot