Skip to content

Commit be9fdbe

Browse files
committed
Migrate plugins
Signed-off-by: nook24 <[email protected]>
1 parent fd8b00d commit be9fdbe

File tree

4 files changed

+29
-34
lines changed

4 files changed

+29
-34
lines changed

.vitepress/config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ export default defineConfig({
9292
{ text: 'Object definitions', link: '/documentation/usersguide/objectdefinitions' },
9393
{ text: 'CGI Configuration File Options', link: '/documentation/usersguide/configcgi' },
9494
{ text: 'Authentication And Authorization CGIs', link: '/documentation/usersguide/cgiauth' },
95+
{ text: 'Plugins', link: '/documentation/usersguide/plugins' },
9596

9697
{ text: 'Naemon Logo', link: '/logo' }
9798
]
Lines changed: 27 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,55 @@
1-
---
2-
layout: doctoc
3-
title: Plugins
4-
---
5-
<span class="glyphicon glyphicon-arrow-right"></span> See Also: <a href="pluginapi.html">Plugin API</a>, <a href="embeddedperl.html">Embedded Perl Interpreter Overview</a>, <a href="activechecks.html">Active Checks</a>
1+
# Plugins
62

7-
### Introduction
3+
## Introduction
84

95
Unlike many other monitoring tools, Naemon does not include any internal mechanisms for checking the status of hosts and services on your network. Instead, Naemon relies on external programs (called plugins) to do all the dirty work.
106

11-
### What Are Plugins?
7+
## What Are Plugins?
128

139
Plugins are compiled executables or scripts (Perl scripts, shell scripts, etc.) that can be run from a command line to check the status or a host or service. Naemon uses the results from plugins to determine the current status of hosts and services on your network.
1410

15-
Naemon will execute a plugin whenever there is a need to check the status of a service or host. The plugin does <i>something</i> (notice the very general term) to perform the check and then simply returns the results to Naemon. Naemon will process the results that it receives from the plugin and take any necessary actions (running <a href="eventhandlers.html">event handlers</a>, sending out <a href="notifications.html">notifications</a>, etc).
11+
Naemon will execute a plugin whenever there is a need to check the status of a service or host. The plugin does *something* (notice the very general term) to perform the check and then simply returns the results to Naemon. Naemon will process the results that it receives from the plugin and take any necessary actions (running [event handlers](eventhandlers), sending out [notifications](notifications), etc).
1612

17-
### Plugins As An Abstraction Layer
13+
## Plugins As An Abstraction Layer
1814

19-
<img src="images/svg/plugins.svg" class="svg-image" border="0" style="float: right;" alt="Plugins">
15+
![Plugins](/images/usersguide/svg/plugins.svg) {.img-bg}
2016

2117
Plugins act as an abstraction layer between the monitoring logic present in the Naemon daemon and the actual services and hosts that are being monitored.
2218

23-
The upside of this type of plugin architecture is that you can monitor just about anything you can think of. If you can automate the process of checking something, you can monitor it with Naemon. There are already a lot of plugins that have been created in order to monitor basic resources such as processor load, disk usage, ping rates, etc. If you want to monitor something else, take a look at the documentation on <a href="pluginapi.html">writing plugins</a> and roll your own. Its simple!
19+
The upside of this type of plugin architecture is that you can monitor just about anything you can think of. If you can automate the process of checking something, you can monitor it with Naemon. There are already a lot of plugins that have been created in order to monitor basic resources such as processor load, disk usage, ping rates, etc. If you want to monitor something else, take a look at the documentation on [writing plugins](pluginapi) and roll your own. Its simple!
2420

25-
The downside to this type of plugin architecture is the fact that Naemon has absolutely no idea what it is that you're monitoring. You could be monitoring network traffic statistics, data error rates, room temperate, CPU voltage, fan speed, processor load, disk space, or the ability of your super-fantastic toaster to properly brown your bread in the morning... Naemon doesn't understand the specifics of what's being monitored - it just tracks changes in the <i>state</i> of those resources. Only the plugins themselves know exactly what they're monitoring and how to perform the actual checks.
21+
The downside to this type of plugin architecture is the fact that Naemon has absolutely no idea what it is that you're monitoring. You could be monitoring network traffic statistics, data error rates, room temperate, CPU voltage, fan speed, processor load, disk space, or the ability of your super-fantastic toaster to properly brown your bread in the morning... Naemon doesn't understand the specifics of what's being monitored - it just tracks changes in the *state* of those resources. Only the plugins themselves know exactly what they're monitoring and how to perform the actual checks.
2622

27-
### What Plugins Are Available?
23+
## What Plugins Are Available?
2824

2925
There are plugins currently available to monitor many different kinds of devices and services, including:
3026

31-
<ul>
32-
<li>HTTP, POP3, IMAP, FTP, SSH, DHCP</li>
33-
<li>CPU Load, Disk Usage, Memory Usage, Current Users</li>
34-
<li>Unix/Linux, Windows, and Netware Servers</li>
35-
<li>Routers and Switches</li>
36-
<li>etc.</li>
37-
</ul>
3827

39-
### Obtaining Plugins
28+
- HTTP, POP3, IMAP, FTP, SSH, DHCP
29+
- CPU Load, Disk Usage, Memory Usage, Current Users
30+
- Unix/Linux, Windows, and Netware Servers
31+
- Routers and Switches
32+
- etc.
33+
34+
35+
## Obtaining Plugins
4036

4137
Plugins are not distributed with Naemon, but you can download Naemon plugins and many additional plugins created and maintained by Naemon and Nagios users from the following locations:
4238

43-
<ul>
44-
<li>Monitoring Plugins Project: <a href="http://monitoring-plugins.org">http://monitoring-plugins.org</a></li>
45-
<li>Nagios Plugins Project: <a href="https://nagios-plugins.org/">https://nagios-plugins.org/</a></li>
46-
<li>Nagios Exchange: <a href="http://exchange.nagios.org/">http://exchange.nagios.org/</a></li>
47-
</ul>
4839

49-
### How Do I Use Plugin <i>X</i>?
40+
- Monitoring Plugins Project: [https://www.monitoring-plugins.org/](https://www.monitoring-plugins.org/)
41+
- Nagios Exchange: [https://exchange.nagios.org/](https://exchange.nagios.org/)
42+
43+
44+
## How Do I Use Plugin *X*?
5045

51-
Most all plugins will display basic usage information when you execute them using '-h' or '--help' on the command line. For example, if you want to know how the check_http plugin works or what options it accepts, you should try executing the following command:
46+
Most all plugins will display basic usage information when you execute them using `-h` or `--help` on the command line. For example, if you want to know how the check_http plugin works or what options it accepts, you should try executing the following command:
5247

53-
<pre>
48+
```bash
5449
./check_http --help
55-
</pre>
50+
```
5651

57-
<a name="howto"></a>
5852

59-
### Plugin API
53+
## Plugin API {#howto}
6054

61-
You can find information on the technical aspects of plugins, as well as how to go about creating your own custom plugins <a href="pluginapi.html">here</a>.
55+
You can find information on the technical aspects of plugins, as well as how to go about creating your own custom plugins [here](pluginapi).

src/documentation/usersguide/toc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979

8080
## The Basics {#basics}
8181

82-
[Plugins](plugins)
82+
[Plugins](plugins) :white_check_mark:
8383

8484
[Macros and how they work](macros)
8585

File renamed without changes.

0 commit comments

Comments
 (0)