Platform Log

Version

Function Description

You can log in to the FineBI system as the admin and choose System Management > Intelligent O&M > Platform Log. In this case, you can view multiple log records.

Platform Log monitors and analyzes various aspects of system operation, allowing you to view various indicators of the system operation status, as shown in the following figure.

Prerequisite

Non-admin users can view platform logs only after the admin assigns them the permission on the Intelligent O&M module and the submodule Platform Log.

Log in to the FineBI system as the admin and choose System Management > Permission Management > Common Permission Configuration, and select the corresponding users.

1. Assign them permission on Intelligent O&M in System Management.

2. Assign them permission on the submodule Platform Log under System Management > Intelligent O&M.

Access Statistics are divided into three aspects, including System Visits, Server Usage, and Template Access Details, allowing simple analysis of dashboard usage.

System Visits

System Visits introduces the system access times, the number of visited templates, and active users in a line chart.

• You can filter access time by month.

• In a multi-node cluster project, no matter which node you get access to, you can view the log information of the entire cluster.

• For the integrated project of FineBI and FineReport, you can select the statistics object (Report Template or/and BI Template).

Data Source

The data in System Visits is obtained from the fine_record_execute table in the LogDB database by filter.

If you select Report Template and BI Template as Statistics Object, the data of the specified types (as shown in the following table) in the fine_record_execute table will be obtained by filter for the counting of indicators in the chart.

Note:

1. For details about the fields in the fine_record_execute table, see LogDB Table Structure.

2. If you select both Report Template and BI Template as Statistics Object, all data of types specified in the following table can be obtained by filter.

3. The data of Statistics Object is counted according to the template name. If a dashboard is renamed, the data of two statistics objects, namely the pre-rename object and the post-rename object, will be counted.

4. In FineBI 6.0.13 and later versions, the system can count the mobile template access records.

Calculation Logic

The following table shows the calculation logic for each value.

Server Usage

Current Number of Online Users

• If FineBI fails to connect to WebSocket, the current number of online users cannot be displayed correctly for the reason that the number of logged-in users is not counted in the current number of online users in the system.

• If two users log in to the server via two accounts separately in the same browser, only one user will be counted for the reason that the latter user's information will overwrite the former user's.

• Both of the users can only be counted as the current online users in the system when the users enter the platform through the login page (including single sign-on). If users access templates without accessing the platform, the users will not be counted as the current online users.

• When a new user logs in to FineBI, you need to refresh the page before checking the number of current online   users in the system.

List Introduction

The Server Usage list introduces {Access User accessing Template Name on the platform at Access Start Time from Access IP}.

• The detail list displays the report template that is currently being previewed.

• When general users log in to view templates, the access information of the viewed templates will be displayed in this detail list in real time.

• After general users close the templates being accessed and refresh the platform, the access information of the templates in the detail list will disappear.

Template Access Details

Template Access Details records {Operation User accessing Template Name in the system to Operation Type at Operation Time from Operation IP}. All template access records in the project will be displayed here.

Template Access Details introduces detailed information, such as which reports in which directory are accessed, the access time, the access IP address, the operation type (the method used to access FineBI, such as pagination preview, BI viewing, BI editing, and Excel pagination export), the role (the role of the logged-in user), and the username.

Query Method

The admin can specify a time period and click Query for template access details of the corresponding period. The default period is from the previous day to the current day.

The admin can tick Advanced Query Conditions, select the content to be queried, and click Query for query details with specific conditions.

You can filter logs with empty operation users and filter templates with empty template names.

Only the names of templates directly mounted to the directory are recorded for user access. The names of templates mounted via hyperlinks or accessed via public links are not guaranteed to be recorded.

Access Detail Export

After the query, the admin can export log files, as shown in the following figure.

The admin can click Export Log to export log files in the TXT format and click Export Excel to export log files in the XLS format.

Note:

A maximum of 10,000 records of log data can be exported.

Operation Type

Some operation fields in logs are numbers. The following table shows the corresponding log information types:

Note:

Some operation types are followed by . In this case, you can hover the cursor over the icon to view specific operation information.

Number	Type	Whether  Is Displayed	Displayed Content
0	Pagination preview	No	/
1	Online analysis	No	/
2	Data entry preview	No	/
3	Dashboard preview	No	/
4	Row-based engine	No	/
5	Online editing	No	/
10	Excel pagination export	No	/
11	Excel unaltered export	No	/
12	Exporting the entire Excel page, which corresponds to the following scenarios: 1. Exporting as Excel by the big dataset export plugin 2. Excel pagination export and Excel unaltered export with the row-based engine enabled	No	/
13	Excel pagination export by sheet	No	/
14	PDF export	No	/
15	Word export	No	/
16	SVG export	No	/
17	CSV export	No	/
18	Text export	No	/
19	JPG export	No	/
20	PNG export	No	/
21	GIF export	No	/
22	BMP export	No	/
23	WBMP export	No	/
24	Exporting templates from built-in datasets	No	/
25	HTML export	No	/
26	Data entry HTML export	No	/
27	Excel export from BI	No	/
30	Flash printing	No	/
31	PDF printing	No	/
32	Applet printing	No	/
33	Zero client printing	No	/
34	Local printing	No	/
101	Viewing BI templates	No	/
102	Editing BI templates	No	/
103	Sharing BI templates	Yes	Recipient: XXXX
104	Creating BI public links	No	/
105	Viewing BI public links	No	/
106	Global export as PDF	No	/
107	Global export Excel	Yes	Export cell: XXXX
108	Export component as Excel	Yes	Export cell: XXXX
109	Saving BI templates as	No	/
201	Closing browser tabs	No	/
202	Editing self-service datasets	No	/
203	Sharing self-service datasets	Yes	Recipient: XXXX Type: XXX
204	Disabling self-service dataset sharing	Yes	Recipient: XXXX
205	Disabling BI template sharing	Yes	Recipient: XXXX
206	Disabling BI public links	No	/

User behavior is divided into two aspects: Template Business and Login Logout. Specific user operation information can be obtained and easily analyzed here.

Template Business

1. You can specify Operation Time and Operation User under User Behavior > Template Business.

2. After you click Query, the viewing times, export times, printing times, and total operations of the specified user(s) within the specified time period are displayed in a detail table.

3. You can click the hyperlink of a username to be redirected to the detail table of the corresponding user behavior.

4. You can export logs. A maximum of 10,000 records of log data can be exported.

You can click Export Log to export log files in the TXT format and click Export Excel to export log files in the XLS format.

Note:

For templates accessed via public links, the name of the operation user is empty.

Login Logout

In FineBI 6.0.8 and later versions, the Login Logout log recording function is added, enabling the recording of each login and logout request of each user and facilitating the review of user login and logout.

The recording takes effect for default login, cross-domain login, remote design, third parties, and mobile terminals.

Query Method

1. You can specify Operation Time, Operation User, Operation Type, and Operation Result under User Behavior > Login Logout.

• Operation Time:  a specified time period (The default period is from the previous day to the current day.)

• Operation User: name of the user who logs in and logs out the platform (All usernames are selected by default.)

• Operation Type: Login, Logout, Overtime, and Keep Login (All types are selected by default.)

• Operation Result: Successful and Failed (All results are selected by default.)

2. You can click Query to view the login and logout records of the specified user within the specified time period.

3. After the query, admins can export the log files. (A maximum of 10,000 records of log data can be exported.)

• The admin can click Export Log to export log files in the TXT format and click Export Excel to export log files in the XLS format.

Log Viewing Description

Login and logout logs are stored in the fine_record_login table in the LogDB database. The following table shows the corresponding description. For details, see LogDB Table Structure.

Field	Definition	Description
actionMethod	Login method	0: Default login 1: Cross-domain login 2: Remote design 3: Third party 4: Mobile terminal Note: During logout, if no login method exists, the field value is -1. To distinguish the logout device, the field value for mobile logout is set to 4 separately.
actionType	Operation type	0: Login 1: Logout 2: Overtime (timeout logout) 3: Keep login
authMethod	Authentication method	0: Password 1: Verification code 2: Integration Note: During logout, if no authentication method exists, the field value is -1.
actionResult	Operation result	0: Successful 1: Failed

The admin can analyze the template viewing times to understand business hotspots.

1. You can specify Operation Time and Template Name on the Template Popularity page.

2. After you click Query, the viewing times, export times, printing times, and total operations of the specified user(s) within the specified time period are displayed in a detail table.

• The detail table is displayed in the descending order of total operations.

• The template name is the directory name configured in Directory Management. If you view a template through a non-platform directory (public links or drill-down), the template name is empty.

• The accessed resource is the storage path of the dashboard in the user's analysis.

• If a template is mounted in multiple directories on the platform, the template will be counted as multiple records.

• If you view a template through a public link or drill-down, the template will be counted as multiple records for statistics.

• The viewing times include the number of times of viewing BI templates, editing BI templates, and viewing BI public links.

3. Click the hyperlink of the accessed resource to display the detailed access information of the template. The detail data is displayed in chronological order.

4. After the query, the admin can export the log files. (A maximum of 10,000 records of log data can be exported.)

You can click Export Log to export log files in the TXT format and click Export Excel to export log files in the XLS format.

Performance Monitoring allows response performance analysis of templates to provide the admin with a reference for system optimization.

On the Performance Monitoring page, the templates that completed user requests, the longest response time, the shortest response time, the average time consumption, and the memory usage are displayed. Set the date parameter and the operation type parameter, as shown in the following figure.

Tick Details. The following figure shows the effect.

After the query, the admin can export the log files, as shown in the following figure.

The admin can click Export Log to export log files in the TXT format and click Export Excel to export log files in the XLS format.

Note:

A maximum of 10,000 records of log data can be exported.

1. On the Operation Log page, you can specify Operation Time and tick Advanced Query Conditions. After ticking, you can specify operation users, operation IP addresses, modules, operation objects, and operation types.

2. Click Query to display the log details.

• The details include Module, Operation Object, Operation User, Operation IP, Operation Time, Accessed Resource, and Operation Type.

3. After the query, the admin can export the log files. (A maximum of 10,000 records of log data can be exported.)

• The admin can click Export Log to export log files in the TXT format.

• The admin can click Export Excel to export log files in the XLS format.

4. Operation types include:

Template Error Function

Click Query to summarize the errors in the use of templates. The template name, accessed resources, error code, error content, occurrence, and total visits of the templates with error records are displayed, as shown in the following figure.

1. If you view a template through a non-platform directory (template URL or drill-down), the template name is displayed as Non-Mounting Visit.

2. If a template is mounted in multiple directories on the platform, the template will be counted as multiple records.

If you view a template through a URL or drill-down, the template will be counted as multiple records for statistics.

3. Only templates with errors are displayed in the Template Name filter bar.

Click Error Details to display detailed errors and query information of the corresponding error category of the corresponding template. The details include the user name, error details, query parameter, error time, and template preview result.

Note:

To avoid error information redundancy, only the first five errors are reported for each visit.

After the query, the admin can export the log files of template errors, as shown in the following figure.

The admin can click Export Log to export log files in the TXT format and click Export Excel to export log files in the XLS format.

Note:

A maximum of 10,000 records of log data can be exported.

Template Error Notification

Log in to the decision-making system as the admin, choose System Management > Intelligent O&M > Platform Log, and click  to enter the Global Setting page. You can enable Template Error Notification, as shown in the following figure.

After Template Error Notification is enabled, the system will check the templates with errors of the previous day at 2 AM every day. If error templates exist, the admin can be notified through three forms, namely SMS Reminder, Platform Message, and Email Notification.

Note:

1. SMS Reminder: You need to enable the SMS platform.

2. Email Notification: You need to configure the mailbox server. For details, see Mailbox.

3. Platform Message: WebSocket port needs to be configured and opened at the load balancing level.