[checkmk-commits] wato_remove_nonsite_folders.py: New helper script for distributed slave sites.

Module: check_mk Branch: master Commit: ac62a6c91151acaac48bda3ec76ed1c0a1563671 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=ac62a6c91151ac… Author: Andreas Boesl &lt;ab(a)mathias-kettner.de&gt; Date: Fri Apr 22 15:18:55 2016 +0200 wato_remove_nonsite_folders.py: New helper script for distributed slave sites. It removes all wato folders which are not related to the site. This reduces the number of the configuration files, and in the end the size of the Check_MK Helper processes (when using the CMC). --- doc/treasures/wato_remove_nonsite_folders.py | 157 ++++++++++++++++++++++++++ 1 file changed, 157 insertions(+) diff --git a/doc/treasures/wato_remove_nonsite_folders.py b/doc/treasures/wato_remove_nonsite_folders.py new file mode 100644 index 0000000..6fa605d --- /dev/null +++ b/doc/treasures/wato_remove_nonsite_folders.py @@ -0,0 +1,157 @@ +#!/usr/bin/python +# encoding: utf-8 +# +------------------------------------------------------------------+ +# | ____ _ _ __ __ _ __ | +# | / ___| |__ ___ ___| | __ | \/ | |/ / | +# | | | | '_ \ / _ \/ __| |/ / | |\/| | ' / | +# | | |___| | | | __/ (__| < | | | | . \ | +# | \____|_| |_|\___|\___|_|\_\___|_| |_|_|\_\ | +# | | +# | Copyright Mathias Kettner 2016 mk(a)mathias-kettner.de | +# +------------------------------------------------------------------+ +# +# This file is part of Check_MK. +# The official homepage is at http://mathias-kettner.de/check_mk. +# +# check_mk is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation in version 2. check_mk is distributed +# in the hope that it will be useful, but WITHOUT ANY WARRANTY; with- +# out even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU General Public License for more de- +# tails. You should have received a copy of the GNU General Public +# License along with GNU Make; see the file COPYING. If not, write +# to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, +# Boston, MA 02110-1301 USA. + +######################################## +# >>>>>>>>>>>> IMPORTANT <<<<<<<<<<<<<< +# This script deletes subfolders in the ~/etc/check_mk/conf.d/wato directory +# It should only be used in slave sites. You have been warned... +######################################## + +# The purpose of this script is to remove WATO folders in slave sites which +# do not have any reference to the site. The positive site effect of this +# operation is a reduced size of the ~/var/check_mk/core/config.mk, which represents +# the configuration for the "Check_MK Check Helpers". +# A smaller configuration results in smaller helper processes + +# The deletion of the nonsite folders is always triggered in a hook right before the +# "Activate changes" action, internally named pre-activate-changes. Keep in mind that +# this script delete folders, rules and hosts. Other scripts in the pre-activate-changes +# block might receive outdated information, where all hosts are still present. + +# Installation: +# Copy this file to a distributed monitoring slave site in the site folder +# ~/local/share/check_mk/web/plugins/wato +# and restart the apache afterwards. A restart of the monitoring core is also advised, +# since the check helpers are not fully restarted during a core reload. + +# The umodified version of this script only creates a logfile in +# ~/var/log/remove_nonsite_folders.log, showing the required actions. +# If you want the script to actually remove the folders you need to change +# the parameter do_remove_folders (just below) to True. + +import pprint + +def remove_nonrelated_site_folders(effective_hosts): + # Note: most of the paths here are hardcorded + # I do not want to use any helper functions from the WATO world, because + # they might change over time. + + # Set this true if you actually want to delete folders + # If you just want to start a dry run, leave this at False and have a + # look in the logfile + do_remove_folders = False + + logfile = file(os.path.expanduser("~/var/log/remove_site_folders.log"), "w") + def log_info(info): + logfile.write(info + "\n") + + # Is this a master or a viewer site? -> return + if os.path.exists(defaults.default_config_dir + "/multisite.d/sites.mk"): + return + + # The own site id is written into the distributed_wato.mk file. If it's missing -> return + if not os.path.exists(defaults.check_mk_configdir + "/distributed_wato.mk"): + return + + # Parse the file with the site name + file_vars_g = {} + file_vars = {} + try: + execfile(defaults.check_mk_configdir + "/distributed_wato.mk", file_vars_g, file_vars) + except Exception, e: + # Return on any error + return + our_site = file_vars.get("distributed_wato_site") + + if not our_site: + # Looks like the file is empty -> return + return + + + # Get all folders in WATO dir + config_dir = defaults.check_mk_configdir + "/wato/" + all_folders = sorted([x[0][len(config_dir):] for x in os.walk(config_dir)])[1:] # Skip first folder (WATO root!) + + keep_folders = set([]) + total_hosts = 0 + for host, attributes in effective_hosts.items(): + host_folder = attributes[".folder"][".path"] + + host_site = None + host_tags = attributes.get(".tags", []) + for tag in host_tags: + if tag.startswith("site:"): + host_site = tag.split(":", 1)[1] + break + if not host_site: + # Site host tag not available. Keep this folder + keep_folders.add(host_folder) + continue + + if host_site == our_site: + total_hosts += 1 + keep_folders.add(host_folder) + + + def folder_required(foldername): + for folder in keep_folders: + if folder.startswith(foldername): + return True + else: + return False + + remove_folders = [] + for folder in all_folders: + if not folder_required(folder): + remove_folders.append(folder) + + + if do_remove_folders: + import shutil + for folder in remove_folders: + if folder: # This is just another safety mechanism to prevent the deletion of the + # WATO root folder. The WATO root folder should never appear in this list of folders, + # because it is filtered out earlier on. Just in case.. + the_folder = "%s%s" % (config_dir, folder) + if os.path.exists(the_folder): + shutil.rmtree(the_folder) + + log_info("Did actually remove folders (no dry run): %s" % do_remove_folders) + + # Log the outcome + log_info("\nAll folders\n##############") + log_info("\n".join(all_folders)) + log_info("\nKeep folders\n##############") + log_info("\n".join(keep_folders)) + log_info("\nRemove folders\n##############") + log_info("\n".join(remove_folders)) + log_info("\nTotal hosts of current site %s" % total_hosts) + + +register_hook("pre-activate-changes", remove_nonrelated_site_folders) + + +