Lars Hansson avatar Lars Hansson committed cad5cd9 Draft

Add rst markup to README and rename to README.rst.

Comments (0)

Files changed (2)

README

-Nagios plugin for checking the status of monit services.
-
-First you need a command definition:
-
-define command {
-    command_name  cmd_check_monit_service
-    command_line  $USER1$/check_monit_service.py -H $HOSTADDRESS$ -P $_HOSTMONITPORT$ -u $_HOSTMONITUSER$ -p $_HOSTMONITPASS$ $_HOSTMONITOPTS$ $ARG1$
-}
-
-You can of course use it without a username and password.
-You also need to add the custom host macros used by the plugin. If you dont
-want to repeat this you could add it to your default host defintion:
-
-define host {
-    name          default-host
-    [...]
-    _MONITPORT    2812
-    _MONITUSER    monit
-    _MONITPASS    monit
-    _MONITOPTS
-}
-
-The _MONITOPTS macro is used to enable SSL. Just set it to "-s" (without the
-quotes) to make the plugin use SSL.
-Now just create a Nagios service definition for every monit service you want
-to monitor. Here is an example for monitoring the monit service "stunnel":
-
-define service {
-    use                  default-service
-    host_name            some-host
-    max_check_attempts   1
-    check_interval       1
-    service_description  Process: stunnel
-    check_command        cmd_check_monit_service!stunnel
-}
-
-The plugin will return OK when a service is ok, CRITICAL if it's not, WARNING if
-it is unmonitored or if monit failied to start a service and UNKNOWN when the
-check is initializing or waiting.
-The plugin will also output performance data when appropriate.
-
+About
+-----
+Nagios plugin for checking the status of monit services.
+
+Configuring
+-----------
+Active checks
++++++++++++++
+First you need a command definition:
+
+define command {
+    command_name  check_monit_service
+    command_line  $USER1$/check_monit_service.py -H $HOSTADDRESS$ -P $_HOSTMONITPORT$ -u $_HOSTMONITUSER$ -p $_HOSTMONITPASS$ $_HOSTMONITOPTS$ $ARG1$
+}
+
+You can of course use it without a username and password.
+You also need to add the custom host macros used by the plugin. If you dont
+want to repeat this you could add it to your default host defintion:
+
+define host {
+    name          <my-host-template>
+    [...]
+    _MONITPORT    2812
+    _MONITUSER    monit
+    _MONITPASS    monit
+    _MONITOPTS
+    register      0
+}
+define host {
+    use        <my-host-template>
+    host_name  localhost
+}
+
+The _MONITOPTS macro is used to enable SSL and other options. Just set it to "-s" (without the
+quotes) to make the plugin use SSL.
+Now just create a Nagios service definition for every monit service you want
+to monitor. Here is an example for monitoring the monit service "stunnel":
+
+define service {
+    use                  default-service
+    host_name            localhost
+    max_check_attempts   1
+    check_interval       1
+    service_description  Process: stunnel
+    check_command        cmd_check_monit_service!stunnel
+}
+
+The plugin will return OK when a service is ok, CRITICAL if it's not, WARNING if
+it is unmonitored or if monit failied to start a service and UNKNOWN when the
+check is initializing or waiting.
+The plugin will also output performance data when appropriate.
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.