Monitoring that allows report management, execution, and performance statistics for the web application and schedulers to be tracked in v2017.1+. Monitoring data is stored in local SQLite database files and can be reported on using Exago.
Many actions in the application can be monitored:
- Report Management
- Execute (begin & end)
- Report Designer usage
- Gauge Wizard
- Google Map Wizard
- GeoChart Wizard
- Map Wizard
- Scheduled report
- Schedule Manager
Monitoring for these components can be toggled on or off.
When the Exago Web Application is installed, the monitoring system is automatically installed, but it is disabled by default. It must be configured and enabled manually. To set up monitoring, you need to configure the monitoring application, set the options for which data to collect, and then set the monitoring service to run automatically.
This topic references
<Sched>/as a placeholder for the Web Application, Web Service API and Scheduler Service's install location respectively. The default install location is
/opt/Exago/WebServiceApi/on Linux) or
/opt/Exago/Scheduler/on Linux); however, these directories can be changed during installation.
The monitoring system is located in a folder
MonitoringService, in the same folder as where the Web application is installed. The web application stores its monitoring data in a
Monitoring subfolder of the installation. So you should have the following folders:
Windows: Ensure that the IIS user has Full Control permissions for the
MonitoringService folders. See Configuring IIS for Exago BI for instructions.
To configure monitoring:
MonitoringService, open the file
Monitoring.exe.configin a text or xml editor. For each of the following keys in the
<appSettings>element, set the values as follows:
pathis the file path to the web app
A trailing slash () or (/) is required
configis the application config file
"file name.xml"Use extension
.xmlfor either the encrypted or unencrypted version
uriis the url virtual path to the web app
"http://local/path/"A trailing backslash (/) is required
iis the number of minutes between updates to the core database. The default is 3.
jis the number of minutes between when each scheduler is polled for performance statistics. The default is 1.
<appSettings> <add key="ExtractionIntervalMinutes" value="3" /> <add key="StatisticsIntervalMinutes" value="1" /> <add key="exagoAppPath" value="C:ExagoWeb" /> <add key="userConfig" value="WebReports.xml" /> <add key="webAppUri" value="http://localhost/monitoring/" /> </appSettings>
<WebApp>, open the file
appSettings.configin a text or xml editor. In the
<appSettings>element, set the
Monitoring.DbPathkey to the folder where the web application’s monitoring data file is. The default location is
<appSettings> <add key="Monitoring.DbPath" value="C:ExagoExagoWebMonitoring" /> ... </appSettings>
- In the same file, set the options for which types of usage data you want to collect. To turn on monitoring for a specific action, set the value for the key to “true”. Available options are as follows:
<appSettings>... <add key="Monitoring.CollectDeleteReportUsage" value="true" /> <add key="Monitoring.CollectRenameReportUsage" value="false" /> <add key="Monitoring.CollectDuplicateReportUsage" value="true" /> <add key="Monitoring.CollectExecuteReportUsage" value="true" /> ... </appSettings>
- Restart the web server for the changes to be applied.
If you want to track scheduled report execution, do the following for each Scheduler Service installation:
eWebReportsScheduler.exe.config file in a text or XML editor. Add the following key to the
<add key="Monitoring.CollectExecuteReportUsage" value="true" />
Enabling the Monitoring Service
The monitoring system uses a Windows or Linux service that updates the core database with data from the Web Application and Scheduler Services at specified intervals. This way you have the data from every component in a single location.
The service is installed automatically, but it is not enabled by default. To enable the service:
- As an administrator, open the Windows Services manager:
- Click Start>Run.
- Press Enter.
- Locate the service
Exago Monitoring Service vX.X.X.X, where
vX.X.X.Xis the Exago BI version. Right-click the service and select Properties.
- In the Properties window:
- From the Startup Type list, select Automatic.
- Click Start to start the service.
- Click OK.
Accessing the Monitoring Data With Exago
To use monitoring data in reports, you need to add the Monitoring Service’s core database file
MonitoringService/Monitoring.sqlite as an Exago Data Source.