Reports - optional module

Learn how to install Opsview Monitor Reporting module

Overview

In this section, we offer step-by-step instructions providing you with specific guidance to successfully install the Opsview Monitor Reports software module.

It’s important that you have reviewed section Prerequisites to ensure that any software and hardware dependencies, along with any limitations are fully understood prior to installation.

Package Installation

Run the following command to update your OS packages, setup Opsview Monitor repositories on your server and install opsview-deploy package:

curl -sLo- https://deploy.opsview.com/6.5 | sudo bash -s -- -A boot

Installing Reports

To install Reports, you need to edit your /opt/opsview/deploy/etc/user_vars.yml file and add or uncomment the following opsview_module_reporting line:

## Uncomment below to activate these optional modules
opsview_module_reporting: True
For a Fresh install, follow the instructions in the Advanced Automated Installation page.

If, however, you are installing Reporting on an existing system (including Virtual Appliances), run the following command as root after activating Opsview:

# install and configure the Reporting Module
cd /opt/opsview/deploy
./bin/opsview-deploy lib/playbooks/setup-opsview.yml

# setup self monitoring for the Reporting Module
./bin/opsview-deploy lib/playbooks/setup-monitoring.yml

In either case, ensure that the optional module is included in your Opsview license.

When running the reporting-install playbook, you may be prompted for a password. If you are prompted for a password, cancel the playbook execution (Ctrl-C) and run the below command to add the reporting database password to your user_secrets.yml file:

/opt/opsview/deploy/bin/gen_secrets | grep reporting_database_p >> /opt/opsview/deploy/etc/user_secrets.yml

Note about Upgrades from 6.3 or earlier

The reporting module requires Chromium to be installed in order to render reports. As part of the installation or upgrade process, Opsview Deploy will automatically set up an EPEL (Extra Packages for Enterprise Linux) repository on all Opsview Monitor Servers to pull the chromium package down from, unless you have set the opsview_manage_epel_repository flag in your user_vars.yml to False. In this case, you will see the following message:

[HIGH -> jl-op-41920-rhel7] Failed to install chromium package
  | Chromium is needed for the reporting module, however yum failed to find it in an installed repository. chromium can be found in EPEL (Extra Packages for Enterprise Linux).
  |
  | EPEL can be added by re-enabling the opsview_manage_epel_repository flag. EPEL mirrors can be used by setting opsview_epel_repository_url. See user_variables-example.yml for more information.

To continue the installation, you must either re-enable the deploy management of the EPEL repository or manually add it yourself.

Once enabled, you should run the setup-hosts.yml playbook followed by reporting-install.yml to setup the repository and continue the Reporting Module installation.

cd /opt/opsview/deploy
./bin/opsview-deploy ./lib/playbooks/setup-hosts.yml
./bin/opsview-deploy ./lib/playbooks/reporting-install.yml

Importing ODW DB

Reports rely on data stored within the ODW database. You must ensure ODW imports are enabled in the UI accessible via Configuration > My System, on the 'ODW' tab.

The data will be imported at 4 minutes past every hour via the opsview user's crontab. The process can also be run manually as the opsview user with the command:

/opt/opsview/coreutils/bin/import_runtime -v

Logging into JasperServer

Opsview can use a ‘single sign-on’ method and, as such, a correctly authenticated user with the REPORTUSER access will be created in JasperServer. If the user also has REPORTADMIN, then they will receive additional privileges, specifically ROLE_ADMINISTRATOR in JasperServer.

A user that previously had ROLE_ADMINISTRATOR privileges will still retain that role even if REPORTADMIN is removed from them since the user databases are not synchronised. In this instance, a JasperServer administrative user will have to manually remove the role if required.

Setting up Emails

Emails are sent via the local machine (where the Reports module is installed) by default and you should verify that the current email system works.

date | /usr/bin/Mail -s 'test email for Opsview Reports' [email protected]

The email server configuration is stored in the file

/opt/opsview/jasper/apache-tomcat/webapps/jasperserver/WEB-INF/js.quartz.properties

To set the email server up, edit the following lines in the configuration to match your required config. The below example shows off emailing from the local machine.

report.scheduler.mail.sender.host=localhost
report.scheduler.mail.sender.username=admin
report.scheduler.mail.sender.password=password
[email protected]
report.scheduler.mail.sender.protocol=smtp
report.scheduler.mail.sender.port=25

If you change this file, then you will need to restart JasperServer:

/opt/opsview/watchdog/bin/opsview-monit restart opsview-reportingmodule

If you experience any issues, you should review the logs that is located in

/opt/opsview/jasper/apache-tomcat/webapps/jasperserver/WEB-INF/logs/jasperserver.log

🚧

Known issue

Please note, you may need to reapply the email settings after an upgrade