Sidebar

manual:appendix:install:web_service

13 Setting up scheduled reports

Overview

This section provides instructions on installing Zabbix web service and configuring Zabbix to enable generation of scheduled reports.

Currently the support of scheduled reports is experimental.

Installation

A new Zabbix web service process and Google Chrome browser should be installed to enable generation of scheduled reports. The web service may be installed on the same machine where the Zabbix server is installed or on a different machine. Google Chrome browser should be installed on the same machine, where the web service is installed.

Installation from packages

An official zabbix-web-service package is available for RHEL/CentOS 8, SLES 15, Debian 10, Ubuntu 18.04, Ubuntu 20.04 in the Zabbix repository. Google Chrome browser is not included into these packages and has to be installed separately.

Installation from sources

A configured Go version 1.13+ environment is required for building Zabbix agent 2.

To compile Zabbix web service from sources, run the ./configure script with --enable-webservice option (see Installing Zabbix web service for additional details).

A sample ./configure command for installing or upgrading Zabbix with addition of Zabbix web service may look like this:

./configure --enable-server --enable-proxy --enable-agent --enable-webservice --with-mysql --enable-ipv6 --with-net-snmp --with-libcurl --with-unixodbc --with-libxml2 --with-openssl  

Configuration

To ensure proper communication between all elements involved make sure server configuration file and frontend configuration parameters are properly configured.

Zabbix server

The following parameters in Zabbix server configuration file need to be updated: WebServiceURL and StartReportWriters.

WebServiceURL

This parameter is required to enable communication with the web service. The URL should be in the format <host:port>/report.

  • By default, the web service listens on port 10053. A different port can be specified in the web service configuration file.
  • Specifying the /report path is mandatory (the path is hardcoded and cannot be changed).

Example:

WebServiceURL=http://localhost:10053/report

StartReportWriters

This parameter determines how many report writer processes should be started. If it is not set or equals 0, report generation is disabled. Based on the number and frequency of reports required, it is possible to enable from 1 to 100 report writer processes.

Example:

StartReportWriters=3
Zabbix frontend

A Frontend URL parameter should be set to enable communication between Zabbix frontend and Zabbix web service:

  • Proceed to the Administration → General → Other parameters frontend menu section
  • Specify the full URL of the Zabbix web interface in the Frontend URL parameter.

Once the setup procedure is completed, you may want to configure and send a test report to make sure everything works correctly.