forked from flakshack/SysAdminBoard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
webserver.py
185 lines (153 loc) · 8 KB
/
webserver.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
#!/usr/bin/env python
"""webserver.py - This is the main script. It will launch a webserver and startup the other scripts in other threads.
Find the MODULES section below to enable or disable individual modules (ensure they work by executing them by
themselves first.
"""
# Be sure to use pip to install CherryPy and routes:
# pip install CherryPy
# pip install routes
import cherrypy
from cherrypy.lib.static import serve_file
from cherrypy.process.plugins import Daemonizer # will become active when Daemonizer is uncommented below
import os
import json
import logging.config
import requests
from requests.packages.urllib3.exceptions import InsecureRequestWarning
class SysAdminBoardModule:
""" This class will take the specified module name, import the module file and setup the callback functions
with CherryPy to gather data.
"""
all_modules = [] # Static array containing all modules
def __init__(self, module_name):
logger = logging.getLogger("SysAdminBoardModule")
# Dynamically import the python module file
self.module_name = module_name
logger.info("Importing module: " + module_name)
self.module = __import__(module_name)
self.frequency = self.module.SAMPLE_INTERVAL
self.data = self.module.MonitorJSON() # Custom class to store the JSON data
# Add a thread in CherryPy to execute our callback funciton
logger.debug("Creating callback function for: " + module_name)
cherrypy.process.plugins.Monitor(cherrypy.engine, self.callback_function, frequency=self.frequency).subscribe()
# Rather than wait for the first CherryPy timer to trigger, we'll gather the first set of data now
logger.debug("First run of: " + module_name)
try:
self.callback_function()
except Exception as error:
# No matter what exception we hit here, we don't want this to stop other modules from running.
logger.error("Error setting callback function " + str(error))
pass
self.__class__.all_modules.append(self) # Add self to static array
# Define the callback function that CherryPy will call every interval to gather data
def callback_function(self):
self.module.generate_json(self.data)
# Define a web URL to return the static file (named with module_name.html)
@cherrypy.expose
def index(self, **params):
return serve_file(os.path.join(STATIC_DIR, self.module_name + '.html'))
# Define a web URL to return the ajax json data
@cherrypy.expose
def ajax(self, **params):
# cherrypy.response.headers["Access-Control-Allow-Origin"] = "*" # Bypass Javascript security for testing only
cherrypy.response.headers['Content-Type'] = 'application/json'
return self.data.json.encode('utf8') # In Python3 data has to be utf8 encoded
class MyWebServer(object):
"""This is the main CherryPy WebServer class that defines the URLs available."""
# The following HTML will be displayed if someone browses to this webserver directly.
@cherrypy.expose
def index(self, **params):
html = """<html><head><title>SysAdminBoard</title></head><body>
<p>See: <a href="https://github.com/flakshack/SysAdminBoard">https://github.com/flakshack/SysAdminBoard</a>
</p>
<p>Here is a list of active modules and data sources:</p>"""
for sb_module in SysAdminBoardModule.all_modules:
html += '<a href="/' + sb_module.module_name + '?desktop">' + sb_module.module_name + '</a><br/>'
html += '<a href="/' + sb_module.module_name + '/ajax">' + sb_module.module_name + ' Ajax Data</a><br/>'
return html
# =================MAIN==============
# Setup logging to capture errors
# When run by itself, we need to create the logger object (which is normally created in webserver.py)
try:
f = open("log_settings.json", 'rt')
log_config = json.load(f)
f.close()
logging.config.dictConfig(log_config)
except FileNotFoundError as e:
print("Log configuration file not found: " + str(e))
logging.basicConfig(level=logging.DEBUG) # fallback to basic settings
except json.decoder.JSONDecodeError as e:
print("Error parsing logger config file: " + str(e))
raise
logger = logging.getLogger("SysAdminBoard Main")
logger.warn("Disabling SSL certificate verification log messages")
requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
# =====================================================================================================
#
#
# MODULES
#
#
# ====================================================================================================
# Specify the modules you want to execute. (put a # comment in front of modules to disable them).
# SysAdminBoardModule('sample')
SysAdminBoardModule('sample')
# SysAdminBoardModule('msexchange')
# SysAdminBoardModule('snmp_interface_1')
# SysAdminBoardModule('snmp_interface_2')
# SysAdminBoardModule('snmp_interface_3')
# SysAdminBoardModule('snmp_interface_4')
# SysAdminBoardModule('snmp_interface_5')
# SysAdminBoardModule('snmp_interface_6')
# SysAdminBoardModule('snmp_environmental_1')
# SysAdminBoardModule('tintri')
# SysAdminBoardModule('rubrik')
# SysAdminBoardModule('vmware_host')
# SysAdminBoardModule('vmware_view_host')
# SysAdminBoardModule('vmware_view_vm')
# SysAdminBoardModule('vmware_vm')
# SysAdminBoardModule('helpdesk_byuser')
# SysAdminBoardModule('helpdesk_bycategory')
# SysAdminBoardModule('nutanix_vdi')
# SysAdminBoardModule('nutanix_svr')
# SysAdminBoardModule('nutanix_vm_vdi')
# SysAdminBoardModule('nutanix_vm_svr')
# SysAdminBoardModule('nutanix_vm_cpu_ready')
# SysAdminBoardModule('vmware_vm_nutanix_cvm_vdi')
# SysAdminBoardModule('vmware_vm_nutanix_cvm_svr')
# =====================================================================================================
#
# =====================================================================================================
root = MyWebServer()
mapper = cherrypy.dispatch.RoutesDispatcher() # Used to manually map URLs to functions in CherryPy
# Loop through all of the modules we've enabled and establish a CherryPy URL using the RoutesDispatcher.
# The URLs are based on the module name. For example, if the module name is vmware_host, then the URLs will be:
# http://server/vmware_host and http://server/vmware_host/ajax
for sysadminboard_module in SysAdminBoardModule.all_modules:
logger.debug("Mapping module: " + sysadminboard_module.module_name + " to webserver routes / & /ajax")
# The root URL: http://server/
mapper.connect("index", "/", controller=root, action='index')
mapper.connect(sysadminboard_module.module_name, "/" + sysadminboard_module.module_name,
controller=sysadminboard_module, action='index')
mapper.connect(sysadminboard_module.module_name + '/ajax', "/" + sysadminboard_module.module_name + '/ajax',
controller=sysadminboard_module, action='ajax')
# Here we define a location for non-python files
CURRENT_DIR = os.path.dirname(os.path.abspath(__file__))
STATIC_DIR = os.path.join(CURRENT_DIR, "static")
CONFIG = {
'/': {
'request.dispatch': mapper, # use a dispatcher to assign URLs
},
'/static': {
'tools.staticdir.on': True,
'tools.staticdir.dir': STATIC_DIR
},
}
# =================Disable this line when debugging==============
Daemonizer(cherrypy.engine).subscribe() # When we start, do it as a daemon process
# ===============================================================
logger.info("Starting up SysAdminBoard web server...")
cherrypy.log.access_log.propagate = False # Disable access logging
cherrypy.config.update({'server.socket_host': '0.0.0.0'}) # Listen on all local IPs (on port 8080)
cherrypy.tree.mount(root, '/', config=CONFIG) # Mount the app on the root
cherrypy.engine.start() # Start the web server