initial checkin

Gets postgres values for servers , parses the output and writes specific values in a Confluence wiki page

SVN: 24147

openbis_all/source/python/gather_postgres_stats.py

+#!/usr/bin/python
+
+'''
+  Copyright 2012 ETH Zuerich, CISD
+ 
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+ 
+       http://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+'''
+
+# @author  Manuel Kohler
+
+import subprocess
+import shlex
+import getpass
+import xmlrpclib
+import ConfigParser
+from datetime import datetime
+
+
+SERVERS = {
+            "openbis@openbis-phosphonetx.ethz.ch" : "phosphonetx",
+            "openbis@obis.ethz.ch" : "yeastx",
+            "openbis@lmc-openbis.ethz.ch" : "lmc",
+            "openbis@infectx01.ethz.ch" : "infectx",
+            "sbsuser@openbis-dsu.ethz.ch" : "dsu",
+            "openbis@bs-plasmids.ethz.ch" : "csb",
+            "openbis@openbis-scu.ethz.ch" : "scu",
+            "openbis@basysbio.ethz.ch" : "basybio",
+            "openbis@openbis-cina.ethz.ch" : "cina",
+            "openbis@limb.ethz.ch" : "limb",
+            "openbis@newchipdb.ethz.ch" : "newchipdb",
+            "openbis@basynthec.ethz.ch" : "basynthec",
+            "openbis@sprint-openbis.ethz.ch" : "sprint",
+            "openbis@cisd-openbis.ethz.ch" : "demo"
+           }
+
+PSQL_PROPERTIES = ["archive_mode",
+                   "bgwriter_delay",
+                   "bgwriter_lru_maxpages",
+                   "bgwriter_lru_multiplier",
+                   "checkpoint_segments",
+                   "checkpoint_timeout",
+                   "effective_cache_size",
+                   "effective_io_concurrency",
+                   "maintenance_work_mem",
+                   "max_connections",
+                   "server_version",
+                   "shared_buffers",
+                   "temp_buffers",
+                   "wal_segment_size",
+                  ]
+
+SSH_BIN = "/usr/bin/ssh"
+SSH_PARAMETERS = "-oConnectTimeout=5"
+PSQL_BIN = "/usr/bin/psql"
+PSQL_PARAMETERS = " -Upostgres -c \\\"show all;\\\""
+
+SINGLE_SPACE = " "
+DOUBLE_QUOTE = "\""
+NEWLINE = "\n"
+PIPE = "|"
+
+SERVER = 'https://wiki-bsse.ethz.ch:8443/rpc/xmlrpc'
+CONFIGFILE = "wikiPostgres.conf"
+
+ConfluenceToken = None
+ConfluenceServer = xmlrpclib.ServerProxy(SERVER)
+
+def parseConfigurationFile():
+  '''
+  Python 2.7 Style
+  reads out the settings defined in the config file
+  '''
+  config = ConfigParser.ConfigParser()
+  config.read(CONFIGFILE)
+  return config
+
+def getTimestamp():
+   return datetime.now().strftime("%d %b %Y %H:%M:%S")
+   
+def logIntoConfluence(config):
+  '''
+  Logs user into Confluence and returns a session token
+  '''
+  user = config.get("DEFAULT", "username")
+  password = config.get("DEFAULT", "password")
+  ConfluenceToken = ConfluenceServer.confluence1.login(user, password)
+  return ConfluenceToken
+  
+def logOutConluence(token):
+  '''
+  Logs out from confluence and invalidates the session token
+  '''
+  ConfluenceServer.confluence1.logout(token)
+  
+def writeToConfluence (serverMap, token, config):
+  '''
+  Builds the content of the page and writes it into confluence 
+  '''
+  wikiMarkup = ""
+  
+  spacekey = config.get("DEFAULT", "spacekey")
+  pagetitle = config.get("DEFAULT", "pagetitle")
+  
+  page = ConfluenceServer.confluence1.getPage(token, spacekey, pagetitle)
+  if page is None:
+      exit("Could not find page " + spacekey + ":" + pagetitle)
+  
+  wikiMarkup = "h1. Server List" + NEWLINE
+  wikiMarkup += "{table-plus:|autoNumber=true}" + NEWLINE
+  wikiMarkup += PIPE + SINGLE_SPACE + PIPE
+  
+  for server in (serverMap.iterkeys()):
+    wikiMarkup += PIPE + PIPE + SERVERS[server]
+  wikiMarkup += NEWLINE
+    
+  try:
+    for property in PSQL_PROPERTIES:
+      wikiMarkup += PIPE + property + PIPE
+      for server in (serverMap.iterkeys()):
+         wikiMarkup += serverMap[server][property] + PIPE    
+      wikiMarkup += NEWLINE
+  except:
+    print("Not run correctly! Check ssh logins.")  
+  
+  wikiMarkup += NEWLINE + "{table-plus}"
+  wikiMarkup += NEWLINE + "Last update:" + SINGLE_SPACE + getTimestamp()
+  
+  page["content"] = wikiMarkup
+  ConfluenceServer.confluence1.storePage(token, page)
+  
+def callCommandLine(args):
+  '''
+  Calls a command line program and returns the standard out
+  '''
+  SplitArgs = shlex.split(args)
+  print(args)
+  p = subprocess.Popen(SplitArgs, stdout = subprocess.PIPE, stderr = subprocess.PIPE)
+  out, err = p.communicate()
+  return out
+
+def dictOutput (commandLineOutput):
+  '''
+  Parses the psql output and puts it into a dictionary which is the return value 
+  '''
+  # skip the header  
+  settingsList = commandLineOutput.split("\n")[2:]
+  settingsDict = {}
+  for item in settingsList:
+    try:
+      splittedItem = item.split("|")[:-1]
+      key, value = splittedItem[0].strip() , splittedItem[1].strip()
+      settingsDict[key] = value
+    except IndexError:
+      pass
+    except AttributeError:
+      settingsDict[key] = [value]
+  return settingsDict
+
+def  main():
+  serverMap = {}
+  
+  config = parseConfigurationFile()
+  confluenceToken = logIntoConfluence(config)
+  
+  for (server, alias) in SERVERS.items():
+    args = SSH_BIN + SINGLE_SPACE + SSH_PARAMETERS + SINGLE_SPACE + server + SINGLE_SPACE + \
+      DOUBLE_QUOTE + PSQL_BIN + PSQL_PARAMETERS + DOUBLE_QUOTE
+    commandLineOutput = callCommandLine(args)
+    sDict = dictOutput (commandLineOutput)
+    serverMap [server] = sDict
+  
+  writeToConfluence(serverMap, confluenceToken, config)
+  logOutConluence(confluenceToken)
+    
+if __name__ == "__main__":
+  main()