nagios-plugin-python-templates

A set of templates for Nagios check scripts written in Python.

https://github.com/monitoringtoolbox/nagios-plugin-python-templates

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.6%) to scientific vocabulary

Keywords

monitoring nagios nagios-plugin nagios-plugins template wolfsoftware
Last synced: 6 months ago · JSON representation ·

Repository

A set of templates for Nagios check scripts written in Python.

Basic Info
  • Host: GitHub
  • Owner: MonitoringToolbox
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 177 KB
Statistics
  • Stars: 4
  • Watchers: 0
  • Forks: 0
  • Open Issues: 3
  • Releases: 2
Topics
monitoring nagios nagios-plugin nagios-plugins template wolfsoftware
Created almost 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security

README.md

MonitoringToolbox logo
Github Build Status License Created
Release Released Commits since release

Background

Wolf Software has been engaged in providing system, network, and security monitoring solutions from the very outset. Our expertise encompasses a wide range of monitoring solutions, including fundamental ones such as Munin and Nagios, as well as sophisticated enterprise-grade solutions like New Relic, Datadog, and AppDynamics. We also possess experience in creating customized monitoring solutions in-house, tailored to specific client requirements.

Overview

It is a common occurrence for companies to express the need for ready-made enterprise-grade monitoring solutions, asserting that solutions like Nagios are becoming obsolete due to the significant investment of time and resources required to make it operational, resulting in similar costs as those incurred with off-the-shelf solutions.

The goal of this project, as well as other initiatives within The Monitoring Toolbox, is to demonstrate the ease with which plugins can be developed for tools like Nagios and Munin, thereby enhancing their capabilities to a level that is more comparable to the more costly off-the-shelf alternatives.

How It Works

The provided template scripts aim to offer all the necessary core functionality while being as minimalistic and lightweight as possible.

Basic

The basic script provides 5 core functions.

  1. main - This function is where you add all of the check related code.
  2. handle_ok - This function displayed an OK prefixed message (if one is supplied) and then exits the script with the required exit code (0).
  3. handle_warning - This function displayed a WARNING prefixed message (if one is supplied) and then exits the script with the required exit code (1).
  4. handle_critical - This function displayed a CRITICAL prefixed message (if one is supplied) and then exits the script with the required exit code (2).
  5. handle_unknown - This function displayed an UNKNOWN prefixed message (if one is supplied) and then exits the script with the required exit code (3).

Advanced

The advanced script provides the same 5 functions as detailed above, along with an extra function.

  1. process_arguments - This function processes the command line arguments, does basic error checking and then calls the main function.

Template Scripts

| Script | Purpose | | ------------------------------------ | -------------------------------------------------------- | | basic | A basic example check using hard coded values. | | advanced | An advanced example check using command line parameters. |

Alternate languages

We have replicated the aforementioned templates in various languages, as individuals and organizations often have a particular language preference or choice.

We would be pleased to generate templates in different languages upon request. Furthermore, we welcome individuals to submit pull requests that include additional languages.


Owner

  • Name: Monitoring Toolbox
  • Login: MonitoringToolbox
  • Kind: organization
  • Email: github@wolfsoftware.com

A collection of monitoring related tool and scripts. Created by Wolf Software

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: Nagios Plugin Python Template
abstract: A set of templates for Nagios check scripts written in Python.
type: software
version: 0.1.0
date-released: 2024-05-21
repository-code: https://github.com/MonitoringToolbox/nagios-plugin-python-templates
keywords:
  - "Wolf Software"
  - "Software"
license: MIT
authors:
  - family-names: "Wolf"
    orcid: "https://orcid.org/0009-0007-0983-2072"

GitHub Events

Total
  • Watch event: 1
  • Delete event: 63
  • Issue comment event: 133
  • Push event: 121
  • Pull request review event: 113
  • Pull request event: 123
  • Create event: 65
Last Year
  • Watch event: 1
  • Delete event: 63
  • Issue comment event: 133
  • Push event: 121
  • Pull request review event: 113
  • Pull request event: 123
  • Create event: 65

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 41
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.88
  • Merged pull requests: 33
  • Bot issues: 0
  • Bot pull requests: 41
Past Year
  • Issues: 0
  • Pull requests: 41
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.88
  • Merged pull requests: 33
  • Bot issues: 0
  • Bot pull requests: 41
Top Authors
Issue Authors
  • dependabot[bot] (1)
Pull Request Authors
  • dependabot[bot] (84)
Top Labels
Issue Labels
dependabot: auto approve (1) dependabot: auto merge (1) dependabot: dependencies (1) dependabot: ecosystem : github actions (1)
Pull Request Labels
dependabot: dependencies (84) dependabot: ecosystem : github actions (84) dependabot: auto approve (75) dependabot: auto merge (72) dependabot: manual merge (4) dependabot: manual approve (1)