QPR ProcessAnalyzer Logs - Revision history

Ollvihe: /* Server File Log */

2025-12-02T08:22:26Z

Server File Log

← Older revision		Revision as of 08:22, 2 December 2025
Line 63:		Line 63:

	== Server File Log ==		== Server File Log ==
	The server file log contains information about all operations performed by the QPR ProcessAnalyzer server in a detailed level. The server file log is stored in the location defined by the [[~~Installing_QPR_ProcessAnalyzer_Server#Server_settings_file_(appsettings~~.json)\|LogFilePath setting in the appsettings.json file]]. The Web.config file also contains several other settings that affect the logging behavior, e.g. maximum log file size and file rotation.		The server file log contains information about all operations performed by the QPR ProcessAnalyzer server in a detailed level. The server file log is stored in the location defined by the [[Server_settings_in_appsettings.json\|LogFilePath setting in the appsettings.json file]]. The Web.config file also contains several other settings that affect the logging behavior, e.g. maximum log file size and file rotation.

	All log entries are classified to the following logging levels based on their importance for the system administrator:		All log entries are classified to the following logging levels based on their importance for the system administrator:

Ollvihe: /* Server File Log */

2025-11-22T01:18:28Z

Server File Log

← Older revision		Revision as of 01:18, 22 November 2025
Line 63:		Line 63:

	== Server File Log ==		== Server File Log ==
	The server file log contains information about all operations performed by the QPR ProcessAnalyzer server in a detailed level. The server file log is stored in the location defined by the [[Installing_QPR_ProcessAnalyzer_Server#Server_settings_file_(appsettings.json)\|LogFilePath setting in the appsettings.json file]]. The Web.config file also contains ~~[[Installing_QPR_ProcessAnalyzer_Server#Server_settings_file_(appsettings.json)\|~~several other settings]] that affect the logging behavior, e.g. maximum log file size and file rotation.		The server file log contains information about all operations performed by the QPR ProcessAnalyzer server in a detailed level. The server file log is stored in the location defined by the [[Installing_QPR_ProcessAnalyzer_Server#Server_settings_file_(appsettings.json)\|LogFilePath setting in the appsettings.json file]]. The Web.config file also contains several other settings that affect the logging behavior, e.g. maximum log file size and file rotation.

	All log entries are classified to the following logging levels based on their importance for the system administrator:		All log entries are classified to the following logging levels based on their importance for the system administrator:

Ollvihe: /* Task Log Settings */

2025-09-03T17:35:04Z

Task Log Settings

← Older revision		Revision as of 17:35, 3 September 2025
Line 50:		Line 50:
	* '''User full name''': Full name of the user performed the task.		* '''User full name''': Full name of the user performed the task.
	* '''User Id''': Id of user performed the task.		* '''User Id''': Id of user performed the task.
	* '''Request Id''': Id of the ~~HTTP~~ request to QPR ProcessAnalyzer ~~server~~.		* '''Request Id''': Id of the request to the QPR ProcessAnalyzer API.
	* '''Session Id''': User session id that performed the task.		* '''Session Id''': User session id that performed the task.
	* '''Task Id''': Unique id of the task.		* '''Task Id''': Unique id of the task.

Ollvihe: /* Task Log Settings */

2025-09-03T17:27:08Z

Task Log Settings

← Older revision		Revision as of 17:27, 3 September 2025
Line 50:		Line 50:
	* '''User full name''': Full name of the user performed the task.		* '''User full name''': Full name of the user performed the task.
	* '''User Id''': Id of user performed the task.		* '''User Id''': Id of user performed the task.
			* '''Request Id''': Id of the HTTP request to QPR ProcessAnalyzer server.
	* '''Session Id''': User session id that performed the task.		* '''Session Id''': User session id that performed the task.
	* '''Task Id''': Unique id of the task.		* '''Task Id''': Unique id of the task.

TeeHiet: TK-53330

2024-06-04T11:41:18Z

TK-53330

← Older revision		Revision as of 11:41, 4 June 2024
Line 75:		Line 75:
	* When specifying wrong password for an existing user account, the following log entry is made: ''User password is invalid: <username>''		* When specifying wrong password for an existing user account, the following log entry is made: ''User password is invalid: <username>''
	* When trying to log in with an inactivated user account, the following log entry is made: ''User account is invalid: <username>''		* When trying to log in with an inactivated user account, the following log entry is made: ''User account is invalid: <username>''

			== Dashboard Usage ==
			The dashboard usage reports can be browsed in the UI by opening the '''System Reports''' in the navigation menu (available only for system administrators). There are following dashboard usage reports available:
			* '''Popular dashboards''': Shows dashboards usage in a table of maximum of 500 dashboards which have the largest number of opens during the defined period.
			* '''Usage by time''': Shows dashboards usage in a pivot table where dashboards are on rows and time periods on columns.
			* '''Usage by users''': Shows dashboards usage in a pivot table where dashboards are on rows and users on columns.
			* '''Specific dashboards''': Shows the selected dashboards usage in a pivot table where users who opened the dashboards are on rows and time periods on columns.

Ollvihe: /* Task Log Settings */

2023-05-24T22:23:38Z

Task Log Settings

← Older revision		Revision as of 22:23, 24 May 2023
Line 24:		Line 24:
	=== Task Log Settings ===		=== Task Log Settings ===
	The following settings are available for the task log (in the '''Analyze''' tab):		The following settings are available for the task log (in the '''Analyze''' tab):
	* '''Time from'''		* '''Time from''': Show only tasks that have been started later than this time.
	* '''Time to''': ~~Choose the~~ time ~~range in which to show the task log. By default, the latest 6 months it shown~~.		* '''Time to''': Show only tasks that have been started earlier than this time.
	* '''Only running tasks''': Show only tasks that are currently running.		* '''Only running tasks''': Show only tasks that are currently running.
	* '''Only cancelled tasks''': Show only tasks that have been requested to cancel.		* '''Only cancelled tasks''': Show only tasks that have been requested to cancel.

Ollvihe: /* Task Log Settings */

2023-05-24T22:22:30Z

Task Log Settings

← Older revision		Revision as of 22:22, 24 May 2023
Line 24:		Line 24:
	=== Task Log Settings ===		=== Task Log Settings ===
	The following settings are available for the task log (in the '''Analyze''' tab):		The following settings are available for the task log (in the '''Analyze''' tab):
	* '''~~Start time~~ from''' ~~and~~ '''~~Start time~~ to''': Choose the time range in which to show the task log. By default, the latest 6 months it shown.		* '''Time from'''
			* '''Time to''': Choose the time range in which to show the task log. By default, the latest 6 months it shown.
			* '''Only running tasks''': Show only tasks that are currently running.
			* '''Only cancelled tasks''': Show only tasks that have been requested to cancel.
			* '''Only model related tasks''': Show only tasks that are related to a model.
			* '''Only user related tasks''': Show only tasks that are related to a user.
			* '''Only logins''': Show only login activities.
			* '''Only tasks longer than''': Show only tasks where duration is longer is specified.

	* '''Maximum Text Length''': Defines the maximum number of characters shown in the 'Additional Data' column.		* '''Maximum Text Length''': Defines the maximum number of characters shown in the 'Additional Data' column.
	* '''Only logins''': Show only log entries of successful authentications by users.		* '''Only logins''': Show only log entries of successful authentications by users.

Ollvihe: /* Task Log Settings */

2023-05-24T22:18:31Z

Task Log Settings

← Older revision		Revision as of 22:18, 24 May 2023
Line 32:		Line 32:
	* '''Task type''': Type of the task, e.g. run expression, run script, etc.		* '''Task type''': Type of the task, e.g. run expression, run script, etc.
	* '''Start Time''': Start time of the task.		* '''Start Time''': Start time of the task.
	* '''End Time''': ~~Endi~~ time of the task. This field is empty if the task is ~~still in progress~~.		* '''End Time''': End time of the task. This field is empty if the task is running.
	* '''Task duration''': Duration of the task ~~in seconds~~. Shown only if the task ~~has~~ completed.		* '''Task duration''': Duration of the task. Shown only if the task is completed.
	* '''Task cancelled''': Whether the task was requested to be cancelled.		* '''Task cancelled''': Whether the task was requested to be cancelled.
	* '''Task parameters''': Input parameters of the task.		* '''Task parameters''': Input parameters of the task.
	* '''Task result''': ~~Results~~ of the task, e.g., an error message.		* '''Task result''': Exceptional results of the task, e.g., an error message.
	* '''Model name''': ~~Model name~~ for which the task was performed.		* '''Model name''': Name of model for which the task was performed.
	* '''Model Id''': ~~Model id in~~ which the task was performed.		* '''Model Id''': Id of model for which the task was performed.
	* '''User name''': Login name of the user ~~performing~~ the task.		* '''User name''': Login name of the user performed the task.
	* '''User full name''': ~~Login~~ name of the user ~~performing~~ the task.		* '''User full name''': Full name of the user performed the task.
	* '''User Id''': ~~Model id in which~~ the task ~~was performed~~.		* '''User Id''': Id of user performed the task.
	* '''Session Id''': User session id that ~~created~~ the task.		* '''Session Id''': User session id that performed the task.
	* '''Task Id''': Unique id of the task.		* '''Task Id''': Unique id of the task.

Ollvihe: /* Task Log Settings */

2023-05-24T21:35:30Z

Task Log Settings

← Older revision		Revision as of 21:35, 24 May 2023
Line 30:		Line 30:

	The following columns can be selected for the task log (in the '''Columns''' tab):		The following columns can be selected for the task log (in the '''Columns''' tab):
	* '''Task type''': Type of the task, e.g. run expression, run script, etc.		* '''Task type''': Type of the task, e.g. run expression, run script, etc.
	* '''User''': Login name of the user performing the task.
	* '''User Id''': User id performing the task.
	* '''Model''': Model name for which the task was performed.
	* '''Model Id''': Model id in which the task was performed.
	* '''Start Time''': Start time of the task.		* '''Start Time''': Start time of the task.
	* '''End Time''': Endi time of the task. This field is empty if the task is still in progress.		* '''End Time''': Endi time of the task. This field is empty if the task is still in progress.
	* '''~~Duration~~''': Duration of the task in seconds. Shown only if the task has completed.		* '''Task duration''': Duration of the task in seconds. Shown only if the task has completed.
	* '''Task ~~end called~~''': Whether ~~an administrator has~~ requested to ~~stop this~~ task ~~(note that~~ the task ~~may still be~~ in ~~progress)~~.		* '''Task cancelled''': Whether the task was requested to be cancelled.
	* '''~~Additional Data~~''': ~~Shows parameters related to this~~ task.		* '''Task parameters''': Input parameters of the task.
	* '''~~Task~~ Id''': ~~Id of~~ the task.		* '''Task result''': Results of the task, e.g., an error message.
	* '''Session Id''': User session id that ~~made~~ the task.		* '''Model name''': Model name for which the task was performed.
			* '''Model Id''': Model id in which the task was performed.
			* '''User name''': Login name of the user performing the task.
			* '''User full name''': Login name of the user performing the task.
			* '''User Id''': Model id in which the task was performed.
			* '''Session Id''': User session id that created the task.
			* '''Task Id''': Unique id of the task.

	== Script Log ==		== Script Log ==

Ollvihe at 21:31, 24 May 2023

2023-05-24T21:31:54Z

← Older revision		Revision as of 21:31, 24 May 2023
Line 1:		Line 1:
	QPR ProcessAnalyzer writes log of all operations it's performing. The logs can be used for monitoring, auditing, troubleshooting and ~~many~~ other purposes. The main types of logs are [[#Task Log\|task log]], [[#Script Log\|script log]] and [[#Server File Log\|server file log]]. The task log and reports based on it can be used ~~routinely~~ to monitor the system usage and collect statistics. The script ~~logs~~ are collected for each script ~~that are running~~. The server file log is not ~~normally~~ needed, but if there are exceptional situations, such as system malfunctioning, the server file log is ~~very~~ helpful in ~~understanding~~ what has happened.		QPR ProcessAnalyzer writes a permanently stored log of all operations it's performing. The logs can be used for monitoring, auditing, troubleshooting and other purposes. The main types of logs are [[#Task Log\|task log]], [[#Script Log\|script log]] and [[#Server File Log\|server file log]]. The task log (and visual reports based on it) can be used to monitor the system usage and collect statistics. The script log are collected for each script when the script runs. The server file log is not needed in every-day operations, but if there are exceptional situations, such as system malfunctioning, the server file log is helpful in investigating what has happened.

	== Task Log ==		== Task Log ==
	All user requests are recorded as tasks, such as login, logout, modifying data, running queries etc. The Task Log can be browsed in the UI by opening the '''System Reports''' in the navigation menu (available only for system administrators). There are ~~two~~ task reports available: '''Running tasks''' ~~(all~~ tasks currently being executed~~) and~~ '''~~Recent tasks~~''' ~~(list~~ of ~~recent tasks in the order~~ of ~~start time)~~. ~~There~~ are ~~also summary level reports available for, e~~.~~g. which models~~ have ~~been~~ used~~, when~~ the system have ~~been used, and who has used~~ the system.		All user created requests to the [[QPR_ProcessAnalyzer_API\|Web API]] are recorded as tasks, such as login, logout, modifying data, running queries etc. The Task Log can be browsed in the UI by opening the '''System Reports''' in the navigation menu (available only for system administrators). There are following task reports available:
			* '''Recent tasks''': List of recent tasks in the order of start time.
			* '''Running tasks''': All tasks currently being executed.
			* '''Tasks by time''': Trend over time how task counts have changed.
			* '''Task duration''': Distribution of task counts of different durations.
			* '''Most used models''': List of models that are have been queried most.
			* '''Most active users''': List of users who have used the system most actively.
			* '''User logins by time''': Table of how many times users have logged in to the system over time.
			* '''Running tasks at specific time''': This report can be checked afterwards what kind of activity was in progress the system at a specific time. It can be used to investigate for example experienced performance issues.

	~~Executing~~ tasks can be stopped by the administrator both in the ~~Running~~ tasks and ~~Recent~~ tasks reports by selecting the task(s) and in the right click context menu ~~select~~ '''End tasks'''.		Currently running tasks can be stopped by the administrator both in the ''Recent tasks'' and ''Running tasks'' reports by selecting the task(s) and in the right click context menu selecting '''End tasks'''.

	Note that loading of a model is visible as a separate task in the task log, ~~in addition~~ to the task that initiated the model loading.		Note that loading of a model is visible as a separate task in the task log, besides to the task that initiated the model loading.

	Task log have for example the following use cases:		Task log have for example the following use cases:
	* To see the most active and idle times of the system to plan the optimal time for system updates and maintenance		* To see the most active and idle times of the system to plan the optimal time for system updates and maintenance.
	* In case of performance issues, how much load the is in the system in different times		* In case of performance issues, how much load the is in the system in different times.
	* How active the usage of the system is and how many users are using the system		* How active the usage of the system is and how many users are using the system.
	* Which content and models are browsed by the users in the system		* Which content and models are browsed by the users in the system.

	=== Task Log Settings ===		=== Task Log Settings ===
Line 36:		Line 44:

	== Script Log ==		== Script Log ==
	The script log is collected ~~for each script and separate log is stored~~ for each run of ~~the~~ script. The script log contains errors in the script run and also log ~~write messages~~ that are added to the code of the script. See more in [[Managing_Scripts#Viewing_Script_Log\|Managing Scripts]] how to use the script log.		The script log is collected for each run of a script. The script log contains possible errors in the script run and also log writes that are explicitly added to the code of the script. See more in [[Managing_Scripts#Viewing_Script_Log\|Managing Scripts]] how to use the script log. Note that in the UI, you can only see the last completed script run, although the system is storing the entire run history.

	Script logs contain following information:		Script logs contain following information: