Initial implementation

.gitignore

@@ -0,0 +1,3 @@
+*.pyc
+.*.swp
+/.idea/

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2013-2019 Mike Gerber
+
+   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.

README.md

@@ -0,0 +1,27 @@
+# `check_lvm_thinpools`
+
+This is a re-implementation of the Perl [`check_lvm_thinpools`](https://github.com/neingeist/check_lvm_thinpools/). That is used to check the free capacity in Linux Logical Volume Manager (LVM) [thin pools](https://www.linux.org/docs/man7/lvmthin.html).
+
+The check uses the [nagiosplugin](https://pypi.org/project/nagiosplugin/) framework to output metrics. Multiple thin pools are supported too.
+
+```
+$ ./check_lvm_thinpools
+LVMTHINPOOLS OK - data percent (workhero_nvme/nvmepool) is 61.78% | 'data_workhero_nvme/nvmepool'=61.78%;70;90;0;100 'meta_workhero_nvme/nvmepool'=34.21%;70;90;0;100 data_percent=61.78%;70;90;0;100 metadata_percent=34.21%;70;90;0;100
+```
+
+Supported command line arguments can be listed with the `--help` command line argument.
+
+```
+$ ./check_lvm_thinpools --help
+usage: check_lvm_thinpools [-h] [--dpw RANGE] [--dpc RANGE] [--mpw RANGE] [--mpc RANGE] [-v]
+
+options:
+  -h, --help            show this help message and exit
+  --dpw RANGE, --data-warning-percent RANGE
+  --dpc RANGE, --data-critical-percent RANGE
+  --mpw RANGE, --metadata-warning-percent RANGE
+  --mpc RANGE, --metadata-critical-percent RANGE
+  -v, --verbose         increase output verbosity (use up to 3 times)
+```
+
+The user that runs the check must be allowed to execute `/sbin/lvs` via `sudo`.

check_lvm_thinpools

@@ -0,0 +1,113 @@
+#!/usr/bin/env python3
+import argparse
+from pprint import pprint
+from subprocess import check_output
+
+import nagiosplugin
+
+
+def lvs_output():
+    return [
+        line.strip().split(":", 5)
+        for line in check_output(
+            [
+                "sudo",
+                "lvs",
+                "--noheadings",
+                "--separator",
+                ":",
+                "--select",
+                "lv_attr =~ ^t",
+                "-o",
+                "lvattr,lv_name,vg_name,data_percent,metadata_percent",
+            ],
+            env={"LC_ALL": "C"},
+            encoding="UTF-8",
+        ).splitlines()
+    ]
+
+
+class LVMThinPools(nagiosplugin.Resource):
+    def __init__(self):
+        self.pool_data = lvs_output()
+
+    def get_lv_names(self):
+        return [f"{vg_name}/{lv_name}" for _, lv_name, vg_name, _, _ in self.pool_data]
+
+    def probe(self):
+        data_max = 0.0
+        metadata_max = 0.0
+
+        metrics = []
+
+        for lv_attr, lv_name, vg_name, data_percent, metadata_percent in self.pool_data:
+            metrics += [
+                nagiosplugin.Metric(
+                    f"data_{vg_name}/{lv_name}",
+                    float(data_percent),
+                    "%",
+                    0,
+                    100,
+                ),
+                nagiosplugin.Metric(
+                    f"meta_{vg_name}/{lv_name}",
+                    float(metadata_percent),
+                    "%",
+                    0,
+                    100,
+                ),
+            ]
+
+            data_max = max(data_max, float(data_percent))
+            metadata_max = max(metadata_max, float(metadata_percent))
+
+        metrics += [
+            nagiosplugin.Metric("data_percent", data_max, "%", 0, 100),
+            nagiosplugin.Metric("metadata_percent", metadata_max, "%", 0, 100),
+        ]
+
+        return metrics
+
+
+def parse_args():
+    argp = argparse.ArgumentParser()
+    argp.add_argument("--dpw", "--data-warning-percent", metavar="RANGE", default="70")
+    argp.add_argument("--dpc", "--data-critical-percent", metavar="RANGE", default="90")
+    argp.add_argument(
+        "--mpw", "--metadata-warning-percent", metavar="RANGE", default="70"
+    )
+    argp.add_argument(
+        "--mpc", "--metadata-critical-percent", metavar="RANGE", default="90"
+    )
+    argp.add_argument(
+        "-v",
+        "--verbose",
+        action="count",
+        default=0,
+        help="increase output verbosity (use up to 3 times)",
+    )
+    return argp.parse_args()
+
+
+@nagiosplugin.guarded
+def main():
+    args = parse_args()
+
+    pools = LVMThinPools()
+
+    check = nagiosplugin.Check(
+        pools,
+        nagiosplugin.ScalarContext("data_percent", args.dpw, args.dpc),
+        nagiosplugin.ScalarContext("metadata_percent", args.mpw, args.mpc),
+    )
+
+    for lv_full_name in pools.get_lv_names():
+        check.add(nagiosplugin.ScalarContext(f"data_{lv_full_name}", args.dpw, args.dpc,
+                                             "data percent (%s) is {valueunit}" % lv_full_name))
+        check.add(nagiosplugin.ScalarContext(f"meta_{lv_full_name}", args.dpw, args.dpc,
+                                             "meta data percent (%s) is {valueunit}" % lv_full_name))
+    check.main(args.verbose)
+
+
+if __name__ == "__main__":
+    main()

check_lvm_thinpools-sudoers.d

@@ -0,0 +1 @@
+nagios ALL = (root) NOPASSWD: /usr/lib/nagios/plugins/check_lvm_thinpools

poetry.lock

@@ -0,0 +1,19 @@
+# This file is automatically @generated by Poetry 1.5.1 and should not be changed by hand.
+
+[[package]]
+name = "nagiosplugin"
+version = "1.2.4"
+description = "Class library for writing Nagios (Icinga) plugins"
+optional = false
+python-versions = "*"
+files = [
+    {file = "nagiosplugin-1.2.4.tar.gz", hash = "sha256:6b020aca516f3643ad02378866d382f0296bf378fa3874d9b2e1d3cc6135f8bb"},
+]
+
+[package.extras]
+test = ["setuptools"]
+
+[metadata]
+lock-version = "2.0"
+python-versions = "^3.7"
+content-hash = "d2559a93a0eca91fe28a4f85f78e4d42d8b8290ef9607ce0c929d53c160f3587"

pyproject.toml

@@ -0,0 +1,17 @@
+[tool.poetry]
+name = "check-lvm-thinpools"
+version = "0.1.0"
+description = "check_lvm_thinpools in Python"
+authors = ["Jan Dittberner <jandd@cacert.org>"]
+license = "Apache-2.0"
+readme = "README.md"
+packages = [{include = "check_lvm_thinpools"}]
+
+[tool.poetry.dependencies]
+python = "^3.7"
+nagiosplugin = "1.2.4"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"