Monitoring the Status of Server
This topic introduces how you can use Server Monitor to inspect the status of Report Server, including Servers in a cluster, reports, online users, and the database connection pool.
In Server Monitor, you can list the Servers and their status from a cluster. You can also list the reports by drilling down into the Servers. For example, running reports, waiting reports, finished reports, and failed reports. Tracking further down, you can view the status of these reports.
Server Monitor is not able to monitor the information of a report that is running in Page Report Studio.
This topic contains the following sections:
- Showing the Status of Servers in a Cluster
- Monitoring the Status of Reports
- Monitoring the Status of Online Users
- Monitoring the Status of the Database Connection Pool
Showing the Status of Servers in a Cluster
By accessing the home page of Server Monitor, you can see the status of each Server in a cluster, including the cluster member ID, host IP, port, and its status.
The Status table includes:
Column | Description |
---|---|
Cluster Member ID | The ID of the Server as a cluster member. |
Host | The host IP address of the Server. |
Port | The RMI port number of the Server. |
Status | The status of the Server. Can be either Active or Inactive.
|
Monitoring the Status of Reports
Expand any Server node in the left panel of the Server Monitor home page, and then select Reports, you can see the status of the page reports, web reports, and dashboards on the Server.
There are five types of report status: all reports, running reports, waiting reports, finished reports, and failed reports. You can select to view the status of different reports from the drop-down list.
The status table of all reports includes:
Column | Description |
---|---|
Report | The full path name of the report. |
User ID | The ID of the user who opened the report. |
Submit Time | The time when the report was last opened. |
Pages | The total number of pages the last opened report has. Not available for web reports and dashboards. |
Number of Runs | The total number of report runs since it is first published to Server. |
Status | The status of the report. |
In addition, when you select the full path name of a report, Server Monitor displays the Report dialog box, showing you the report statistics, which includes the following:
- Task ID
The exact date and time when the report was opened. - Report
The path and name of the report. - Catalog
The catalog where the report lists. - Total Number of Times Run
The total number of times the report has run ever since a specific time. - Average Number of Times per Day
The average number of times the report has run per day. - Last Submit Time
The time when the report was last opened.
The status table of the running reports includes:
Column | Description |
---|---|
Action | You can stop the report from running and make it a failed report. |
Task ID | The internal ID for this task. |
Report | The full path name of the report. |
User ID | The ID of the user who opened the report. |
Task Status | Can be one of the following:
|
Task Type | The task type. Can be one of the following: Schedule, On-Demand, Page Report Studio, Web Report Studio, Dashboard, and Bursting. |
Start Time | The time when the task started. |
Elapsed Time | The elapsed time since the task started. |
Submit Time | The time when the report was opened. |
Run Host | The name of the host on which the task is performed. |
Run Port | The port number of the host on which the task is performed. |
Catalog | The catalog that the report belongs to. |
In addition, when you select the task ID of a report, Monitor displays the Task dialog box, showing the task information, which includes the following:
- Task ID
The exact date and time when the report was opened. - Task Type
The task type. There are six task types: Schedule, On-Demand, Page Report Studio, Web Report Studio, Dashboard, and Bursting. - Report
The path and name of the report. - Catalog
The catalog that the report belongs to. - Report Pages
The total page number of the report. Not available when task type is Web Report Studio or Dashboard. - Submit Time
The time when the report was opened. - Start Run Time
The time when the report started to run. - Completed Time
The time when the report was closed. - Parameters
The parameters used to run the report. If the report runs with no parameters, this column will be left blank.
The status table of the waiting reports includes:
Column | Description |
---|---|
Action | Stops the report from running and makes it a failed report. |
Task ID | The internal ID for this task. If you select the ID, the Task Information dialog box will pop up showing you the detailed task information. |
Report | The full path name of the report. |
User ID | The ID of the user who opened the report. |
Task Status | For waiting reports, can be one of the following:
|
Task Type | The task type. Can be one of the following: Schedule, On-Demand, Page Report Studio, Web Report Studio, Dashboard, and Bursting. |
Submit Time | The time when the report was opened. |
Catalog | The catalog that the report belongs to. |
Status of the finished reports
The Status table of the finished reports includes:
Column | Description |
---|---|
Task ID | The internal ID for this task. If you select the ID, Server Monitor displays the Task dialog box, showing the task information. |
Report | The full path name of the report. |
User ID | The ID of the user who opened the report. |
Task Status | Monitor displays Completed. It means the task has processed successfully and has accomplished all the requirements. |
Task Type | The task type. Can be one of the following: Schedule, On-Demand, Page Report Studio, Web Report Studio, Dashboard, and Bursting. |
Run Host | The name of the host on which the task was performed. |
Run Port | The port number of the host on which the task was performed. |
Catalog | The catalog that the report belongs to. |
Result Files | The path of the result files. |
Report Pages | The total page number of the report. Not available when task type is Web Report Studio or Dashboard. |
Reason | The reason why the task failed. Can be an exception or a meaningful description. |
Submit Time | The time when the report was opened. |
Start Run Time | The time when the report started to run. |
Completed Time | The time when the report was closed. |
The Status table of the failed reports includes:
Column | Description |
---|---|
Task ID | The internal ID for this task. If you select the ID, Monitor displays the Task dialog box, showing the task information. |
Report | The full path name of the report. |
User ID | The ID of the user who opened the report. |
Task Status | Monitor displays Failed. It means that the task encountered errors and failed to accomplish all the requirements. |
Task Type | The task type. Can be one of the following: Schedule, On-Demand, Page Report Studio, Web Report Studio, Dashboard, and Bursting. |
Run Host | The name of the host on which the task was performed. |
Run Port | The port number of the host on which the task was performed. |
Catalog | The catalog that the report belongs to. |
Result Files | The path of the result files. |
Report Pages | The total page number of the report. Not available when task type is Web Report Studio or Dashboard. |
Reason | The reason why the task failed. Can be an exception or a meaningful description. |
Failed Info | The information about the report's failure. |
Submit Time | The time when the report was opened. |
Start Run Time | The time when the report started to run. |
Completed Time | The time when the report was closed. |
Exporting the Monitoring Data
You can export the monitoring data of the reports' status to a CSV file. However, before doing this, you must configure the profiling DB on the server node where you are going to save the monitoring data.
To export the monitoring data of the reports' status:
- Select the Export Data link on the reports status panel. Monitor displays the Export Data dialog box.
- From the Report drop-down list, select he type of reports you want to export the monitoring data.
- Select the Calendar icon on the right of the From text box to select the date and time from which the monitoring data starts. You can also type the value in the text box.
- Select the Calendar icon on the right of the To text box to select the date and time to which the monitoring data ends. You can also type the value in the text box.
- In the File Name text box, type the name of the exported file.
- Select OK to export the data to a CSV file. Monitor displays the File Download panel. You can choose to open the file or save it elsewhere.
Report encodes the exported monitoring data in the CSV file with UTF-8. If you open an exported CSV file that contains Chinese strings by a double-click, the Chinese strings display as random code in the file. To solve this problem, open the file in the following way:
- Start Microsoft Excel first.
- Select From Text in the Data tab.
- Select the exported CSV file.
- Select Import.
- Select 65001: Unicode (UTF-8) in the File Origin selector.
- Keep selecting Next.
- Select Finish.
- Select OK.
Monitoring the Status of Online Users
Expand any Server node in the left panel of the Server Monitor home page, then select Users, and you can see the status of the online users on the Server. You can also select and remove specific users.
The Status table of the online users includes:
Column | Description |
---|---|
Session ID | The internal ID of the user session. |
User ID | The ID of the user who signed in to the Server. |
Create Time | The time when the user session was created. |
Last Access Time | The time when the user last accessed the Server. |
HTTP Session ID | The session ID in the HTTP service. |
Authentication | The authentication type. It can be Internal or External. |
Monitoring the Status of the Database Connection Pool
Expand any Server node in the left panel of the Server Monitor home page, then select Databases, and you can see the status of the Server's database connection pool. You can also select and remove specific connections.
The Status table of the connection pool includes:
Column | Value | Description |
---|---|---|
User | String | The user who is currently using the connection. |
URL | The URL connecting to a database. | The connections that are based on the URL to catch in the pool. |
Expiring Time(s) | 0 (the default value) or expiring time in seconds. If the value is zero, then the connection never expires. | The time during which a connection can be alive. If a connection has expired, the connection pool closes it. |
Idle Expiring Time(s) | 1 (the default value) or expiring time in seconds. Its value must be larger than or equals to 1. | The time during which a connection is kept after it starts idling. If a connection is not used, it stays open until the idle expiry time has reached. |
Maximal Connection Count | 0 (the default value) or a positive integer. | The pool size which limits the number of connections under a single URL. |
Maximal Share Count | 0 (the default value) or a positive integer. | The number of users who can share a connection simultaneously. |
Attempt | A positive integer. The default value is 1. | The number of attempts for recreating a connection when the connection pool has failed to create one. |
Interval(ms) | 0 (the default value) or a positive integer in milliseconds. | If the property Attempt is larger than 1, then the connection pool waits for an interval time before it retries to create a connection. This property defines the interval time. |
Last User Connecting Time(s) | 0 (the default value) or a positive integer in seconds. | The time elapsed since the last user took this connection. |
Current Idle Time(s) | 0 (the default value) or a positive integer in seconds. | The time elapsed since the connection started to idle. |
Current Share Count | 0 (the default value) or a positive integer. | The number of users who are currently sharing this connection. |
You can set the properties numbered 2 to 8 in the ConnectionPoolConfig.properties file in
, and Server displays the last three properties according to the real time status.<server_install_root>
\bin