Example Tutorial: Quick Jump into RealOpInsight Concepts

In this tutorial, you will see via examples released with RealOpInsight how interesting and easy-to-use the software is. This tutorial currently covers Nagios, Zabbix and Zenoss, and is mainly based on RealOpInsight Workstation. However, you are free to apply the steps with RealOpInsight Ultimate, that should just work.

Prerequisites

Here we assumes that RealOpInsight Workstation has been installed, configured and ready to use on your computer.

Having read and understood the basic concepts of RealOpInsight would be also helpful, but not required. However, it’s really recommended before jumping to production to take a look at this fundamental guide on RealOpInsight.

Last but not the least, according to your monitoring system, you must have one of the following endpoints to retrieve monitoring data from your monitoring server remotely:

  • For Nagios or derived, RealOpInsight works with Nagios 3.0 specifications or higher. You would need to install and configure ngrt4nd on your Nagios server to act as data retrieving endpoint. For more details, please refer to the ngrt4nd installation guide.

    Note that using ngrt4nd is recommended for test purpose only. For production use, we recommend you to use a Livestatus service (read the troubleshooting section to learn how to do so).

  • For Zabbix, RealOpInsight relies on its JSON-RPC API as remote endpoint. Zabbix 1.8 or higher is hence required, and you must make sure that your Zabbix Server as well as its API service are up and running. To check that, launch a web browser and enter the following URL: http://<zabbix_server>/zabbix/api_jsonrpc.php, replace <zabbix_server> by the address of the your Zabbix Server.

    If the Zabbix API is working, you should have a blank page.

  • For Zenoss, RealOpInsight relies on its HTTP(S) API. You must make sure that the Zenoss server is up and running properly. RealOpInsight has been tested with all Zenoss 4.x versions.

The Example Use Case

RealOpInsight Workstation source tarball is shipped out with example description files illustrating an imaginary hosting platform. The description files are declined in different version according to the target monitoring systems:

  • examples/small_hosting_platform.nag.ngrt4n.xml is the Nagios version. It’s supposed to work in conjunction with ngrt4nd and the example status file located in examples/status.dat from RealOpInsight Workstation source directory. You will find more details about the integration in the section Set Up ngrt4nd below.
  • examples/small_hosting_platform.zbx.ngrt4n.xml is the Zabbix version and is based on Zabbix server triggers. The trigger names are based on Zabbix 2.0.x, hence if you’re using a different version, it’s possible that some services appear as unknown. You can edit the configuration file through RealOpInsight’s Editor to adapt it to your Zabbix configuration.
  • examples/small_hosting_platform.zns.ngrt4n.xml is the Zenoss version of the description file. It’s based on components assumed to have been enabled to Zenoss server, so if you find unknown service you can update the description using the RealOpInsight’s Editor to adapt it to your Zenoss configuration.

Set up ngrt4nd (Nagios only)

Log on the machine where you have instaled ngrt4nd and launch a terminal.

Ensure that ngrt4nd is stopped.

Then set the authentication token by performing the following command.

$ ngrt4nd -P

Enter a passphrase necessary to generate the authentication token and press Enter.

The generated token will be generated and printed on the console as follows:

$1$ngrt4n$2x2PKY8WWu/fxMk7T4DX4/

Later, you can print the token using the -T switch as follows:

$ ngrt4nd -T

Now start ngrt4nd.

$ ngrt4nd -D -c /path/to/status.dat

This will start the daemon in foreground mode (see -D switch) and load the status.dat located at location the given path. The foreground mode is useful for viewing debugging messages in case of errors. Without the -D switch, the service will be started in background.

Change the path of the status file accordingly.

The Nagios-based sample description file shipped out with RealOpInsight is based on the status.dat file located at examples/status.dat from the source directory.

By default the ngrt4nd listens on port 1983, but you can set another port using the -p switch (e.g. -p 9083 to use the port 9083 instead).

Configure your RealOpInsight Workstation Settings

Start RealOpInsight Configuration Manager and set the access to your monitoring server endpoint (e.g. ngrt4nd, Zabbix API, Zenoss API...).

On GNU/Linux and OS X Systems

$ realopinsight-manager

Changed in version 3.0.0: Before version 3.0.0 the command was named ngrt4n-manager, which has been deprecated since then.

On Windows Systems

Start -> RealOpInsight Workstation -> RealOpInsight COnfiguration Manager

If needed, look at the RealOpInsight Workstation Configuration Guide to read about configuration parameters.

Launch the Operations Console

On GNU/Linux and OS X Systems

$ realopinsight-oc example/small_hosting_platform.<monitor_ext>.ngrt4n.xml

In the above command, replace <monitor_ext> with nag, zbx or zns respectively, according to if you’re using Nagios, Zabbix or Zenoss.

Changed in version 3.0.0: Before version 3.0.0 the command was named ngrt4n-oc, which has been deprecated since then.

On Windows systems

Start-> RealOpInsight Workstation -> RealOpInsight Operations Console

You will be invited to select a configuration file.

Browse through the file selection window that will appear to pick the suitable configuration file in C:\\Program Files\\RealOpInsight Workstation\\examples (default installation directory).

After signing in, the interface will be loaded. See here to learn more about the Operations Console’s Features. See the FAQ for the default user credentials.

That’s all for this tutorial. Now you can create your own description file and enjoy monitoring with RealOpInsight!!!