From 9fec7340c703f0bf6033b2103b6530aa06fe0733 Mon Sep 17 00:00:00 2001 From: Franziska Kunsmann Date: Sun, 11 Apr 2021 11:13:42 +0200 Subject: [PATCH 1/5] add requests to requirements.txt --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index 618cd8d..ea09288 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ Mako tomlkit +requests From fee4b8dac03d5a5225dff47a1b25b02df77c2f01 Mon Sep 17 00:00:00 2001 From: Franziska Kunsmann Date: Sun, 11 Apr 2021 11:17:48 +0200 Subject: [PATCH 2/5] remove debug print --- service.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/service.py b/service.py index b0fc09e..fa7c9bb 100755 --- a/service.py +++ b/service.py @@ -114,9 +114,6 @@ class StatusPage: if __name__ == "__main__": page = StatusPage() + service_details = page.get_services_per_host() - - from pprint import pprint - pprint(service_details) - page.render_html(service_details) From 0a0ee1bbfc26d99fc384ddf8265361948093201c Mon Sep 17 00:00:00 2001 From: Franziska Kunsmann Date: Sat, 20 May 2023 20:08:08 +0200 Subject: [PATCH 3/5] add some logging and error handling --- error.html | 36 ++++++++++++++++++++++++++++++++++++ service.py | 39 +++++++++++++++++++++++++++++++++++---- 2 files changed, 71 insertions(+), 4 deletions(-) create mode 100644 error.html diff --git a/error.html b/error.html new file mode 100644 index 0000000..9ec024a --- /dev/null +++ b/error.html @@ -0,0 +1,36 @@ + + + + + ${title} + + + + + +
+ +
+
+
+
+

Something went wrong

+
+
+

+ There was an error rendering the status page. + Admins have been notified. +

+
+
+
+
+
+ + diff --git a/service.py b/service.py index fa7c9bb..51f0543 100755 --- a/service.py +++ b/service.py @@ -3,10 +3,13 @@ import requests import urllib3 from os import environ +import sys +import logging import tomlkit from mako.template import Template - +import shutil +from datetime import datetime urllib3.disable_warnings() CONFIGFILE = environ.get('STATUSPAGE_CONFIG', 'config.toml') @@ -14,6 +17,8 @@ CONFIGFILE = environ.get('STATUSPAGE_CONFIG', 'config.toml') class StatusPage: def get_api_result(self): if self.services: + log.debug('services already exist, returning early') + return self.services headers = { @@ -23,7 +28,7 @@ class StatusPage: requestbody = { "attrs": [ "name", "state", "last_check_result", "host_name", "display_name" ], - "joins": [ "host.name", "host.state", "host.last_check_result", "host.vars" ], + "joins": [ "host", "host.state", "host.last_check_result", "host.vars" ], "filter": self.config['filters']['services'], } @@ -35,11 +40,16 @@ class StatusPage: verify=False ) + self.logger.info(f'got http status code {r.status_code}') + self.logger.debug(r.text) + if (r.status_code == 200): self.services = r.json()['results'] else: r.raise_for_status() + self.logger.info(f'got {len(self.services)} services from api') + return self.services @@ -60,6 +70,9 @@ class StatusPage: result = {} for service in self.get_api_result(): + self.logger.info(f'now processing {service["attrs"]["host_name"]} "{service["attrs"]["display_name"]}"') + self.logger.debug(service) + host = service['joins']['host']['vars']['pretty_name'] if host not in result: @@ -84,6 +97,7 @@ class StatusPage: 'badge': state_to_design_mapping[state][0], 'state': state_to_design_mapping[state][1], } + self.logger.info(f'ragecounter is now {self.ragecounter}') return result @@ -96,12 +110,18 @@ class StatusPage: else: mood = '🔥' + self.logger.info('rendering output html') + + start = datetime.now() template = Template(filename=self.config['output'].get('template', 'template.html')) output = template.render( title=self.config['output'].get('page_title', 'Status Page'), mood=mood, hosts=service_details, ) + end = datetime.now() + + self.logger.info(f'rendered in {(end-start).total_seconds():.09f}s') with open(self.config['output']['filename'], 'w') as f: f.write(output) @@ -112,8 +132,19 @@ class StatusPage: self.services = {} self.ragecounter = 0 + self.logger = logging.getLogger('StatusPage') + handler = logging.StreamHandler(sys.stdout) + formatter = logging.Formatter('%(levelname)s {%(filename)s:%(lineno)d} %(message)s') + handler.setFormatter(formatter) + self.logger.addHandler(handler) + self.logger.setLevel(self.config.get('loglevel', 'INFO')) + if __name__ == "__main__": page = StatusPage() - service_details = page.get_services_per_host() - page.render_html(service_details) + try: + service_details = page.get_services_per_host() + page.render_html(service_details) + except Exception as e: + shutil.copyfile('error.html', page.config['output']['filename']) + raise e From 9f4f2818c525dcadf6de52121b0abb021ebe7c34 Mon Sep 17 00:00:00 2001 From: Franziska Kunsmann Date: Sat, 20 May 2023 20:09:16 +0200 Subject: [PATCH 4/5] can haz some formatting? --- service.py | 61 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 24 deletions(-) diff --git a/service.py b/service.py index 51f0543..d81b7d3 100755 --- a/service.py +++ b/service.py @@ -1,19 +1,21 @@ #!/usr/bin/env python3 -import requests -import urllib3 -from os import environ -import sys - import logging -import tomlkit -from mako.template import Template import shutil +import sys from datetime import datetime +from os import environ + +import requests +import tomlkit +import urllib3 +from mako.template import Template + urllib3.disable_warnings() CONFIGFILE = environ.get('STATUSPAGE_CONFIG', 'config.toml') + class StatusPage: def get_api_result(self): if self.services: @@ -21,14 +23,17 @@ class StatusPage: return self.services - headers = { - 'Accept': 'application/json', - 'X-HTTP-Method-Override': 'GET' - } + headers = {'Accept': 'application/json', 'X-HTTP-Method-Override': 'GET'} requestbody = { - "attrs": [ "name", "state", "last_check_result", "host_name", "display_name" ], - "joins": [ "host", "host.state", "host.last_check_result", "host.vars" ], + "attrs": [ + "name", + "state", + "last_check_result", + "host_name", + "display_name", + ], + "joins": ["host", "host.state", "host.last_check_result", "host.vars"], "filter": self.config['filters']['services'], } @@ -36,14 +41,17 @@ class StatusPage: '{}/v1/objects/services'.format(self.config['icinga2_api']['baseurl']), headers=headers, json=requestbody, - auth=(self.config['icinga2_api']['username'], self.config['icinga2_api']['password']), - verify=False + auth=( + self.config['icinga2_api']['username'], + self.config['icinga2_api']['password'], + ), + verify=False, ) self.logger.info(f'got http status code {r.status_code}') self.logger.debug(r.text) - if (r.status_code == 200): + if r.status_code == 200: self.services = r.json()['results'] else: r.raise_for_status() @@ -52,14 +60,12 @@ class StatusPage: return self.services - def prettify(self, text): for search, replace in self.config.get('prettify', {}).items(): text = text.replace(search, replace) return text - def get_services_per_host(self): state_to_design_mapping = [ ('success', 'OK'), @@ -70,7 +76,9 @@ class StatusPage: result = {} for service in self.get_api_result(): - self.logger.info(f'now processing {service["attrs"]["host_name"]} "{service["attrs"]["display_name"]}"') + self.logger.info( + f'now processing {service["attrs"]["host_name"]} "{service["attrs"]["display_name"]}"' + ) self.logger.debug(service) host = service['joins']['host']['vars']['pretty_name'] @@ -93,7 +101,9 @@ class StatusPage: if state in (1, 2): self.ragecounter += state - result[host]['services'][self.prettify(service['attrs']['display_name'])] = { + result[host]['services'][ + self.prettify(service['attrs']['display_name']) + ] = { 'badge': state_to_design_mapping[state][0], 'state': state_to_design_mapping[state][1], } @@ -101,7 +111,6 @@ class StatusPage: return result - def render_html(self, service_details): if self.ragecounter == 0: mood = '🆗' @@ -113,7 +122,9 @@ class StatusPage: self.logger.info('rendering output html') start = datetime.now() - template = Template(filename=self.config['output'].get('template', 'template.html')) + template = Template( + filename=self.config['output'].get('template', 'template.html') + ) output = template.render( title=self.config['output'].get('page_title', 'Status Page'), mood=mood, @@ -126,7 +137,6 @@ class StatusPage: with open(self.config['output']['filename'], 'w') as f: f.write(output) - def __init__(self): self.config = tomlkit.loads(open(CONFIGFILE).read()) self.services = {} @@ -134,11 +144,14 @@ class StatusPage: self.logger = logging.getLogger('StatusPage') handler = logging.StreamHandler(sys.stdout) - formatter = logging.Formatter('%(levelname)s {%(filename)s:%(lineno)d} %(message)s') + formatter = logging.Formatter( + '%(levelname)s {%(filename)s:%(lineno)d} %(message)s' + ) handler.setFormatter(formatter) self.logger.addHandler(handler) self.logger.setLevel(self.config.get('loglevel', 'INFO')) + if __name__ == "__main__": page = StatusPage() From 6e349ad35cbaddf942d9740d502f23f67e799f50 Mon Sep 17 00:00:00 2001 From: Franziska Kunsmann Date: Sun, 21 May 2023 11:24:58 +0200 Subject: [PATCH 5/5] auto-reload status page after 30 seconds --- error.html | 5 +++++ template.html | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/error.html b/error.html index 9ec024a..df90698 100644 --- a/error.html +++ b/error.html @@ -32,5 +32,10 @@ + diff --git a/template.html b/template.html index 9916ce3..2734803 100644 --- a/template.html +++ b/template.html @@ -39,5 +39,10 @@ % endfor +