Checkmk git commits December 2018

checkmk-commits@lists.checkmk.com

15 participants
342 discussions

by Lars Michelsen

Module: check_mk Branch: master Commit: 0b6ce14d7c19367432d7bee55ddeba8b98595a73 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=0b6ce14d7c1936… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Sun Dec 16 10:24:31 2018 +0100 Made cmk.utils a component * Moved previous cmk.utils stuff to cmk.utils.misc, but is still accessible from cmk.utils.* for compatibility. * Future: Move all "library" stuff that is meant to be usable from all other components to cmk.utils. The goal is to have a cmk.* layer which only contains the modules for the different components of Check_MK. Change-Id: I5cb4f6e3d0cffc35df4de0452f4d7a01a2d5a4c5 --- cmk/utils/__init__.py | 34 ++++++++++++++++++++++++++++++++++ cmk/{utils.py => utils/misc.py} | 0 2 files changed, 34 insertions(+) diff --git a/cmk/utils/__init__.py b/cmk/utils/__init__.py new file mode 100644 index 0000000..7f9b36d --- /dev/null +++ b/cmk/utils/__init__.py @@ -0,0 +1,34 @@ +#!/usr/bin/env python +# -*- encoding: utf-8; py-indent-offset: 4 -*- +# +------------------------------------------------------------------+ +# | ____ _ _ __ __ _ __ | +# | / ___| |__ ___ ___| | __ | \/ | |/ / | +# | | | | '_ \ / _ \/ __| |/ / | |\/| | ' / | +# | | |___| | | | __/ (__| < | | | | . \ | +# | \____|_| |_|\___|\___|_|\_\___|_| |_|_|\_\ | +# | | +# | Copyright Mathias Kettner 2014 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. + +# TODO: Kept for compatibility. Clean up call sites. +# Or even better: move the functions from misc to a better place +from cmk.utils.misc import ( + make_utf8, + quote_shell_string, + pnp_cleanup, + cmp_config_paths, +) diff --git a/cmk/utils.py b/cmk/utils/misc.py similarity index 100% rename from cmk/utils.py rename to cmk/utils/misc.py

5 years, 6 months

Moved some more cmk modules to cmk.utils

by Lars Michelsen

Module: check_mk Branch: master Commit: ea85885c7ab76bc9b929107eff930b38c8f9ba83 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=ea85885c7ab76b… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Mon Dec 17 07:45:33 2018 +0100 Moved some more cmk modules to cmk.utils Change-Id: I09c9779af1be257a1dd20bc2c87a5e749a2063c4 --- active_checks/check_cpu_peaks | 2 +- agents/special/agent_bi | 5 +- agents/special/agent_kubernetes | 5 +- bin/mkbackup | 2 +- cmk/ec/main.py | 4 +- cmk/gui/backup.py | 2 +- cmk/gui/crash_reporting.py | 6 +- cmk/gui/inventory.py | 3 +- cmk/gui/plugins/views/painters.py | 2 +- cmk/gui/plugins/wato/utils/__init__.py | 2 +- cmk/gui/prediction.py | 12 +- cmk/gui/wato/__init__.py | 4 +- cmk/gui/wato/pages/check_catalog.py | 2 +- cmk/gui/werks.py | 28 +- cmk/notification_plugins/mail.py | 2 +- cmk/{ => utils}/cpu_tracking.py | 2 +- cmk/{ => utils}/crash_reporting.py | 0 cmk/{ => utils}/man_pages.py | 2 +- cmk/{ => utils}/prediction.py | 0 cmk/{ => utils}/profile.py | 6 +- cmk/{ => utils}/schedule.py | 0 cmk/{ => utils}/site.py | 0 cmk/{ => utils}/structured_data.py | 0 cmk/{ => utils}/translations.py | 0 cmk/{ => utils}/tty.py | 0 cmk/{ => utils}/werks.py | 0 cmk_base/automations/check_mk.py | 6 +- cmk_base/checking.py | 4 +- cmk_base/classic_snmp.py | 2 +- cmk_base/config.py | 7 +- cmk_base/console.py | 2 +- cmk_base/core.py | 2 +- cmk_base/core_config.py | 2 +- cmk_base/core_nagios.py | 2 +- cmk_base/crash_reporting.py | 2 +- cmk_base/data_sources/abstract.py | 4 +- cmk_base/data_sources/tcp.py | 6 +- cmk_base/discovery.py | 2 +- cmk_base/dump_host.py | 2 +- cmk_base/inventory.py | 4 +- cmk_base/localize.py | 2 +- cmk_base/modes/check_mk.py | 8 +- cmk_base/nagios_utils.py | 4 +- cmk_base/packaging.py | 8 +- cmk_base/parent_scan.py | 2 +- cmk_base/piggyback.py | 2 +- cmk_base/prediction.py | 25 +- cmk_base/snmp.py | 2 +- cmk_base/snmp_scan.py | 2 +- scripts/create-changelog.py | 6 +- scripts/precompile-werks.py | 6 +- tests/git/test_permissions.py | 5 +- tests/integration/cmk/test_site_werks.py | 10 +- .../cmk_base/test_services_prediction.py | 23 +- tests/unit/checkman/test_manpages.py | 11 - .../cmk/structured_data/test_structured_data.py | 405 ++++++++++++++------- tests/unit/cmk/test_cpu_tracking.py | 3 +- tests/unit/cmk/test_crash_reporting.py | 11 +- tests/unit/cmk/test_man_pages.py | 2 +- tests/unit/cmk/test_prediction_commons.py | 2 +- tests/unit/cmk/test_schedule.py | 8 +- tests/unit/cmk/test_werks.py | 35 +- web/app/index.wsgi | 3 +- 63 files changed, 422 insertions(+), 301 deletions(-) Diff: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commitdiff;h=ea85885c7a…

5 years, 6 months

azure.include: add bytes per second formatter

by Moritz Kiemer

Module: check_mk Branch: master Commit: ba12fb5d63f19fbe64af8208e285e573e616c63c URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=ba12fb5d63f19f… Author: Moritz Kiemer <mo(a)mathias-kettner.de> Date: Mon Dec 17 07:47:41 2018 +0100 azure.include: add bytes per second formatter CMK-1409 Change-Id: I6c1fa86a05ac4f37b82074ec99769a8ba53039f2 --- checks/azure.include | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/checks/azure.include b/checks/azure.include index 52e074c..f610508 100644 --- a/checks/azure.include +++ b/checks/azure.include @@ -25,6 +25,14 @@ # Boston, MA 02110-1301 USA. import json +_AZURE_METRIC_FMT = { + "percent": get_percent_human_readable, + "bytes": get_bytes_human_readable, + "bytes_per_second": lambda b: "%s/s" % get_bytes_human_readable(b), + "seconds": lambda s: "%.2f s" % s, + "milli_seconds": lambda ms: "%d ms" % (ms * 1000), +} + def azure_iter_informative_attrs(resource, include_keys=('location',)): def cap(string): # not quite what str.title() does @@ -74,12 +82,7 @@ def check_azure_metric( value *= 100. unit = "percent" - formatter = { - "percent": get_percent_human_readable, - "bytes": get_bytes_human_readable, - "seconds": lambda s: "%.2f s" % s, - "milli_seconds": lambda ms: "%d ms" % (ms * 1000), - }.get(unit, str) + formatter = _AZURE_METRIC_FMT.get(unit, str) text = "%s: %s" % (display_name, formatter(value)) l_state, u_state = 0, 0

5 years, 6 months

Add new man page category for containerization

by Lars Michelsen

Module: check_mk Branch: master Commit: f49a1e76ea5bd70c75bcc4623703e0efc5b721b4 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=f49a1e76ea5bd7… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Mon Dec 17 11:42:57 2018 +0100 Add new man page category for containerization Change-Id: I466216696354d1d06e586c18ce6087ed1b70b5b2 --- checkman/docker_container_cpu | 2 +- checkman/docker_container_diskstat | 2 +- checkman/docker_container_mem | 2 +- checkman/docker_container_status | 2 +- checkman/docker_container_status.health | 2 +- checkman/docker_node_disk_usage | 4 ++-- checkman/docker_node_info | 2 +- checkman/docker_node_info.containers | 4 ++-- checkman/k8s_component_statuses | 4 ++-- checkman/k8s_conditions | 4 ++-- checkman/k8s_namespaces | 4 ++-- checkman/k8s_nodes | 4 ++-- checkman/k8s_persistent_volume_claims | 4 ++-- checkman/k8s_persistent_volumes | 4 ++-- checkman/k8s_resources.cpu | 4 ++-- checkman/k8s_resources.memory | 4 ++-- checkman/k8s_resources.pods | 4 ++-- checkman/k8s_roles | 4 ++-- checkman/k8s_storage_classes | 4 ++-- cmk/man_pages.py | 3 +++ 20 files changed, 35 insertions(+), 32 deletions(-) diff --git a/checkman/docker_container_cpu b/checkman/docker_container_cpu index 3a872e3..743ca75 100644 --- a/checkman/docker_container_cpu +++ b/checkman/docker_container_cpu @@ -1,6 +1,6 @@ title: Docker container CPU utilization agents: linux -catalog: app/docker +catalog: containerization/docker license: GPL distribution: check_mk description: diff --git a/checkman/docker_container_diskstat b/checkman/docker_container_diskstat index 6df80a0..21e1b40 100644 --- a/checkman/docker_container_diskstat +++ b/checkman/docker_container_diskstat @@ -1,6 +1,6 @@ title: Docker container disk throughput agents: linux -catalog: app/docker +catalog: containerization/docker license: GPL distribution: check_mk description: diff --git a/checkman/docker_container_mem b/checkman/docker_container_mem index 4ccb9e9..2d1151e 100644 --- a/checkman/docker_container_mem +++ b/checkman/docker_container_mem @@ -1,6 +1,6 @@ title: Docker container memory usage agents: linux -catalog: app/docker +catalog: containerization/docker license: GPL distribution: check_mk description: diff --git a/checkman/docker_container_status b/checkman/docker_container_status index 9789593..154ad23 100644 --- a/checkman/docker_container_status +++ b/checkman/docker_container_status @@ -1,6 +1,6 @@ title: Docker container status agents: linux -catalog: app/docker +catalog: containerization/docker license: GPL distribution: check_mk description: diff --git a/checkman/docker_container_status.health b/checkman/docker_container_status.health index 434d12f..83d861b 100644 --- a/checkman/docker_container_status.health +++ b/checkman/docker_container_status.health @@ -1,6 +1,6 @@ title: Docker container health agents: linux -catalog: app/docker +catalog: containerization/docker license: GPL distribution: check_mk description: diff --git a/checkman/docker_node_disk_usage b/checkman/docker_node_disk_usage index bb6dc2c..fcfe6ad 100644 --- a/checkman/docker_node_disk_usage +++ b/checkman/docker_node_disk_usage @@ -1,6 +1,6 @@ title: Docker node disk usage agents: linux -catalog: app/docker +catalog: containerization/docker license: GPL distribution: check_mk description: @@ -8,4 +8,4 @@ description: reclaimable size of containers, images, local volumes, and build cache. inventory: - One service per type (i.e. containers, images, volumen, build cache) is created. \ No newline at end of file + One service per type (i.e. containers, images, volumen, build cache) is created. diff --git a/checkman/docker_node_info b/checkman/docker_node_info index b90895f..cd1f8c6 100644 --- a/checkman/docker_node_info +++ b/checkman/docker_node_info @@ -1,6 +1,6 @@ title: Docker Node Info agents: linux -catalog: app/docker +catalog: containerization/docker license: GPL distribution: check_mk description: diff --git a/checkman/docker_node_info.containers b/checkman/docker_node_info.containers index f797abe..67c7dfd 100644 --- a/checkman/docker_node_info.containers +++ b/checkman/docker_node_info.containers @@ -1,6 +1,6 @@ title: Docker Node Info Containers agents: linux -catalog: app/docker +catalog: containerization/docker license: GPL distribution: check_mk description: @@ -9,4 +9,4 @@ description: for each of these values. inventory: - One service is created. \ No newline at end of file + One service is created. diff --git a/checkman/k8s_component_statuses b/checkman/k8s_component_statuses index 2d1d799..b71ce59 100644 --- a/checkman/k8s_component_statuses +++ b/checkman/k8s_component_statuses @@ -1,6 +1,6 @@ title: Kubernetes component status agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -12,4 +12,4 @@ inventory: One service per component is created. item: - The name of the component. \ No newline at end of file + The name of the component. diff --git a/checkman/k8s_conditions b/checkman/k8s_conditions index af804d0..c18318d 100644 --- a/checkman/k8s_conditions +++ b/checkman/k8s_conditions @@ -1,6 +1,6 @@ title: Kubernetes conditions agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -10,4 +10,4 @@ description: {CRIT} otherwise {OK}. inventory: - One service is created for each condition and one for the readiness status. \ No newline at end of file + One service is created for each condition and one for the readiness status. diff --git a/checkman/k8s_namespaces b/checkman/k8s_namespaces index 6bcb152..8a6f014 100644 --- a/checkman/k8s_namespaces +++ b/checkman/k8s_namespaces @@ -1,6 +1,6 @@ title: Kubernetes namespaces agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -11,4 +11,4 @@ inventory: One service per namespace is created. item: - The name of the namespace. \ No newline at end of file + The name of the namespace. diff --git a/checkman/k8s_nodes b/checkman/k8s_nodes index dac4da6..5bc6ac4 100644 --- a/checkman/k8s_nodes +++ b/checkman/k8s_nodes @@ -1,6 +1,6 @@ title: Kubernetes nodes agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -8,4 +8,4 @@ description: It always returns {OK}. inventory: - One service is created. \ No newline at end of file + One service is created. diff --git a/checkman/k8s_persistent_volume_claims b/checkman/k8s_persistent_volume_claims index bb77c91..3f738ea 100644 --- a/checkman/k8s_persistent_volume_claims +++ b/checkman/k8s_persistent_volume_claims @@ -1,6 +1,6 @@ title: Kubernetes persistent volume claims agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -12,4 +12,4 @@ inventory: One service per persistent volume claim is created. item: - The name of the persistent volume claim. \ No newline at end of file + The name of the persistent volume claim. diff --git a/checkman/k8s_persistent_volumes b/checkman/k8s_persistent_volumes index 5320ceb..93466e3 100644 --- a/checkman/k8s_persistent_volumes +++ b/checkman/k8s_persistent_volumes @@ -1,6 +1,6 @@ title: Kubernetes persistent volumes agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -11,4 +11,4 @@ inventory: One service per persistent volume is created. item: - The name of the persistent volume. \ No newline at end of file + The name of the persistent volume. diff --git a/checkman/k8s_resources.cpu b/checkman/k8s_resources.cpu index 98499d7..e5ce1ae 100644 --- a/checkman/k8s_resources.cpu +++ b/checkman/k8s_resources.cpu @@ -1,6 +1,6 @@ title: Kubernetes CPU resources agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -12,4 +12,4 @@ description: for the CPU usage, i.e. the ratio between requested and allocatable CPU. inventory: - One service is created. \ No newline at end of file + One service is created. diff --git a/checkman/k8s_resources.memory b/checkman/k8s_resources.memory index 733aeb6..2a33c60 100644 --- a/checkman/k8s_resources.memory +++ b/checkman/k8s_resources.memory @@ -1,6 +1,6 @@ title: Kubernetes memory resources agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -12,4 +12,4 @@ description: for the Memory usage, i.e. the ratio between requested and allocatable Memory. inventory: - One service is created. \ No newline at end of file + One service is created. diff --git a/checkman/k8s_resources.pods b/checkman/k8s_resources.pods index 750f3ba..4fc8181 100644 --- a/checkman/k8s_resources.pods +++ b/checkman/k8s_resources.pods @@ -1,6 +1,6 @@ title: Kubernetes pod resources agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -10,4 +10,4 @@ description: for the Pod usage, i.e. the ratio between used and allocatable Pods. inventory: - One service is created. \ No newline at end of file + One service is created. diff --git a/checkman/k8s_roles b/checkman/k8s_roles index e84c6f4..4a8e541 100644 --- a/checkman/k8s_roles +++ b/checkman/k8s_roles @@ -1,6 +1,6 @@ title: Kubernetes roles agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -11,4 +11,4 @@ inventory: One service is per role created. item: - The name of the role. \ No newline at end of file + The name of the role. diff --git a/checkman/k8s_storage_classes b/checkman/k8s_storage_classes index aa69a23..321c344 100644 --- a/checkman/k8s_storage_classes +++ b/checkman/k8s_storage_classes @@ -1,6 +1,6 @@ title: Kubernetes storage classes agents: linux -catalog: app/kubernetes +catalog: containerization/kubernetes license: GPL distribution: check_mk description: @@ -11,4 +11,4 @@ inventory: One service per storage class is created. item: - The name of the storage class. \ No newline at end of file + The name of the storage class. diff --git a/cmk/man_pages.py b/cmk/man_pages.py index caf2ed3..e9c43a0 100644 --- a/cmk/man_pages.py +++ b/cmk/man_pages.py @@ -208,6 +208,9 @@ catalog_titles = { "cloud" : "Cloud Based Environments", "azure" : "Microsoft Azure", "aws" : "Amazon Web Services", + "containerization" : "Containerization", + "docker" : "Docker", + "kubernetes" : "Kubernetes", "agentless": "Networking checks without agent", "generic" : "Generic check plugins", "unsorted" : "Uncategorized",

5 years, 6 months

enviromux*: Fixed invalid check catalog

by Lars Michelsen

Module: check_mk Branch: master Commit: 481d9b5c28e2bb7f5457310cbfc847e93a53e2a4 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=481d9b5c28e2bb… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Mon Dec 17 11:47:11 2018 +0100 enviromux*: Fixed invalid check catalog Change-Id: Ie3a34d8053f7c09775805a49bc322b70fb77829e --- checkman/enviromux | 2 +- checkman/enviromux.humidity | 2 +- checkman/enviromux.voltage | 2 +- checkman/enviromux_aux | 2 +- checkman/enviromux_aux.humidity | 2 +- checkman/enviromux_aux.voltage | 2 +- checkman/enviromux_digital | 2 +- checkman/enviromux_external | 2 +- checkman/enviromux_external.humidity | 2 +- checkman/enviromux_external.voltage | 2 +- checkman/enviromux_sems | 2 +- checkman/enviromux_sems.humidity | 2 +- checkman/enviromux_sems.voltage | 2 +- checkman/enviromux_sems_digital | 2 +- checkman/enviromux_sems_external | 2 +- checkman/enviromux_sems_external.humidity | 2 +- checkman/enviromux_sems_external.voltage | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/checkman/enviromux b/checkman/enviromux index 1501610..536504a 100644 --- a/checkman/enviromux +++ b/checkman/enviromux @@ -1,6 +1,6 @@ title: enviromux_sensors agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux.humidity b/checkman/enviromux.humidity index 58d5fd9..4eb74fd 100644 --- a/checkman/enviromux.humidity +++ b/checkman/enviromux.humidity @@ -1,6 +1,6 @@ title: enviromux.humidity agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux.voltage b/checkman/enviromux.voltage index 4ecaf5a..d2ac8c4 100644 --- a/checkman/enviromux.voltage +++ b/checkman/enviromux.voltage @@ -1,6 +1,6 @@ title: enviromux.voltage agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_aux b/checkman/enviromux_aux index a9e4048..7df269e 100644 --- a/checkman/enviromux_aux +++ b/checkman/enviromux_aux @@ -1,6 +1,6 @@ title: enviromux_aux agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_aux.humidity b/checkman/enviromux_aux.humidity index 347e159..d6bcee3 100644 --- a/checkman/enviromux_aux.humidity +++ b/checkman/enviromux_aux.humidity @@ -1,6 +1,6 @@ title: enviromux_aux.humidity agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_aux.voltage b/checkman/enviromux_aux.voltage index 9ee0443..c401584 100644 --- a/checkman/enviromux_aux.voltage +++ b/checkman/enviromux_aux.voltage @@ -1,6 +1,6 @@ title: enviromux_aux.voltage agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_digital b/checkman/enviromux_digital index 5a9d1fb..0b4d6cb 100644 --- a/checkman/enviromux_digital +++ b/checkman/enviromux_digital @@ -1,6 +1,6 @@ title: enviromux_digital agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_external b/checkman/enviromux_external index eca7990..3e0763e 100644 --- a/checkman/enviromux_external +++ b/checkman/enviromux_external @@ -1,6 +1,6 @@ title: enviromux_external agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_external.humidity b/checkman/enviromux_external.humidity index 1601240..a0f3ed8 100644 --- a/checkman/enviromux_external.humidity +++ b/checkman/enviromux_external.humidity @@ -1,6 +1,6 @@ title: enviromux_external.humidity agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_external.voltage b/checkman/enviromux_external.voltage index a044b21..3dc19fd 100644 --- a/checkman/enviromux_external.voltage +++ b/checkman/enviromux_external.voltage @@ -1,6 +1,6 @@ title: enviromux_external.voltage agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_sems b/checkman/enviromux_sems index 22f4b67..88a9f90 100644 --- a/checkman/enviromux_sems +++ b/checkman/enviromux_sems @@ -1,6 +1,6 @@ title: enviromux_sensors_sems agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_sems.humidity b/checkman/enviromux_sems.humidity index abfb11f..af8ee3e 100644 --- a/checkman/enviromux_sems.humidity +++ b/checkman/enviromux_sems.humidity @@ -1,6 +1,6 @@ title: enviromux_sems.humidity agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_sems.voltage b/checkman/enviromux_sems.voltage index 79af4ce..c4cf6c0 100644 --- a/checkman/enviromux_sems.voltage +++ b/checkman/enviromux_sems.voltage @@ -1,6 +1,6 @@ title: enviromux_sems.voltage agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_sems_digital b/checkman/enviromux_sems_digital index 55989a8..3fdbd0b 100644 --- a/checkman/enviromux_sems_digital +++ b/checkman/enviromux_sems_digital @@ -1,6 +1,6 @@ title: enviromux_digital_sems agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_sems_external b/checkman/enviromux_sems_external index 71d288a..4682f34 100644 --- a/checkman/enviromux_sems_external +++ b/checkman/enviromux_sems_external @@ -1,6 +1,6 @@ title: enviromux_external_sems agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_sems_external.humidity b/checkman/enviromux_sems_external.humidity index 0d0fa4d..8da75cf 100644 --- a/checkman/enviromux_sems_external.humidity +++ b/checkman/enviromux_sems_external.humidity @@ -1,6 +1,6 @@ title: enviromux_external_sems.humidity agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description: diff --git a/checkman/enviromux_sems_external.voltage b/checkman/enviromux_sems_external.voltage index 8da95ec..f5b5f74 100644 --- a/checkman/enviromux_sems_external.voltage +++ b/checkman/enviromux_sems_external.voltage @@ -1,6 +1,6 @@ title: enviromux_external_sems.voltage agents: snmp -catalog: hardware/environment/nti +catalog: hw/environment/nti license: GPL distribution: check_mk description:

5 years, 6 months

aws_s3_summary: Fixed wrong catalog entry

by Lars Michelsen

Module: check_mk Branch: master Commit: 279b4d83e510682c800e1b7066deca13c3552eb5 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=279b4d83e51068… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Mon Dec 17 11:34:03 2018 +0100 aws_s3_summary: Fixed wrong catalog entry Change-Id: Ibefd696d9c8e605952fe491195ea0a4e933f93ae --- checkman/aws_s3_summary | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/checkman/aws_s3_summary b/checkman/aws_s3_summary index 88d4e3e..531a082 100644 --- a/checkman/aws_s3_summary +++ b/checkman/aws_s3_summary @@ -1,6 +1,6 @@ title: AWS S3 Summary agents: aws -catalog: applications +catalog: cloud/aws license: GPL distribution: check_mk description:

5 years, 6 months

Host attributes: Cleaned up host tag attribute class a bit

by Lars Michelsen

Module: check_mk Branch: master Commit: 54c9c00b27f5127c4a1d85c16fa34ce1959d61c4 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=54c9c00b27f512… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Thu Dec 13 13:37:11 2018 +0100 Host attributes: Cleaned up host tag attribute class a bit CMK-1421 Change-Id: Idb38827cccca0679b04d8be0db335f90f8448446 --- cmk/gui/plugins/wato/__init__.py | 1 + cmk/gui/plugins/wato/builtin_attributes.py | 2 +- cmk/gui/plugins/wato/utils/__init__.py | 1 + cmk/gui/watolib.py | 53 ++++++++++++++++-------------- 4 files changed, 31 insertions(+), 26 deletions(-) diff --git a/cmk/gui/plugins/wato/__init__.py b/cmk/gui/plugins/wato/__init__.py index 0cf4541..3e4aa20 100644 --- a/cmk/gui/plugins/wato/__init__.py +++ b/cmk/gui/plugins/wato/__init__.py @@ -81,6 +81,7 @@ from cmk.gui.plugins.wato.utils import ( multifolder_host_rule_match_conditions, multisite_dir, NagiosTextAttribute, + NagiosValueSpecAttribute, PluginCommandLine, PredictiveLevels, config_variable_group_registry, diff --git a/cmk/gui/plugins/wato/builtin_attributes.py b/cmk/gui/plugins/wato/builtin_attributes.py index a6d3794..f5c3602 100644 --- a/cmk/gui/plugins/wato/builtin_attributes.py +++ b/cmk/gui/plugins/wato/builtin_attributes.py @@ -55,7 +55,7 @@ from cmk.gui.valuespec import ( ) from cmk.gui.exceptions import MKUserError -from . import ( +from cmk.gui.plugins.wato import ( declare_host_attribute, SNMPCredentials, IPMIParameters, diff --git a/cmk/gui/plugins/wato/utils/__init__.py b/cmk/gui/plugins/wato/utils/__init__.py index 52325f2..27b9592 100644 --- a/cmk/gui/plugins/wato/utils/__init__.py +++ b/cmk/gui/plugins/wato/utils/__init__.py @@ -117,6 +117,7 @@ from cmk.gui.watolib import ( folder_preserving_link, ContactGroupsAttribute, NagiosTextAttribute, + NagiosValueSpecAttribute, ValueSpecAttribute, ACTestCategories, ACTest, diff --git a/cmk/gui/watolib.py b/cmk/gui/watolib.py index 1c0627e..54ab44b 100644 --- a/cmk/gui/watolib.py +++ b/cmk/gui/watolib.py @@ -3469,18 +3469,22 @@ class EnumAttribute(Attribute): return html.var(varprefix + "attr_" + self.name(), self.default_value()) -# A selection dropdown for a host tag class HostTagAttribute(Attribute): - def __init__(self, tag_definition): - # Definition is either triple or 4-tuple (with - # dependency definition) - tag_id, title, self._taglist = tag_definition - name = "tag_" + tag_id - if len(self._taglist) == 1: - def_value = None - else: - def_value = self._taglist[0][0] - Attribute.__init__(self, name, title, "", def_value) + """A selection dropdown for a host tag""" + + def __init__(self, tag_id, title, tag_list): + self._taglist = tag_list + super(HostTagAttribute, self).__init__( + name="tag_" + tag_id, + title=title, + help_txt="", + default_value=self._default_tag_value(), + ) + + def _default_tag_value(self): + if not self.is_checkbox_tag(): + return self._taglist[0][0] + return None def is_checkbox_tag(self): return len(self._taglist) == 1 @@ -3490,7 +3494,7 @@ class HostTagAttribute(Attribute): # files the _() function must also be placed in the configuration files # But don't localize empty strings - This empty string is connected to the header # of the .mo file - if len(self._taglist) == 1: + if self.is_checkbox_tag(): title = self._taglist[0][1] if title: title = _u(title) @@ -3523,7 +3527,7 @@ class HostTagAttribute(Attribute): if value != "" and value == tagvalue and secondary_tags: value = value + "|" + "|".join(secondary_tags) - if len(choices) == 1: + if self.is_checkbox_tag(): html.checkbox( varname, value != "", @@ -3535,28 +3539,27 @@ class HostTagAttribute(Attribute): def from_html_vars(self, varprefix): varname = varprefix + "attr_" + self.name() - if len(self._taglist) == 1: + if self.is_checkbox_tag(): if html.get_checkbox(varname): return self._taglist[0][0] return None - else: - # strip of secondary tags - value = html.var(varname).split("|")[0] - if not value: - value = None - return value - # Special function for computing the setting of a specific - # tag group from the total list of tags of a host + # strip of secondary tags + value = html.var(varname).split("|")[0] + if not value: + value = None + return value + def get_tag_value(self, tags): + """Special function for computing the setting of a specific + tag group from the total list of tags of a host""" for entry in self._taglist: if entry[0] in tags: return entry[0] return None - # Return list of host tags to set (handles - # secondary tags) def get_tag_list(self, value): + """Return list of host tags to set (handles secondary tags)""" for entry in self._taglist: if entry[0] == value: if len(entry) >= 3: @@ -3851,7 +3854,7 @@ def declare_host_tag_attributes(): topic = _('Host tags') declare_host_attribute( - HostTagAttribute(entry[:3]), + HostTagAttribute(*entry[:3]), show_in_table=False, show_in_folder=True, editable=attr_editable,

5 years, 6 months

Host attributes: Extracted some host attribute logic from configure_attributes()

by Lars Michelsen

Module: check_mk Branch: master Commit: 8713f1d0c2aebcad9e378787e7e63331b87c8be8 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=8713f1d0c2aebc… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Thu Dec 13 08:59:29 2018 +0100 Host attributes: Extracted some host attribute logic from configure_attributes() * Moved host attribute topic listing and sorting to dedicated function and added a test for the topics and their sorting * Moved host attribute list, filtering and sorting to dedicated function and added a test for the attributes of a topic and their sorting CMK-1421 Change-Id: Iefe9890073cb37a4f25933aec05dfbad3c9888ac --- cmk/gui/plugins/wato/utils/__init__.py | 67 ++++++++------------------------ cmk/gui/watolib.py | 36 +++++++++++++++++ tests/unit/cmk/gui/test_watolib.py | 71 ++++++++++++++++++++++++++++++++++ 3 files changed, 124 insertions(+), 50 deletions(-) diff --git a/cmk/gui/plugins/wato/utils/__init__.py b/cmk/gui/plugins/wato/utils/__init__.py index 5dfeab2..52325f2 100644 --- a/cmk/gui/plugins/wato/utils/__init__.py +++ b/cmk/gui/plugins/wato/utils/__init__.py @@ -1568,65 +1568,33 @@ def configure_attributes(new, if without_attributes is None: without_attributes = [] - # show attributes grouped by topics, in order of their - # appearance. If only one topic exists, do not show topics - # Make sure, that the topics "Basic settings" and host tags - # are always show first. - # TODO: Clean this up! Implement some explicit sorting - topics = [None] - if config.host_tag_groups(): - topics.append(_("Address")) - topics.append(_("Data sources")) - topics.append(_("Host tags")) - - # The remaining topics are shown in the order of the - # appearance of the attribute declarations: - for attr, topic in watolib.all_host_attributes(): - if topic not in topics and attr.is_visible(for_what): - topics.append(topic) - # Collect dependency mapping for attributes (attributes that are only # visible, if certain host tags are set). dependency_mapping_tags = {} dependency_mapping_roles = {} inherited_tags = {} - # Hack to sort the address family host tag attribute above the IPv4/v6 addresses - # TODO: Clean this up by implementing some sort of explicit sorting - def sort_host_attributes(a, b): - if a[0].name() == "tag_address_family": - return -1 - return 0 - volatile_topics = [] hide_attributes = [] - for topic in topics: + for topic, title in watolib.get_sorted_host_attribute_topics(for_what): topic_is_volatile = True # assume topic is sometimes hidden due to dependencies - if len(topics) > 1: - if topic is None: - title = _("Basic settings") - else: - title = _u(topic) - - if topic == _("Host tags"): - topic_id = "wato_host_tags" - elif topic == _("Address"): - topic_id = "address" - elif topic == _("Data sources"): - topic_id = "data_sources" - else: - topic_id = None - forms.header( - title, - isopen=topic in [None, _("Address"), _("Data sources")], - table_id=topic_id, - ) + if topic == _("Host tags"): + topic_id = "wato_host_tags" + elif topic == _("Address"): + topic_id = "address" + elif topic == _("Data sources"): + topic_id = "data_sources" + else: + topic_id = None - for attr, atopic in sorted(watolib.all_host_attributes(), cmp=sort_host_attributes): - if atopic != topic: - continue + forms.header( + title, + isopen=topic in [None, _("Address"), _("Data sources")], + table_id=topic_id, + ) + for attr in watolib.get_sorted_host_attributes_by_topic(topic): attrname = attr.name() if attrname in without_attributes: continue # e.g. needed to skip ipaddress in CSV-Import @@ -1854,9 +1822,8 @@ def configure_attributes(new, html.write_text(explanation) html.close_div() - if len(topics) > 1: - if topic_is_volatile: - volatile_topics.append((topic or _("Basic settings")).encode('utf-8')) + if topic_is_volatile: + volatile_topics.append((topic or _("Basic settings")).encode('utf-8')) forms.end() # Provide Javascript world with the tag dependency information diff --git a/cmk/gui/watolib.py b/cmk/gui/watolib.py index 7ea6af7..1c0627e 100644 --- a/cmk/gui/watolib.py +++ b/cmk/gui/watolib.py @@ -3896,6 +3896,42 @@ def collect_attributes(for_what, do_validate=True, varprefix=""): return host +def get_sorted_host_attribute_topics(for_what): + # show attributes grouped by topics, in order of their + # appearance. If only one topic exists, do not show topics + # Make sure, that the topics "Basic settings" and host tags + # are always show first. + # TODO: Clean this up! Implement some explicit sorting + topics = [None] + if config.host_tag_groups(): + topics.append(_("Address")) + topics.append(_("Data sources")) + topics.append(_("Host tags")) + + # The remaining topics are shown in the order of the + # appearance of the attribute declarations: + for attr, topic in all_host_attributes(): + if topic not in topics and attr.is_visible(for_what): + topics.append(topic) + + return [(t, _("Basic settings") if t is None else _u(t)) for t in topics] + + +def get_sorted_host_attributes_by_topic(topic): + # Hack to sort the address family host tag attribute above the IPv4/v6 addresses + # TODO: Clean this up by implementing some sort of explicit sorting + def sort_host_attributes(a, b): + if a[0].name() == "tag_address_family": + return -1 + return 0 + + attributes = [] + for attr, atopic in sorted(all_host_attributes(), cmp=sort_host_attributes): + if atopic == topic: + attributes.append(attr) + return attributes + + #. # Persistenz: Speicherung der Werte # - WATO speichert seine Variablen für main.mk in conf.d/wato/global.mk diff --git a/tests/unit/cmk/gui/test_watolib.py b/tests/unit/cmk/gui/test_watolib.py index e44a9e9..2528956 100644 --- a/tests/unit/cmk/gui/test_watolib.py +++ b/tests/unit/cmk/gui/test_watolib.py @@ -1664,3 +1664,74 @@ def test_register_check_parameters(monkeypatch): rulespec_names = [r.name for r in watolib.g_rulespecs.get_by_group("static/netblabla")] assert "static_checks:check_group_name" in rulespec_names assert len(rulespec_names) == 1 + + +(a)pytest.mark.parametrize("for_what", [ + "host", + "cluster", + "folder", + "host_search", + "bulk", +]) +def test_host_attribute_topics(for_what): + expected = [ + (None, u"Basic settings"), + (u'Address', u'Address'), + (u'Data sources', u'Data sources'), + (u'Host tags', u'Host tags'), + (u'Management Board', u'Management Board'), + ] + + if for_what == "folder": + expected = [ + (None, u"Basic settings"), + (u'Address', u'Address'), + (u'Data sources', u'Data sources'), + (u'Host tags', u'Host tags'), + (u'Network Scan', u'Network Scan'), + (u'Management Board', u'Management Board'), + ] + + assert watolib.get_sorted_host_attribute_topics(for_what=for_what) == expected + + +(a)pytest.mark.parametrize("for_what", [ + "host", + "cluster", + "folder", + "host_search", + "bulk", +]) +def test_host_attributes(for_what): + topics = { + None: [ + 'contactgroups', + 'alias', + 'snmp_community', + 'parents', + 'site', + 'locked_by', + 'locked_attributes', + ], + "Address": [ + 'ipaddress', + 'ipv6address', + 'additional_ipv4addresses', + 'additional_ipv6addresses', + ], + "Data sources": [], + "Management Board": [ + 'management_address', + 'management_protocol', + 'management_snmp_community', + 'management_ipmi_credentials', + ], + "Network Scan": [ + 'network_scan', + 'network_scan_result', + ], + } + for topic, _title in watolib.get_sorted_host_attribute_topics(for_what): + names = [a.name() for a in watolib.get_sorted_host_attributes_by_topic(topic)] + assert names == topics.get(topic, + []), "Expected attributes not specified for topic %r" % topic

5 years, 6 months

Background jobs: Fixed stop signal handling

by Lars Michelsen

Module: check_mk Branch: master Commit: 915e51e2dc4da0d4ef831bf2d39d2c727e760b7f URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=915e51e2dc4da0… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Sat Dec 15 20:10:32 2018 +0100 Background jobs: Fixed stop signal handling The stoppable background jobs could not be stopped in all situations in a clean way. The signal processing of the background process was prvented by a .join() on the execution thread which prevented the python signal handling from being executed when receiving a SIGTERM to stop the process. Cleaned up signal handling in the job process to use the MKTerminate exception raising up the call stack and make the top run() method set the final job state. Cleaned up logging on the way. Change-Id: I7430a2ad2188dcb00c94437922eeb0866cec664a --- cmk/gui/background_job.py | 30 +++++---- cmk/gui/gui_background_job.py | 3 +- tests/unit/cmk/gui/test_background_job.py | 108 ++++++++++++++++++++++++++++++ 3 files changed, 126 insertions(+), 15 deletions(-) diff --git a/cmk/gui/background_job.py b/cmk/gui/background_job.py index 888e020..2945844 100644 --- a/cmk/gui/background_job.py +++ b/cmk/gui/background_job.py @@ -35,7 +35,7 @@ import threading import time import traceback -import psutil +import psutil # type: ignore from pathlib2 import Path from cmk.gui.i18n import _ @@ -43,7 +43,7 @@ import cmk import cmk.log import cmk.daemon as daemon import cmk.store as store -from cmk.exceptions import MKGeneralException +from cmk.exceptions import MKGeneralException, MKTerminate import cmk.gui.log @@ -131,9 +131,8 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): def __init__(self, job_parameters): super(BackgroundProcess, self).__init__(job_parameters) self._jobstatus = self._job_parameters["jobstatus"] - self._logger = None # the logger is initialized in the run function - - self._register_signal_handlers() + # TODO: Hand over the logger via arguments + self._logger = cmk.gui.log.logger.getChild("background_process") def _register_signal_handlers(self): signal.signal(signal.SIGTERM, self._handle_sigterm) @@ -145,8 +144,7 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): self._job_parameters["job_id"], status["pid"]) return - self._jobstatus.update_status({"state": JobStatus.state_stopped}) - os._exit(0) + raise MKTerminate() def run(self): # Detach from parent (apache) -> Remain running when apache is restarted @@ -168,17 +166,18 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): # The actual function call self._execute_function() + except MKTerminate: + self._logger.warning("Job was stopped") + self._jobstatus.update_status({"state": JobStatus.state_stopped}) except Exception: self._logger.error( "Exception while preparing background function environment", exc_info=True) self._jobstatus.update_status({"state": JobStatus.state_exception}) def initialize_environment(self): - if not self._logger: - self._logger = cmk.gui.log.logger - self._open_stdout_and_stderr() self._enable_logging_to_stdout() + self._register_signal_handlers() self._job_parameters["logger"] = self._logger @@ -190,8 +189,9 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): target=self._call_function_with_exception_handling, args=[self._job_parameters]) t.start() - # Wait for thread to finish - t.join() + # Wait for thread to finish. Do the join with timeout to be able to handle signals + while t.is_alive(): + t.join(0.5) # Final progress info update job_status_update = {} @@ -202,7 +202,6 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): final_state = JobStatus.state_exception else: final_state = JobStatus.state_finished - job_status_update.update({ "state": final_state, "duration": time.time() - job_status["started"], @@ -220,9 +219,11 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): try: func_ptr(*args, **kwargs) + except MKTerminate: + raise except Exception as e: logger = job_interface.get_logger() - logger.error("Exception in background function:\n%s" % (traceback.format_exc())) + logger.error("Exception in background function", exc_info=True) job_interface.send_exception(_("Exception: %s") % (e)) def _open_stdout_and_stderr(self): @@ -492,6 +493,7 @@ class BackgroundJob(object): self._jobstatus.update_status({"pid": p.pid}) except Exception as e: self._logger.error("Error while starting subprocess: %s" % e) + os._exit(1) os._exit(0) diff --git a/cmk/gui/gui_background_job.py b/cmk/gui/gui_background_job.py index 5a7af86..e8ed362 100644 --- a/cmk/gui/gui_background_job.py +++ b/cmk/gui/gui_background_job.py @@ -113,7 +113,8 @@ class GUIBackgroundProcess(background_job.BackgroundProcess): self._log_path_hint = _("More information can be found in ~/var/log/web.log") # Disable html request timeout - html.disable_request_timeout() + if html.in_html_context(): + html.disable_request_timeout() # Close livestatus connections inherited from the parent process sites.disconnect() diff --git a/tests/unit/cmk/gui/test_background_job.py b/tests/unit/cmk/gui/test_background_job.py new file mode 100644 index 0000000..f7e803d --- /dev/null +++ b/tests/unit/cmk/gui/test_background_job.py @@ -0,0 +1,108 @@ +import time +import signal +import sys +import pytest # type: ignore +from pathlib2 import Path +import testlib # type: ignore + +import cmk.paths +import cmk.gui.background_job as background_job +import cmk.gui.gui_background_job as gui_background_job + +import cmk.gui.log + + +(a)pytest.fixture(autouse=True) +def debug_logging(): + cmk.gui.log.set_log_levels({"cmk.web": cmk.gui.log._logging.DEBUG}) + yield + cmk.gui.log.set_log_levels({"cmk.web": cmk.gui.log._logging.WARNING}) + + +(a)pytest.fixture(autouse=True) +def job_base_dir(tmpdir, monkeypatch): + var_dir = Path("%s" % tmpdir) + + log_dir = var_dir / "log" + log_dir.mkdir() # pylint: disable=no-member + + job_dir = var_dir / "background_jobs" + job_dir.mkdir() # pylint: disable=no-member + + # Patch for web.log. Sholdn't we do this for all web tests? + monkeypatch.setattr(cmk.paths, "log_dir", str(log_dir)) + + monkeypatch.setattr(background_job.BackgroundJobDefines, "base_dir", str(job_dir)) + return job_dir + + +(a)gui_background_job.job_registry.register +class DummyBackgroundJob(gui_background_job.GUIBackgroundJob): + job_prefix = "dummy_job" + gui_title = u"Dummy Job" + + def __init__(self): + kwargs = {} + kwargs["title"] = self.gui_title + kwargs["deletable"] = False + kwargs["stoppable"] = True + + super(DummyBackgroundJob, self).__init__(self.job_prefix, **kwargs) + + def execute_hello(self, job_interface): + sys.stdout.write("Hallo :-)\n") + sys.stdout.flush() + + def execute_endless(self): + sys.stdout.write("Hanging loop\n") + sys.stdout.flush() + time.sleep(100) + + +def test_start_job(): + job = DummyBackgroundJob() + job.set_function(job.execute_hello) + + status = job.get_status() + assert status["state"] == background_job.JobStatus.state_initialized + + job.start() + assert job.is_running() + + with pytest.raises(background_job.BackgroundJobAlreadyRunning): + job.start() + assert job.is_running() + + testlib.wait_until( + lambda: job.get_status()["state"] not in [ background_job.JobStatus.state_initialized, background_job.JobStatus.state_running ], + timeout=5, + interval=0.1) + + status = job.get_status() + assert status["state"] == background_job.JobStatus.state_finished + + output = "\n".join(status["loginfo"]["JobProgressUpdate"]) + assert "Initialized background job" in output + assert "Hallo :-)" in output + + +def test_stop_job(): + job = DummyBackgroundJob() + job.set_function(job.execute_endless) + job.start() + + testlib.wait_until( + lambda: "Hanging loop" in job.get_status()["loginfo"]["JobProgressUpdate"], + timeout=5, + interval=0.1) + + status = job.get_status() + assert status["state"] == background_job.JobStatus.state_running + + job.stop() + + status = job.get_status() + assert status["state"] == background_job.JobStatus.state_stopped + + output = "\n".join(status["loginfo"]["JobProgressUpdate"]) + assert "Job was stopped" in output

5 years, 6 months

Simplified background process execution

by Lars Michelsen

Module: check_mk Branch: master Commit: d12c59149c957a0712e41608eeac2200786ac46f URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=d12c59149c957a… Author: Lars Michelsen <lm(a)mathias-kettner.de> Date: Sat Dec 15 20:21:21 2018 +0100 Simplified background process execution * Previous versions used a thread to execute the background job function and monitored this thread from the main thread to collect its output. * This is not needed anymore. Therefore the thread has been removed. Change-Id: I70c30a101de4c612c120a6fdfc3ad2c2a3ce1234 --- cmk/gui/background_job.py | 60 +++++++++++++++-------------------------------- 1 file changed, 19 insertions(+), 41 deletions(-) diff --git a/cmk/gui/background_job.py b/cmk/gui/background_job.py index 2945844..4812b81 100644 --- a/cmk/gui/background_job.py +++ b/cmk/gui/background_job.py @@ -31,7 +31,6 @@ import pprint import shutil import signal import sys -import threading import time import traceback @@ -133,6 +132,7 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): self._jobstatus = self._job_parameters["jobstatus"] # TODO: Hand over the logger via arguments self._logger = cmk.gui.log.logger.getChild("background_process") + self._job_parameters["logger"] = self._logger def _register_signal_handlers(self): signal.signal(signal.SIGTERM, self._handle_sigterm) @@ -147,15 +147,11 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): raise MKTerminate() def run(self): - # Detach from parent (apache) -> Remain running when apache is restarted + # Detach from parent and cleanup inherited file descriptors os.setsid() - daemon.set_procname(BackgroundJobDefines.process_name) daemon.closefrom(0) - ##################### ALL HANDLES HAVE BEEN CLOSED BOUNDARY ########################### - - # Setup environment (Logging, Livestatus handles, etc.) try: self.initialize_environment() self._logger.verbose( @@ -166,6 +162,19 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): # The actual function call self._execute_function() + + # Final status update + job_status = self._jobstatus.get_status() + + if job_status.get("loginfo", {}).get("JobException"): + final_state = JobStatus.state_exception + else: + final_state = JobStatus.state_finished + + self._jobstatus.update_status({ + "state": final_state, + "duration": time.time() - job_status["started"], + }) except MKTerminate: self._logger.warning("Job was stopped") self._jobstatus.update_status({"state": JobStatus.state_stopped}) @@ -175,44 +184,14 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): self._jobstatus.update_status({"state": JobStatus.state_exception}) def initialize_environment(self): + """Setup environment (Logging, Livestatus handles, etc.)""" self._open_stdout_and_stderr() self._enable_logging_to_stdout() self._register_signal_handlers() - self._job_parameters["logger"] = self._logger - def _execute_function(self): - # The specific function is called in a separate thread The main thread - # collects the output produced by the function-thread and updates the - # status file accordingly - t = threading.Thread( - target=self._call_function_with_exception_handling, args=[self._job_parameters]) - t.start() - - # Wait for thread to finish. Do the join with timeout to be able to handle signals - while t.is_alive(): - t.join(0.5) - - # Final progress info update - job_status_update = {} - - # Final status message update - job_status = self._jobstatus.get_status() - if job_status.get("loginfo", {}).get("JobException"): - final_state = JobStatus.state_exception - else: - final_state = JobStatus.state_finished - job_status_update.update({ - "state": final_state, - "duration": time.time() - job_status["started"], - }) - - self._jobstatus.update_status(job_status_update) - - @staticmethod - def _call_function_with_exception_handling(job_parameters): - func_ptr, args, kwargs = job_parameters["function_parameters"] - job_interface = BackgroundProcessInterface(job_parameters) + func_ptr, args, kwargs = self._job_parameters["function_parameters"] + job_interface = BackgroundProcessInterface(self._job_parameters) if "job_interface" in func_ptr.func_code.co_varnames: kwargs["job_interface"] = job_interface @@ -222,8 +201,7 @@ class BackgroundProcess(BackgroundProcessInterface, multiprocessing.Process): except MKTerminate: raise except Exception as e: - logger = job_interface.get_logger() - logger.error("Exception in background function", exc_info=True) + self._logger.error("Exception in background function", exc_info=True) job_interface.send_exception(_("Exception: %s") % (e)) def _open_stdout_and_stderr(self):

5 years, 6 months

← Newer
1
...
11
12
13
14
15
16
17
...
35
Older →

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

Checkmk git commits December 2018