QPR ProcessAnalyzer Logs: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
QPR ProcessAnalyzer writes log of all operations it's performing, and the log an be used for monitoring, auditing, troubleshooting and many other purposes. The main logs are the server log and the task log.
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 logs are the ''server log'' and ''task log''.


== Server Log ==
== Server Log ==
Server log contains all operations performed by the QPR ProcessAnalyzer server with many details. Location of the server log file is set to to LogFilePath setting in the [[Web.config_file_in_QPR_ProcessAnalyzer#Common_Settings|LogFilePath setting in the web.config file]].
The server log contains all operations performed by the QPR ProcessAnalyzer server in great detail. The server log is stored to the locataion defined by the [[Web.config_file_in_QPR_ProcessAnalyzer#Common_Settings|LogFilePath setting in the web.config file]].


The following security auditing related log entries can be found in the server log:
Note the [[Web.config_file_in_QPR_ProcessAnalyzer#Logging_Settings|server log settings in the web.config file]].
 
For example, the following kind of log entries for security auditing purposes can be found in the server log:
* When specifying non-existing username, the following log entry is made: ''User is not found: XYZ''
* When specifying non-existing username, the following log entry is made: ''User is not found: XYZ''
* When specifying wrong password for an existing user, the following log entry is made: ''User password is invalid: XYZ''
* When specifying wrong password for an existing user, the following log entry is made: ''User password is invalid: XYZ''
* When trying to log in with an inactivated account, the following log entry is made: ''User account is invalid: XYZ''
* When trying to log in with an inactivated account, the following log entry is made: ''User account is invalid: XYZ''
The server log works in the ''exclusive'' mode, i.e. the log file is reserved for the entire time QPR ProcessAnalyzer is running. Thus it's not possible to edit or delete log files during that time.


== Task Log ==
== Task Log ==

Revision as of 18:57, 23 June 2021

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 logs are the server log and task log.

Server Log

The server log contains all operations performed by the QPR ProcessAnalyzer server in great detail. The server log is stored to the locataion defined by the LogFilePath setting in the web.config file.

Note the server log settings in the web.config file.

For example, the following kind of log entries for security auditing purposes can be found in the server log:

  • When specifying non-existing username, the following log entry is made: User is not found: XYZ
  • When specifying wrong password for an existing user, the following log entry is made: User password is invalid: XYZ
  • When trying to log in with an inactivated account, the following log entry is made: User account is invalid: XYZ

Task Log

The Task Log can be viewed in the UI, by clicking System Reports in the navigation menu (available only for system administrators). All user requests are recorded as tasks, such as login, logout, modifying data, running queries etc. 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 to see, e.g. which models have been used, when the system have been used and who has used the system.

Executing tasks can be ended both in the Running tasks and Recent tasks reports by selecting the tasks and from the right click context menu select End tasks.

Task log have for example the following use cases:

Task Log Settings

The following settings are available for the task log (in the Analyze tab):

  • Start time from: Used to select the earliest start time (From) and the latest start time (To) of the log entries.
  • Start time to:
  • Maximum Text Length: Defines the maximum number of characters shown on the 'Name', 'Session Id', 'User Name', 'Model Name', 'Message', and 'Additional Data' columns.
  • Only logins:

The following columns can be selected for the task log (from the Columns tab):

  • Id: Id of the task.
  • Name: Name of the task, such as Get Analysis.
  • Session Id: User session id that made the task.
  • User Id: User id performing the task.
  • User Name: Login name of the user performing the task.
  • View Id: Related filter id.
  • Model Id: Model id in which the task was performed.
  • Model Name: Model name in which the task was performed.
  • Start Time: Starting time of the task.
  • End Time: Ending time of the task. This field is empty if the task is still ongoing.
  • Duration: Duration of the task in seconds. Calculated only if the task has completed.
  • Last Polling Time: Shows the timestamp for the last polling.
  • Cancelled: Shows whether the user has terminated the ongoing task, then the value is 1, otherwise it is 0.
  • Additional Data: Shows the parameters for the function call. For example, the analysis type (see Analysis Parameters for further information) and the changes the user has made to parameters. Password parameters are either removed completely or replaced with the value "<removed>".