5.4.4 Using the dashboard function for analyzing operation logs
The dashboard function enables you to analyze operation logs that have been output pursuant to execution of users' Operational Contents. You can check the analysis results of operation logs from Operational Contents in the Dashboard window.
- Tip
-
-
Using the dashboard function, you can analyze operation logs from a period of no more than six months.
-
The web browsers that you can use to access the Dashboard window from a machine are Microsoft Edge and Google Chrome.
-
No more than two people can access the Dashboard window at the same time.
-
For details about how to use the dashboard function to analyze operation logs from Operational Contents, see the manual JP1/Navigation Platform Content Editing Guide.
This subsection explains the following items that are required in order to use the dashboard function:
-
Settings required for using the dashboard function
-
Estimating the memory capacity when using the dashboard function
-
Managing the users who use the dashboard function
-
Starting and stopping the dashboard server
-
Uploading operation logs
-
Deleting operation log analysis information periodically
-
Changing the memory capacity required for the storage service of the dashboard server
- Organization of this subsection
(1) Settings required for using the dashboard function
If you will be using the dashboard function, specify required values for the properties related to the dashboard function in Navigation Platform's user property file (ucnp_user.properties). The following are the applicable properties:
-
Display conditions for dashboard display links for the operation logs (ucnp.base.server.dashboard.link.display)
-
Setting the operation log output items (ucnp.base.server.operationlog.user.analyze.info)
-
List of user IDs of users who are allowed access to the Dashboard window for the operation log (ucnp.base.server.dashboard.auth.userids)
For details about property values, see 8.5 Specifying settings in the user property file (ucnp_user.properties).
You can use the following property in the service property file (ucnp_service.ini) to change the timing for the dashboard function's analysis of operation logs:
-
Timing for operation log analysis by the dashboard function (NPDASHBOARDANLTIME)
For details about this property, see 8.4 Specifying settings in the service property file (ucnp_service.ini).
(2) Estimating the memory capacity when using the dashboard function
Use the following formula to estimate the required memory capacity when you will be using the dashboard function:
- Formula
-
Memory capacity required for the storage service of the dashboard server#1
+ memory capacity required for the Web server of the dashboard server#2
= memory capacity required for the entire dashboard function (GB)
- #1
-
The memory capacity required for the storage service of the dashboard server is one and a half times the size of the operation logs subject to analysis. If the size of the operation logs subject to analysis increases, you must change the memory capacity required for the storage service. For details about how to change the memory capacity, see (7) Changing the memory capacity required for the storage service of the dashboard server.
- #2
-
The maximum memory capacity required for the Web server of the dashboard server is 1 GB.
(3) Managing the users who use the dashboard function
When you use the dashboard function, you have to specify a list of user IDs of users who are allowed access to the Dashboard window for the operation log in the ucnp.base.server.dashboard.auth.userids property in the user property file (ucnp_user.properties).
For details about the ucnp.base.server.dashboard.auth.userids property, see 8.5.3(83) List of user IDs of users who are allowed access to the Dashboard window for the operation log.
- Note
-
For details about how to migrate the user settings for the dashboard function when you upgrade Navigation Platform from JP1/Navigation Platform version 12-00 or earlier, see 3.6.5(11) Restore the data from the upgrade target.
(4) Starting and stopping the dashboard server
To use the dashboard function, you must start the dashboard server separately from Navigation Platform.
This subsection explains how to start and stop the dashboard server.
(a) Starting the dashboard server
There are two ways to start the dashboard server:
-
Using a Windows service
-
Using commands
- • Using a Windows service to start the dashboard server
-
The following Windows services are linked to the dashboard server (the service name that is displayed is shown within the parentheses):
-
NavigationPlatformDashboardStorageService (Navigation Platform Dashboard Storage Service)
-
NavigationPlatformDashboardWebService (Navigation Platform Dashboard Web Service)
-
If you set Automatic for the startup type of these two services, the dashboard server will be started automatically when the OS starts.
- • Using commands to start the dashboard server
-
To start the dashboard server, open the command prompt with Run as administrator and then execute the following commands:
net start "Navigation Platform Dashboard Storage Service" net start "Navigation Platform Dashboard Web Service"
(b) Stopping the dashboard server
You use commands to stop the dashboard server.
To stop the dashboard server, open the command prompt with Run as administrator and then execute the following commands:
net stop "Navigation Platform Dashboard Web Service" net stop "Navigation Platform Dashboard Storage Service"
(c) Notes about starting and stopping the dashboard server
-
Navigation Platform must be running in order to use the dashboard function. Therefore, you need to start Navigation Platform after you have started the dashboard server.
-
If the OS shuts down before the dashboard server is stopped, operation is not guaranteed. Stop the dashboard server before you shut down the OS.
(5) Uploading operation logs
You use the npuploadoplog (upload operation logs) command to upload operation logs. To upload operation logs, execute the npuploadoplog (upload operation logs) command by using, for example, a task scheduler.
You can download uploaded operation logs from the dashboard server's Operation Log Viewer.
For details about the commands to use and how to use them, see Chapter 9. Commands.
For details about the Operation Log Viewer, see the manual JP1/Navigation Platform Content Editing Guide.
- Tip
-
We recommend that you perform uploading of operation logs when none of the following processes is running, because these processes use machine resources:
-
Analysis of operation logs using the Reporting window
-
Analysis of operation logs using the dashboard function
-
Deletion of old analysis information that has accumulated in the dashboard server
-
(6) Deleting operation log analysis information periodically
Because operation log analysis information is not deleted automatically, you need to delete old analysis information when such information has accumulated for an extended period of time or when there is a shortage of disk capacity.
(a) Timing of deleting analysis information
The dashboard function analyzes operation logs that have been created over the past six months in the following folder and then registers the analysis information into the dashboard server:
-
Navigation-Platform-installation-directory\operationlogs
Because the analysis information that has been registered into the dashboard server is not deleted automatically, it is advisable to execute daily the command for deleting old analysis information, using, for example, a task scheduler.
- Tip
-
Be sure to execute the command for deleting analysis information only after the dashboard function has finished analyzing the operation logs. The dashboard function requires about one hour to analyze 1 GB of operation log data. Set the timing so that analysis information will not be deleted until after it has been analyzed. Also, when specifying the command for deleting analysis information by using a task scheduler, be sure to specify the -y option so that the processing is not stopped by execution confirmation.
(b) Deleting old analysis information
Use the following procedure to delete old analysis information. This example deletes analysis information when it becomes six months old.
-
Start the dashboard server.
-
Open the command prompt with Run as administrator and then execute the npdashboardremoveolddata command (delete analysis information).
- Command path
-
Navigation-Platform-installation-directory\bin\npdashboardremoveolddata
For details about the command to use and how to use it, see Chapter 9. Commands.
(7) Changing the memory capacity required for the storage service of the dashboard server
As the amount of analysis information increases, the memory capacity required by the storage service of the dashboard server increases. The following is the procedure to use if you will be changing the memory capacity required for the storage service:
-
Stop the dashboard server.
-
Open the command prompt with Run as administrator and then execute the npdashboardsetstoragememory command (modify storage memory settings).
- Command path
-
Navigation-Platform-installation-directory\bin\npdashboardsetstoragememory minimum-size[MB] maximum-size[MB]
For details about the command to use and how to use it, see Chapter 9. Commands.
-
Start the dashboard server.