Add default 5s requests timeout and make configurable

Author: satterly

alertaclient/api.py

@@ -31,12 +31,15 @@ def __call__(self, r):
 
 class ApiClient(object):
 
-    def __init__(self, endpoint=None, key=None, ssl_verify=True):
+    def __init__(self, endpoint=None, key=None, timeout=5.0, ssl_verify=True):
 
         self.endpoint = endpoint or os.environ.get('ALERTA_ENDPOINT', "http://localhost:8080")
         self.key = key or os.environ.get('ALERTA_API_KEY', '')
-        self.ssl_verify = ssl_verify  # or REQUESTS_CA_BUNDLE env var
+
         self.session = requests.Session()
+        self.session.verify = ssl_verify  # or use REQUESTS_CA_BUNDLE env var
+
+        self.timeout = float(timeout)
 
     def __repr__(self):
 
@@ -176,7 +179,12 @@ def _get(self, path, query=None):
         query = query or tuple()
 
         url = self.endpoint + path + '?' + urlencode(query, doseq=True)
-        response = self.session.get(url, auth=ApiAuth(self.key), verify=self.ssl_verify)
+
+        try:
+            response = self.session.get(url, auth=ApiAuth(self.key), timeout=self.timeout)
+        except requests.exceptions.RequestException as e:
+            LOG.error(e)
+            sys.exit(1)
 
         LOG.debug('Request Headers: %s', response.request.headers)
 
@@ -190,7 +198,11 @@ def _post(self, path, data=None):
         url = self.endpoint + path
         headers = {'Content-Type': 'application/json'}
 
-        response = self.session.post(url, data=data, headers=headers, auth=ApiAuth(self.key), verify=self.ssl_verify)
+        try:
+            response = self.session.post(url, data=data, headers=headers, auth=ApiAuth(self.key), timeout=self.timeout)
+        except requests.exceptions.RequestException as e:
+            LOG.error(e)
+            sys.exit(1)
 
         LOG.debug('Request Headers: %s', response.request.headers)
         LOG.debug('Request Body: %s', data)
@@ -205,8 +217,11 @@ def _put(self, path, data=None):
         url = self.endpoint + path
         headers = {'Content-Type': 'application/json'}
 
-        response = self.session.put(url, data=data, headers=headers, auth=ApiAuth(self.key), verify=self.ssl_verify)
-
+        try:
+            response = self.session.put(url, data=data, headers=headers, auth=ApiAuth(self.key), timeout=self.timeout)
+        except requests.exceptions.RequestException as e:
+            LOG.error(e)
+            sys.exit(1)
         LOG.debug('Request Headers: %s', response.request.headers)
         LOG.debug('Request Body: %s', data)
 
@@ -218,7 +233,12 @@ def _put(self, path, data=None):
     def _delete(self, path):
 
         url = self.endpoint + path
-        response = self.session.delete(url, auth=ApiAuth(self.key), verify=self.ssl_verify)
+
+        try:
+            response = self.session.delete(url, auth=ApiAuth(self.key), timeout=self.timeout)
+        except requests.exceptions.RequestException as e:
+            LOG.error(e)
+            sys.exit(1)
 
         LOG.debug('Request Headers: %s', response.request.headers)
 

alertaclient/shell.py

@@ -39,6 +39,7 @@
     'endpoint':    'http://localhost:8080',
     'key':         '',
     'timezone':    'Europe/London',
+    'timeout':     5.0,
     'sslverify':   True,
     'output':      'text',
     'color':       True,
@@ -71,11 +72,11 @@ class AlertCommand(object):
 
     def __init__(self):
 
-        self.api = ApiClient()
+        self.api = None
 
-    def set(self, endpoint, key, ssl_verify=True):
+    def set(self, endpoint, key, timeout, ssl_verify=True):
 
-        self.api = ApiClient(endpoint=endpoint, key=key, ssl_verify=ssl_verify)
+        self.api = ApiClient(endpoint=endpoint, key=key, timeout=timeout, ssl_verify=ssl_verify)
 
     def send(self, args):
 
@@ -94,7 +95,7 @@ def send(self, args):
             attributes=dict([attrib.split('=') for attrib in args.attributes]),
             origin=args.origin,
             event_type=args.event_type,
-            timeout=args.timeout,
+            timeout=args.expires,
             raw_data=args.raw_data
         )
 
@@ -113,7 +114,7 @@ def heartbeat(self, args):
         heartbeat = Heartbeat(
             origin=args.origin,
             tags=args.tags,
-            timeout=args.timeout
+            timeout=args.expires
         )
 
         response = self.api.send(heartbeat)
@@ -934,6 +935,7 @@ def run(self):
         )
         parser_send.add_argument(
             '--timeout',
+            dest='expires',
             default=DEFAULT_TIMEOUT,
             help='Timeout in seconds before an "open" alert will be automatically "expired" or "deleted"',
             type=int
@@ -1292,6 +1294,7 @@ def run(self):
         )
         parser_heartbeat.add_argument(
             '--timeout',
+            dest='expires',
             default=None,
             help='Timeout in seconds before a heartbeat will be considered stale',
             type=int
@@ -1460,7 +1463,7 @@ def run(self):
             args.filters += ['id='+i for i in args.ids]
         args.output = 'json' if args.json else args.output
 
-        cli.set(endpoint=args.endpoint, key=args.key, ssl_verify=args.sslverify)
+        cli.set(endpoint=args.endpoint, key=args.key, timeout=args.timeout, ssl_verify=args.sslverify)
 
         if hasattr(args, 'func'):
             args.func(args)