Merge pull request #576 from cloudnull/nfs_check

[TURTLES-1547] Add check for NFS

Author: tonytan4ever

playbooks/files/rax-maas/plugins/nfs_check.py

@@ -0,0 +1,89 @@
+#!/usr/bin/env python
+
+# Copyright 2018, Rackspace US, Inc.
+#
+# 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.
+
+import argparse
+import shlex
+import subprocess
+
+from maas_common import metric
+from maas_common import metric_bool
+from maas_common import print_output
+from maas_common import status_err
+from maas_common import status_ok
+
+
+def nfs_export_check():
+    nfs_metrics = dict()
+
+    output = subprocess.check_output(
+        shlex.split(
+            "awk -F':' '/nfs/ {print $1}' /proc/mounts"
+        )
+    )
+    nfs_mounts = output.splitlines()
+    for mount in nfs_mounts:
+        mount_metrics = nfs_metrics[mount] = {'exports': 0, 'online': False}
+        try:
+            exports = subprocess.check_output(
+                shlex.split(
+                    "showmount --no-headers --exports {}".format(mount)
+                )
+            )
+        except subprocess.CalledProcessError:
+            mount_metrics['exports'] = 0
+        else:
+            mount_metrics['exports'] += len(exports.splitlines())
+
+        if mount_metrics['exports'] > 0:
+            mount_metrics['online'] = True
+
+    return nfs_metrics
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(description='Disk utilisation checks')
+    parser.add_argument('--telegraf-output',
+                        action='store_true',
+                        default=False,
+                        help='Set the output format to telegraf')
+    args = parser.parse_args()
+    with print_output(print_telegraf=args.telegraf_output):
+        nfs_system_check = nfs_export_check()
+
+        # If there are no returns for the nfs check or the status is ALL
+        # online the check is marked as "OK".
+        status = all([i['online'] for i in nfs_system_check.values()])
+        if status:
+            status_ok(m_name='nfs_check')
+        else:
+            status_err('The state of NFS connections is degraded',
+                       m_name='nfs_check')
+
+        # Generate a general purpose metric fot the operational state of NFS.
+        metric_bool('nfs_all_online', status, m_name='nfs_check')
+
+        for key, value in nfs_system_check.items():
+            # Generate a metric for the number of exports seen from a server.
+            metric('nfs_{}_exports'.format(key),
+                   'uint32',
+                   value['exports'],
+                   'exports',
+                   m_name='nfs_check')
+
+            # Generate a metric for the given online or offline state.
+            metric_bool('nfs_{}_online'.format(key),
+                        value['online'],
+                        m_name='nfs_check')

playbooks/maas-host-cdm.yml

@@ -46,6 +46,14 @@
         group: "root"
         mode: "0644"
 
+    - name: Install nfs system checks
+      template:
+        src: "templates/rax-maas/nfs_check.yaml.j2"
+        dest: "/etc/rackspace-monitoring-agent.conf.d/nfs_check--{{ inventory_hostname }}.yaml"
+        owner: "root"
+        group: "root"
+        mode: "0644"
+
     - name: Install memory Checks
       template:
         src: "templates/rax-maas/memory_check.yaml.j2"

playbooks/templates/rax-maas/nfs_check.yaml.j2

@@ -0,0 +1,24 @@
+{% from "templates/common/macros.jinja" import get_metadata with context %}
+{% set label = "nfs_check" %}
+{% set check_name = label+'--'+inventory_hostname %}
+type        : agent.plugin
+label       : "{{ check_name }}"
+period      : "{{ maas_check_period_override[label] | default(maas_check_period) }}"
+timeout     : "{{ maas_check_timeout_override[label] | default(maas_check_timeout) }}"
+disabled    : "{{ (check_name | match(maas_excluded_checks_regex)) | ternary('true', 'false') }}"
+details     :
+    file    : run_plugin_in_venv.sh
+    args    : ["{{ maas_plugin_dir }}/nfs_check.py"]
+    timeout : {{ (maas_check_timeout_override[label] | default(maas_check_timeout) * 1000) }}
+{{ get_metadata(label).strip() }}
+{# Add extra metadata options with two leading white spaces #}
+alarms      :
+    nfs_all_online :
+        label                   : nfs_all_online--{{ inventory_hostname }}
+        notification_plan_id    : "{{ maas_notification_plan_override[label] | default(maas_notification_plan) }}"
+        disabled                : {{ (('nfs_all_online--'+inventory_hostname) | match(maas_excluded_alarms_regex)) | ternary('true', 'false') }}
+        criteria                : |
+            :set consecutiveCount={{ maas_alarm_local_consecutive_count }}
+            if (metric["nfs_all_online"] != 1) {
+                return new AlarmStatus(CRITICAL, "NFS status is degraded");
+            }