nagios-plugin-python-templates/src/basic/basic.py at master · MonitoringToolbox/nagios-plugin-python-templates · GitHub

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
#!/usr/bin/env python

"""
Description.

The script presented here is a simple Nagios check example, employing a set of
utility functions to guarantee accurate output and exit codes. Although this
version uses fixed values, suitable for straightforward checks, we also offer a
more sophisticated variant that demonstrates how to handle command-line
arguments for more elaborate or flexible scripting.
"""

import random   # Only required for the template demo - can be removed
import sys

from typing import NoReturn


def main() -> NoReturn:
    """
    Define a summary.

    This function is where you can include all the code related to the check. You're
    free to define additional functions and invoke them whenever necessary.

    In this template, we've generated a random number to illustrate how to call the
    core functions that manage the different states. However, real tests will be
    more intricate and elaborate, but they should adhere to the same fundamental
    structure.

    Returns:
        NoReturn -- _description_
    """
    critical_level = 90
    warning_level = 75

    test_value: int = random.randint(1, 100)  # nosec B311

    if test_value >= critical_level:
        handle_critical(f"Test Value = {test_value}")
    elif test_value >= warning_level:
        handle_warning(f"Test Value = {test_value}")
    elif test_value >= 0:
        handle_ok(f"Test Value = {test_value}")
    else:
        handle_unknown(f"Test Value = {test_value}")

# -------------------------------------------------------------------------------- #
# STOP HERE!                                                                       #
# -------------------------------------------------------------------------------- #
# The functions listed below are integral to the template and do not necessitate   #
# any modifications to use this template. If you intend to make changes to the     #
# code beyond this point, please make certain that you comprehend the consequences #
# of those alterations!                                                            #
# -------------------------------------------------------------------------------- #


def handle_ok(message: str = '') -> NoReturn:
    """
    Handle OK.

    If provided with a message, this function will show it with the 'OK' prefix and
    subsequently terminate the script with the requisite exit code of 0.

    Keyword Arguments:
        message (str) -- _description_ (default: '')

    Returns:
        NoReturn -- _description_
    """
    if message.strip():
        print(f"OK - {message}")
    sys.exit(0)


def handle_warning(message: str = '') -> NoReturn:
    """
    Handle Warning.

    If provided with a message, this function will show it with the 'WARNING' prefix
    and subsequently terminate the script with the requisite exit code of 1.

    Arguments:
        message (str) -- _description_ (default: '')

    Returns:
        NoReturn -- _description_
    """
    if message.strip():
        print(f"WARNING - {message}")
    sys.exit(1)


def handle_critical(message: str = '') -> NoReturn:
    """
    Handle Critical.

    If provided with a message, this function will show it with the 'CRITICAL' prefix
    and subsequently terminate the script with the requisite exit code of 2.

    Arguments:
        message (str) -- _description_ (default: '')

    Returns:
        NoReturn -- _description_
    """
    if message.strip():
        print(f"CRITICAL - {message}")
    sys.exit(2)


def handle_unknown(message: str = '') -> NoReturn:
    """
    Handle Unknown.

    If provided with a message, this function will show it with the 'UNKNOWN' prefix
    and subsequently terminate the script with the requisite exit code of 3.

    Arguments:
        message (str) -- _description_ (default: '')

    Returns:
        NoReturn -- _description_
    """
    if message.strip():
        print(f"UNKNOWN - {message}")
    sys.exit(3)

# -------------------------------------------------------------------------------- #
# The Core                                                                         #
# -------------------------------------------------------------------------------- #
# This is the central component of the script.                                     #
# -------------------------------------------------------------------------------- #


if __name__ == "__main__":
    main()

# -------------------------------------------------------------------------------- #
# End of Script                                                                    #
# -------------------------------------------------------------------------------- #
# This is the end - nothing more to see here.                                      #
# -------------------------------------------------------------------------------- #