Download PDF
Download page Administer the Reporting Service.
Administer the Reporting Service
Related pages:
The Reporting Service is a standalone Controller process responsible for generating and transmitting reports. The Controller uses the Reporting Service to send both one-time reports and scheduled reports. For more information about the Reporting Service, see Fonts Needed for the Reporting Service and Installation Settings.
Configure the Service
You can configure the Reporting Service with files in the following directory:
<Controller home>/reporting_service/reports/config
You can configure Reporting Service behavior in the user-config.json
file. You can configure properties such as the load timeout.
Any configuration changes made in user-config.json
override the default behavior specified in default-config.json
.
Disabling HTTP or HTTPS Port
Some on-premise installations can disable the http or https connection. This is done using the same reportServer:port
config value used to set the listening port. The default-config.json
installation has the following values for port(s):
"reportServer": {
"port": "8020",
"portSecure": "8021",
}
To disable https for a localhost system change the "portSecure" to "0":
"reportServer": {
"port": "8020",
"portSecure": "0",
}
Alternatively, for security reasons if you want to force https, and http you can change the "port" to "0":
"reportServer": {
"port": "0",
"portSecure": "8021",
}
After making the change, stop and start the Reports Server as follows:
Windows:
cd <installroot>\controller\reporting_service\reports\bin
reports-service.sh stop
reports-service.sh start
Linux/Mac:
cd <installroot>/controller/reporting_service/reports/bin
./reports-service.sh stop
./reports-service.sh start
./reports-service.sh list
The reporting-server.log contains info on the port settings during startup.
Limit Reports Service Port Listening to Localhost
Many on-premise installations may want to limit port listening for the Reports Service node server and just listen for localhost connects. These requests do not go onto the network. This is done using the reportServer:portHostname
and reportServer:portSecureHostname
value used to set the listen
hostname parameter. The default-config.json
installation has these values for the port hostname values, shown below with their port(s):
Default values are:
"reportServer": {
"port": "8020",
"portHostname" : "",
"portSecure": "8021",
"portSecureHostname" : ""
},
The reporting-server.log
shows info on the hostname settings during startup.
Adding the port*Hostname fields to "localhost" as shown below in user-config.json
limits the Report Service from connecting to a controller installed on the same host.
"reportServer": {
"portHostname" : "localhost",
"portSecureHostname" : "localhost"
},
After making the change, stop and start the Reports Server as follows:
Linux/Mac:
cd <installroot>/controller/reporting_service/reports/bin
./reports-service.sh stop
./reports-service.sh start
./reports-service.sh list
Windows:
cd <installroot>\controller\reporting_service\reports\bin
reports-service.bat stop
reports-service.bat start
See default-config.json
for more information about configurable properties.
Start and Stop the Service
You can start or stop the Reporting Service independent of the Controller.
When using the Enterprise Console, starting or stopping the Controller will also start or stop the Reporting Service.
For more information about starting and stopping reporting server, see Start or Stop the Controller Reporting Service.
To check the health status of reporting service you can:
- verify if the reporting service process is active on task manager or activity monitor.
- run the following curl command on the reporting service server:
curl -v http://localhost:<port of Reporting Service>
View Logs
The Reporting Service uses the following logs in the Controller home directory:
/logs/reporting-server.log
. Prints if the report email was sent and details of the report object that was requested by the user./reporting_service/reports/logs/reporting-process.log
. Confirms the reporting service process started and whether or not exceptions occurred. Note that this log file is only used on Linux Controllers.
Troubleshooting the Reporting Service
To begin troubleshooting why a report failed to send, open the server.log
file and find the runUUID for the report you tried to send. Then search for the log entry for the report.
Resolutions for common Reporting Service issues include the following:
- Verify that the Reporting Service is running.
You can use thecurl -v http://localhost:<port>
command. - Verify the default ports for the service: 8020 for HTTP and 8021 for HTTPS
- Verify that the user account used to start the Reporting Service is the same as the account used to start the Controller.