This document contains information to use the Denodo Monitor Reports web application correctly. This document has a functional explanation of every screen of the Denodo Monitor Reports (configuration and the chart explanations).
Denodo Monitor Reports is a web application that displays tables, graphs and charts about the VDP server’s performance. Reports can be constructed to include global summaries of performance by date, by user, by state, etc. Or reports can be assembled by query or cache performance.
The reports are built on the logs generated by The Denodo Monitor tool. While Denodo Monitor Reports tool constructs its reports using the logged information from the Denodo Monitor tool, it is important to distinguish the Denodo Monitor as a separate tool from the Denodo Monitor Reports.
The next section of this guide will give an overview of the Denodo Monitor tool. Then the following sections will detail every aspect of the Denodo Monitor Reports.
The denodo-monitor is a tool included in the Denodo Platform that logs several parameters of the Denodo servers: Virtual DataPort, Aracne and Aracne Index, ITPilot’s browser pool and Scheduler.
Denodo-Monitor includes several types of “monitors” which obtain information from each server. For example, there is a monitor to store the active processes and connections of the local machine, there is another to log memory resources used by each Java Virtual Machine, and so on.
The denodo-monitor tool is located in the $DENODO_HOME/tools/monitor directory, compressed into a zip file.
There are three different types of “monitors”:
This log register can be saved in a database instead of the log file. To configure this database you have to configure the following parameters in the file ConfigurationParameters.properties:
This log register can be saved in a database instead of the log file. To configure this database you have to configure the following parameters in the file ConfigurationParameters.properties:
The Virtual DataPort Administration Guide has more information about the denodo-monitor tool. (Section 18.2 DENODO MONITOR).
The Denodo Monitor Reports is a web application that shows the generated information by the Denodo Monitor. This information is shown in different screens that provide tables and charts about this information. Besides, this application has a configuration screen to configure and connect with different VDP servers.
There is more information about how to install and use the Denodo Monitor Reports in following sections.
This application can be downloaded through the Denodo Support Site (http://support.denodo.com).
When the zip file is downloaded and unzipped, you can start the application (the distribution includes a jetty web container). To start Denodo Monitor Reports application the start.bat script (start.sh in linux) must be executed.
Note: it is possible to deploy the web application in another web container. You can find DenodoMonitorReports.war file inside $DENODO_MONITOR_REPORTS_HOME/webapps directory. If you are deploying in an external server, you must include $DENODO_MONITOR_REPORTS_HOME/lib/ext/denodo-vdp-jdbcdriver.jar file into the classpath of your application server in order to connect to Virtual DataPort correctly.
Then, you can access into the application using http://host:8080/DenodoMonitorReports (by default, http://127.0.0.1:8080/DenodoMonitorReports).
Note: you can change the default jetty port if it was used by another application. To change the value you should open $DENODO_MONITOR_REPORTS_HOME/etc/jetty.xml and modify the entry:
<Property name="jetty.port" default="8080"/>
To correctly use this application, the architecture must have the following requirements:
The following illustration shows a ideal architecture to use this web application:
Also you can deploy the web application in the internal web container of the Denodo Platform.
You can find DenodoMonitorReports.war file inside $DENODO_MONITOR_REPORTS_HOME/webapps directory.
You should follow the following steps:
Note that <VERSION> is a placeholder for the specific version of the Denodo Platform you are installing the Denodo Monitor Reports for.
If missing, add it:
Denodo Monitor Reports provides graphic information reading all the entrances created by denodo-monitor tool. Its aim is the analysis of how performance evolves over time. For these analyses, denodo-monitor exposes server-side parameters (e.g., number of connections, requests, memory usage, number of threads, ...), along with statistics on query performance (execution time, number of rows, queries by type of CRUD operation invoked, use of cache, ...).
Administrators can combine intelligence gathered from all of these monitoring sources to analyze the optimum performance of the instances of Denodo Virtual DataPort.
Denodo Monitor Report has three options in its main menu:
We are going to explain every option deeply.
The authentication of the Denodo Monitor Reports is against a VDP server. This authentication server is configured the first time that you access to the application. The privileges of the VDP user determines if it only can visualize the reports of the application or if it can also configure more servers in DMR.
When you access the first time to the application, there aren’t any VDP servers configured, so there is no authentication server configured. If you access the application at http://localhost:8080/DenodoMonitorReports/ when there are no configured servers (and therefore no authentication server), a Wizard for configuring the server connection is launched. This first configured server will be automatically configured as the authentication server. The next time that you access the application, you will have to login against that VDP server.
Once you click on the “Apply configuration” button, you will be redirected to the login page and after signing in (using credentials valid in the configured authentication server) you can start using the application.
Once you have configured at least one server, accessing Denodo Monitor Reports will require authentication with credentials valid at the server configured as “authentication server”.
In order to access Denodo Monitor Report’s configuration section, the user in VDP has to be admin user or a normal user with administrator privileges over the configured authentication server’s database. In other case the user can only access the reports, but not configure the application.
You can change the authentication server in the Configuration section. Click on Select Authentication Server and a modal window will be displayed with the configured servers.
If you select a new server among the configured ones and you click Accept, authentication operations will be made against that VDP server from then on. Be careful, after changing the server and logging out of the application, you can't change the authentication server if you cannot connect to the new server and have administrator privileges on the new server.
The first time that the Denodo Monitor Reports is executed, a wizard for configuring the connection server is launched.
This wizard will guide you through the steps to setup a connection to your VDP server. In this first screen the alias name can be configured.
In this screen the configuration of server connection can be configured. The following fields have to be filled:
We shouldn't use http://localhost:9090/DenodoMonitorReports to access to DMR. Requests will result in a 403 forbidden response. We have to use the IP or the DNS of the machine instead of localhost. Starting with the update 8.0u20210705, the web container of Denodo refuses HTTP requests with the method OPTIONS. In order to use DMR, this configuration is required.
In this screen you can configure the following parameters:
The following parameters have to be filled, if the option “Activate database configuration in Queries Reports” is checked to configure the database connection:
Note: For use the Denodo Monitor with database instead of logs: first of all you have to create the tables to store the logs, in the folder sql you have several sql files to create the tables for several DBMS. After you have to set the file ConfigurationParameters.properties and activate the line vdpqueries.jdbcagent.enable=true, and configure the JDBC Agent Parameters depending on the DBMS, you can find in the file sections of commented configured parameters for several DBMS which name starts by vdpqueries.jdbcagent like vdpqueries.jdbcagent.driverClassName.
The following parameters have to be filled, if the option “Activate database configuration in Cache Reports” is checked, to configure the database connection:
Note: For use the Denodo Monitor with database instead of logs: first of all you have to create the tables to store the logs, in the folder sql you have several sql files to create the tables for several DBMS. After you have to set the file ConfigurationParameters.properties and activate the line vdploadcacheprocesses.jdbcagent.enable=true, and configure the JDBC Agent Parameters depending on the DBMS, you can find in the file sections of commented configured parameters for several DBMS which name starts by vdploadcacheprocesses.jdbcagent like vdploadcacheprocesses.jdbcagent.driverClassName.
When every section is correctly configured and the button next is clicked, the application shows the following alert:
If you click “OK” the VQL scripts will be installed, configuring the VDP structure. Finally, the next screen will be showed:
Note: If you are using Denodo 7.0 or higher the Queries report configuration and Cache report configuration using log files is deprecated. In this case the application shows a warn message that inform you that the recommended configuration is through DATABASE.
Configuration screen
The reports configuration screen has two different sections:
In this section we can see the following information:
The meaning of every icon:
Webservice is available.
Webservice is not available.
The server configuration has been modified but the VQL script hasn’t been executed.
Every configured server can be edited and deleted (Note: it is not allowed to delete the Default server).
Clicking on Edit button the following screen is opened:
In this screen you can see the configuration values of the server. These values can be edited.
If “Edit” button is selected in Server Information section, the following screen is shown:
The fields that can be changed in this screen were described in section “4.1 Wizard”.
In Reports Configuration section the source information to create the reports can be configured:
Note: if you edit any parameter in this screen, you will have to click on “Execute VQL script” to change the configuration in the VDP monitorization server. If you don’t execute the VQL script, you can see a warning icon in the configuration screen:
In the “List of configured servers” page you will find a “Create new server” button. It allows us to create a new server without the help of the wizard. When this button is clicked we can see the following screen:
The fields that have to be filled were described in section 4.1 Wizard.
When the server configuration is created, we can see in the server list, but the VQL scripts are not executed (the server will be shown as ‘not configured’ in the servers’ list). To execute these scripts, you have to click on “Edit”, configure the logs path and finally click on “Execute VQL script”.
In the application we can see the active server in the upper right of the page. This is the server used to get the data to paint the monitorization reports.
The active server can be changed clicking over the name. By default, the Default server is selected.
The reports will be shown depends on the selected server.
Note: This option is available in any report page, and can be changed when the user wants to.
Denodo Monitor reports can read the logs created when you monitor a server from Solution Manager. These logs have a special condition, they are stored in different folders, a new session of monitoring creates a folder whose name is the timestamp.
To read the logs of SolutionManager Denodo you have to fill in the parameters VDP Load Cache File, VDP Queries File, VDP Resources File correctly. Be aware the log files are created with the name of the server name chosen in Solution Manager Administration Tool: serverVDPName-loadcacheprocesses.log, serverVDPName-queries.log, serverVDPName-resources.log. In addition, you have to fill in the parameter log path with a folder of one of the sessions of the monitorization. Note that the route to the logs of Solution Manager Monitor should be similar to this: /../SolutionManager/resources/solution-manager-monitor/work/enviromentName/clusterName/serverName/20191113141155/logs/.
Denodo Monitor Reports will show the information generated by Solution Manager Administration Tool in the different sessions.
In this option there are different charts that are divided in five different sections:
Note that the Performance Summary reports appears as deprecated in the Denodo 7.0 and later versions.
Reports by Agent only appears in the Denodo 7.0 and later versions. In previous versions only appears the Reports by user.
This section shows a summary about the VDP server behavior. We are going to see every chart in detail.
This screen shows two different charts:
In the table, we can see a summary about the previous charts. Every value is divide by day. The following fields are shown:
This screen shows two different charts:
Note: The pie chart groups the results and doesn’t show a result if the percent is less than 10%.
In the table, we can see a summary about the previous charts. In this case, we can see the divided results by database. The following fields are shown:
This screen shows two different charts:
Note: The pie chart groups the results and doesn’t show a result if the percent is less than 10%.
In the table, we can see a summary about the previous charts. In this case, we can see the divided results by user. The following fields are shown:
This screen shows two different charts:
Note: The pie chart groups the results and doesn’t show a result if the percent is less than 10%.
In the table, we can see a summary about the previous charts. In this case, we can see the results depending on if there were cached or not. The following fields are shown:
This screen shows two different charts:
Note: The pie chart groups the results and doesn’t show a result if the percent is less than 10%.
In the table, we can see a summary about the previous charts. In this case, we can see the divided results by state. The following fields are shown:
This screen shows two different charts:
Note: The pie chart groups the results and doesn’t show a result if the percent is less than 10%.
In the table, we can see a summary about the previous charts. In this case, we can see the divided results by type of query. The following fields are shown:
This screen shows two different charts:
Note: The pie chart groups the results and doesn’t show a result if the percent is less than 10%.
In the table, we can see a summary about the previous charts. In this case, we can see the divided results by type of client that performed the request. The following fields are shown:
This screen shows two different charts:
Note: The pie chart groups the results and doesn’t show a result if the percent is less than 10%.
In the table, we can see a summary about the previous charts. In this case, we can see the divided results by User-Agent. The following fields are shown:
Note: This report is only included in the Denodo 7.0 and later versions.
This screen shows two different charts:
Note: The pie chart groups the results and doesn’t show a result if the percent is less than 10%.
In the table, we can see a summary about the previous charts. In this case, we can see the divided results by Client IP. The following fields are shown:
Note: This report is only included in the Denodo 7.0 and later versions.
This section shows information about the server performance. We are going to see every part in more detail.
This chart shows information about the load of the system. We can see information about the incoming requests.
This first chart shows information day by day. We can see the chart with more detail clicking over “hour-by-hour” option or “minute by minute” option. Also, we can interact with every chart. We can do zoom in on the chart and see the chart with more detail.
Note: This report is marked as deprecated in the Denodo 7.0 and later versions.
This chart shows information about the number of connections in every instant.
We can interact with this chart. We can do zoom in on the chart and see the chart with more detail.
The table shows a summary about the previous information. We can see the following fields:
Note: This report is marked as deprecated in the Denodo 7.0 and later versions.
This chart shows information about the loaded threads in every instant.
We can interact with this chart. We can do zoom in on the chart and see the chart with more detail.
The table shows a summary about the previous information. We can see the following fields:
Note: This report is marked as deprecated in the Denodo 7.0 and later versions.
This chart shows information about the state of the memory in every instant. The table shows a summary about the previous information.
Note that if you are using Denodo 7.0 or later this report have a little difference because in Java 8, the 'Perm Gen' memory space is removed and appears the 'Metaspace'.
We can interact with this chart. We can add or remove the information with the checkboxes. Also, we can do zoom in on the chart and see the chart with more detail.
In this screen, there are three different sections:
Note that if you are using Denodo 7.0 or later this report have a little difference because in Java 8, the 'Perm Gen' memory space is removed and appears the 'Metaspace'.
Note: This report is marked as deprecated in the Denodo 7.0 and later versions.
This chart shows information about the usage of the CPU and the Garbage Collector in every instant. The table shows a summary about them.
We can interact with this chart. We can add or remove the information with the checkboxes. Also, we can do zoom in on the chart and see the chart with more detail.
The table shows a summary about the previous information. We can see the following fields:
Note: This report is marked as deprecated in the Denodo 7.0 and later versions.
In this section, we can see in detail the results of every view. To see a view in detail, we have to introduce the name of the view in the report menu, click over the icon and select the wanted chart. A query could access to several views, in this case one query would generate several entries in these charts.
These charts can be accessed by clicking over every view in the Performance analysis screen.
This screen shows three charts and three tables with the global views.
The first chart shows the number of queries execute by every view. The associated table shows a summary of every view:
In this table we have a couple of fields that show information about cache and index optimizations for each view:
Note: The fields “Activate Cache” and “Create index” are marked as deprecated in the Denodo 7.0 and later versions.
The second chart shows the time (minimum, maximum and average) that a query spends when it is executed; these values are divided by every view. The associated table shows the same information as the chart.
The third chart shows the number of rows (minimum, maximum and average) that are returned by every view. The associated table shows the same information as the chart.
This screen shows a detailed information of the queries of the selected view with the following fields:
When you click over an anchor in the previous screen (or the name of the view is introduced in the reports menu), the following chart is shown:
This chart shows the behavior of every request in a view. We can see different information in this chart about the selected view:
We can interact with this chart. We can add or remove the information with the checkboxes. Also, we can do zoom in on the chart and see the chart with more detail.
The reset button is used to see the charts with the original information.
In the table, we can see a summary about the previous information. The following fields are shown:
This screen shows three charts with information about the selected database and view. We are going to see every chart in detail:
In the table, we can see a summary about the previous information. The following fields are shown:
This screen has two different parts. The first part has three different charts that show the different between the cached and non-cached queries of the selected database and view. And the second part shows the different between the type requests of the selected view.
This first part shows the following charts:
The table shows information about the previous information. The following fields are shown:
This second part shows information about the request type of the selected database and view. There are three charts to show this information.
The table shows information about the previous information. The following fields are shown:
This chart shows information about the different query condition of the selected database and view.
The table shows a summary about the previous information:
This chart shows information about the percent of request of every user of the selected database and view.
The following table shows information about the previous information. The following fields are shown:
This chart shows information about the percent of request of every type of client that performed the request of the selected database and view.
The following table shows information about the previous information. The following fields are shown:
This chart shows information about the percent of request of every User-Agent that performed the request of the selected database and view.
The following table shows information about the previous information. The following fields are shown:
Note: This report is only included in the Denodo 7.0 and later versions.
This chart shows information about the percent of request of every Client IP that performed the request of the selected database and view.
The following table shows information about the previous information. The following fields are shown:
Note: This report is only included in the Denodo 7.0 and later versions.
In this section we can see in detail the results of every view. To see a view in detail, we have to introduce the name of the view in the report menu, click over the icon and select the wanted chart.
Beside, these charts can be acceded clicking over every view in the Performance analysis (Global cache performance) screen.
This screen shows three charts and three tables with the global queries.
The first chart shows the number of refresh cache process executed by every view. The associated table shows a summary of every view:
The second chart shows the data storage time (minimum, maximum and average) that spends when cache process is executed; these values are dividied by every view. The associated table shows the following information:
The third chart shows the number of rows (minimum, maximum and average) that are inserted in every process. The associated table shows the following information:
This screen shows a detailed information of the cached queries of the selected view with the following fields:
When you click over an anchor in the previous screen (or the name of the view is introduced in the reports menu), the following chart is shown:
This chart shows the behavior of every request in a view. We can see different information in this chart about the selected view:
We can interact with this chart. We can add or remove the information with the checkboxes. Also, we can do zoom in on the chart and see the chart with more detail.
The reset button is used to see the charts with the original information.
In the table, we can see a summary about the previous information. The following fields are shown:
This screen shows two charts with information about the selected view. We are going to see every chart in detail:
In the table, we can see a summary about the previous information. The following fields are shown:
This screen has three different charts that show the differences between every type of cache load in the selected view.
This first part shows the following charts:
The table shows information about the previous information. The following fields are shown:
This chart shows information about the different condition in the load cache of the selected view.
The table shows a summary about the previous information:
This chart shows information about the percent of every database of the selected view where the load cache is executed.
The following table shows information about the previous information. The following fields are shown:
In this section, we can see in detail the actions of every agent. To see a agent in detail, we have to select the VDP Agent and enter the name of the agent in the reports main menu, click on the right icon and select the wanted chart.
For Denodo 7.0 and later versions we have three VDP Agent options (User, User-Agent, Client IP and Access Interface). In previous versions we only have the user option.
This screen shows detailed information of the queries executed by a determined agent. It is showed the same information than in the report Query detail (see section 9.2 View detail), but by a specific user.
This chart shows the behavior of a user in the timeline. It shows the same information that the report Query Timeline (see section 9.3 View Timeline), but for the selected agent. Also, it is possible view the same chart filtering the View Timeline report by user.
This screen shows three charts and three tables with the queries that a specific agent has performed. This screen shows the same charts and tables that Global queries performance (see section 9.1 Global views performance), but for the selected agent. Also, it is possible view the same chart filtering the Global Views Performance report by user.
This chart shows information about the different query condition of the queries executed by a determined agent. It is showed the same information than in the report Query conditions (see section 9.6 View by query), but by a specific agent.
In this screen, you can see the databases accessed by a determined agent. It is showed the same information than in the report Summary by database (see section 7.2 Summary by database), but by a specific agent.
In some reports, there is a form to filter the data by date (see next screenshot).
In this form, there are two dates to fill. The first date is the “start date” and the second one is “end date”.
To filter by date, the form should be filled at least in one date (e.g; you can insert a start date only, an end date only or both at the same time).
The hours and minutes are not mandatory. If the time is not filled, by default the value is 00:00.
In the Queries section, there is a form to filter the data by user, besides by date(see next screenshot).
You can combine the filter by user with the filter by date, so you can obtain information about what a particular user made on specific dates.
In the Queries section, there is a form to filter the data by access interface, besides by date and by user, in order to get information about the type of client that performed the request.
You can combine the filter by access interface with the filter by date and with the filter by user.
To download and open this document you only have to click on the “User Guide” link.