Denodo Dashboard provides a single interface for real time monitoring of Denodo Platform servers and environments (groups of servers) and for import/export operations between several Denodo Platform servers, it allows you to synchronize VDP servers. This document introduces the reader to the main functionalities of the tool.
This document is aimed at system administrators that require detailed information of the status of a server in real time.
This document describes:
This software requires, at least, Java 2 Runtime Edition version 6 (JRE1.6) installed. The environment variable JAVA_HOME must be pointing to the folder containing the JRE installation.
In case you wish to use the import/export features, you will need to have the environment variable DENODO_HOME set and pointing to the installation folder of your Denodo Platform, or instead of using the platform you can use Denodo Tools, for this you will need to set the environment variable DENODO_DB_TOOLS_HOME. Otherwise, these variables are not necessary.
This software is distributed in a zip file that only has to be extracted for installation.
To launch the application, execute one of the scripts included in the Denodo “bin” folder:
All the scripts use the JAVA_OPTS environment variable to configure the JVM. If it does not exist, it will be set to -Xmx1024m (usually enough in case you use import/export features). Otherwise it will use the set value. Please, make sure you use enough memory in case you wish to use import/export features, as this feature needs it.
Once the tool is launched, the initial empty screen will be displayed. Below there is an image of the main screen as it appears just after being started.
Dashboard can be connected with a server that has SSL enabled. For this, the “Server uses SSL” option should be checked when registering the server. But some configuration might be needed at the startup scripts too:
If you use the trust store by default and if the server's public key is signed by a well known international CA no further configuration will be required. If not, you should configure the trust store you are using. A common way to do this is to set the Java system property javax.net.ssl.trustStore by adding -Djavax.net.ssl.trustStore=<path_to_truststore> at the launcher script or at the JAVA_OPTS environment variable (if the client allows to use it), and the same for the system property javax.net.ssl.trustStorePassword only if it is necessary by adding -Djavax.net.ssl.trustStorePassword=<truststore_password>.
Note that, depending on the Operating System you are using, you might need to modify denodo-dashboard.bat, denodo-dashboard.sh or denodo-dashboard-cygwin.sh.
For example, you could adapt your denodo-dashboard.bat script by replacing this line:
%JAVA_BIN% %JAVA_OPTS% -classpath "%DENODO_SERVERMONITOR_CLASSPATH%" com.denodo.connect.monitoring.dashboard.MonitorTool %OPTIONS% |
...with:
%JAVA_BIN% %JAVA_OPTS% -Djavax.net.ssl.trustStore="C:/Program Files/Denodo Platform/certs/mycacerts" -Djavax.net.ssl.trustStorePassword=admin.10 -classpath "%DENODO_SERVERMONITOR_CLASSPATH%" com.denodo.connect.monitoring.dashboard.MonitorTool %OPTIONS% |
The Denodo Dashboard has three main areas: the menu bar, the side tree, and the workspace.
The menu bar
It has the following menu entries:
The side tree
The side tree shows a list of the elements that this tool is monitoring. It has two top level categories: servers and environments:
The side tree lists all the servers and environments that have been added to the Dashboard. The options available for each element are accessible using a right-click popup menu.
Servers section
Shows all the servers created in the tool. The following options are available from the “Servers” right click menu:
These are the right click menu options for each server in this section:
Environments section
Shows all the environments created in the tool. The following options are available from the right click menu:
For each environment, it shows all the servers that belong to it. The following options are available from the right click menu of each environment:
For each server that belongs to the environment, these are the right click menu options:
The health of each server is described as follows:
For each server, it shows the monitoring status as follows:
The workspace
It is the main part of the tool and it is where all the dialogs are displayed. These dialogs will be covered in the following sections.
This section provides a detailed overview on the server monitoring capabilities of the tool.
Before monitoring the status of a server, it must be added to the Denodo Dashboard. The screen where a new server is defined can be accessed in three ways:
The “New Server” form looks like this:
The following parameters must be filled:
Once the form is filled, click “Ok” to create the server, or “Cancel” to leave the dialog with no changes.
An existing server can be edited by clicking on the “Edit” option of the popup menu of the server in the side tree. The form is identical to the “New Server” form, but the inputs are filled in with the current parameters.
Once the modifications are done, click “Ok” to modify the server, or “Cancel” to leave the dialog with no changes.
In case the server you are editing is still being monitored (green icon in the side tree), monitoring will end once you update the server and start when you restart monitoring.
The server monitor can be launched by double clicking on its icon in the side tree, or using the “Monitor” option in its popup menu.
Whenever a server is being monitored either in the background or the foreground, a green icon will be displayed next to the server icon in the side tree.
The monitor window contains three tabs:
The monitor workspace contains two buttons at the bottom of the page (no matter which tab you select):
The server overview tab provides a detailed overview of the server most important data from a monitoring point of view: CPU load, memory load, incoming connections, and outgoing connections. The information is displayed in four charts displayed in a 2x2 grid.
This data provides information about the server. The following information is displayed above the tab:
This chart shows the CPU activity of the server process –in orange- and its garbage collector –in blue. The following information is displayed above the chart:
This chart displays the heap size in MB through time. The heap size is shown in orange, and the used size of the heap in blue. On top of the chart, the following information is shown:
This chart shows the connections established from external clients to the Denodo Platform server. The chart displays the open connections (in orange) as well as the active requests (the ones executing a query, in blue) and the waiting ones (purple).
The following information is also displayed above the chart:
This chart shows an overview of the connections opened to the external data sources from Denodo server. Each data source type is displayed in a different color. Only the types with existing data sources are represented.
The Data source activity panel provides detailed information for the activity of each data source created in the server. In the upper part of the tab, two drop down selectors allow the user to choose the virtual database to monitor, as well as filter by data source type.
The information is displayed in a matrix of charts, one per data source as seen in the image below.
The charts show the following information:
On top of the charts, the following information is displayed:
The Cache summary panel provides detailed information related to the cache: cache status for each view, last refresh, … In the upper part of the tab, one drop down selector allows the user to choose the virtual database to monitor.
The information is displayed in the workspace as seen in the image below. Note only the views with the cache activated will be displayed in the table at the bottom of the window.
The cache monitor window contains:
This chart represents the connections to the cache data source. The data source can be one of the following:
This chart displays the following information:
On top of the chart, the following information is displayed:
One tab shows the active processes which are inserting data in the cache and the other one all processes(the previous ones and the ones that inserted data and finished).
Each of the tabs contains the following information:
The cache contents table contains the following information:
Apart from that information, if you click on a view, a new tab will be opened with further details on that view cache. This tab contains the following information:
The table data is being updated based on the database contents so new views will be added/updated in case any change happens in the database being monitored. The view details table is also being updated based on the view cache configuration.
This data provides information about the embedded web server of the platform. The following information is displayed above the tab:
This tab only appears if it is configured a JMX Web Server Port in the parameters of the server.
This chart shows the CPU activity of the web server process –in orange- and its garbage collector –in blue. The following information is displayed above the chart:
This chart displays the heap size in MB through time. The heap size is shown in orange, and the used size of the heap in blue. On top of the chart, the following information is shown:
In this section the web server’s thread pools are monitorized. There is one for each connector, and you can select the one being monitored in the Thread Pool combo box.
The chart shows the following information:
In the last chart of this view, you can see session information for every web application on the web server. You can choose the application to monitor in the selector.
You can see the following fields in the chart:
Note that most web applications shipped with the Denodo Platform are stateless and therefore create no sessions. But these graphs will help you monitor any additional web applications you deploy on the VDP embedded web server which might require the creation of new sessions.
This section provides a detailed overview on the environment monitoring capabilities of the tool. An environment is just a set of servers that will be monitored together.
The screen for defining a new environment can be accessed in three ways:
Below there is a screenshot of the “New Environment” form, displayed in the workspace area:
The following parameters must be filled:
Name is compulsory and at least one server must be selected. Once the form is filled, click “Ok” to create the environment, or “Cancel” to leave the dialog with no changes.
An existing environment can be edited by clicking on the “Edit” option of the popup menu of the environment in the side tree. The form is almost identical to the “New Environment” one, but the inputs are filled with the current parameters and there is one additional button to clear the master node of the environment.
In case you wish to clear the master node, click “Clear Master Node”. Otherwise, once the modifications are done, click “Ok” to modify the environment, or “Cancel” to leave the dialog with no changes.
In case the environment you are editing is still being monitored (green icon in the side tree), monitoring will end up once you update the environment and start once you monitor it again.
The environment monitor can be launched by double-clicking on its icon in the side tree, or using the “Monitor” option in its popup menu.
Whenever an environment is being monitored, either in the background or the foreground, a green icon will be displayed next to the environment icon in the side tree
The monitor window contains several charts representing:
The following information is also displayed below the charts for each of the servers in the environment:
The monitor environment workspace contains the following buttons at the bottom of the page:
This chart shows the CPU activity of the servers in the environment. You can check/uncheck any server included in the environment to include/exclude it from the chart.
The Heap chart displays the heap size in MB through time. The heap size of each server in the environment is shown in a different color. As with the other charts, you can check/uncheck any server to include/exclude it from the chart.
This chart shows the connections established from external clients to the Denodo Platform servers in the environment. The chart displays the open connections in a different color for each server. As with the other charts, you can check/uncheck any server to include/exclude it from the chart.
Once you have an environment defined and its master node configured, you can synchronize that environment by right clicking on the environment name in the Side tree and selecting the option “Synchronize Environment”. By selecting that option, metadata of the master node will be imported in all the servers of the environment.
The steps performed by the synchronization process are:
Below is an image of the synchronization process once finished:
The window above contains three main areas:
During the execution of the synchronization process, there can be both exceptions and errors. There is an important difference among them. If an exception arises, the progress bar will turn red and the task throwing the exception will be aborted. If there is an error, the task execution will go on and a warning icon will appear to the left of the window so that you know at what point the error happened and go to that part of the log in the window. An error can be a problem with the execution of any sentence contained in the master node export when imported into a server, whereas an exception may be a connection problem to a server node.
The progress bar at the top of the Synchronization window will let you know when the process finishes. If any exception arises, the bar will turn red.
All the different tasks of the current synchronization process will be displayed here. Each task has an icon to the right that lets you know its status:
Waiting status: the task is waiting to be executed |
|
Processing: the task is being executed |
|
Ok: the task has finished correctly (no errors) |
|
Warning: the task has finished but there has been any error. You should check the log of the task |
|
Error: the task has not finished due to an exception. You should check the log of the task. In this case, the progress bar will turn red as a task execution has been aborted |
This window displays the logging information of the tasks performed. Any error messages will be displayed in red so that they can be seen easily. Note that every task starts with a bold message. (i.e. “Synchronizing firstserver with master...”, “Saving secondserver backup...”, …)