Logs

Logs
- Time range
- Record detail
Calculation Logs
Performance Logs
- Duration chart
How long logs are kept

Logs record what happens in the application: server errors and warnings, output from calculations, and how long important operations take. Administrators use them to find the causes of errors and slow response times. To open them, go to the Administration menu and click the Logs tile in the Application management and configuration group.

The page has three tabs: Logs, Calculation Logs and Performance Logs.

Logs

The screenshot shows the list filtered to one case using the Case ID column.

No.	Element	Purpose
1	Tabs	Switch between Logs, Calculation Logs and Performance Logs.
2	Detail	Opens the detail of the selected record. Double-clicking a row does the same.
3	Time range	Limits the list to a from–to period. The button is highlighted when a range is set.
4	Refresh	Reloads the list.
5	Close	Takes you back to the Administration menu.
6	Date	Time of the record, including milliseconds. The filter selects a whole day, or a single hour if you also enter a time.
7	Message	Text of the record. The filter searches for the entered text anywhere in the message and ignores case.
8	Category	The area of the application the record comes from, for example Evalmath (calculations), Rest (requests from the browser), Workflow, Cron, Mail or Frontend. You can select more than one category in the filter.
9	Level	Severity: error, warn, info, debug, trace. By default, only error and warn are shown.
10	Case ID	The case the record relates to. The filter looks for an exact match.
11	Trace ID	Identifier of a single request. Click the value to filter all records of the same request.
12	Paging	Arrows for moving between pages, and the number of records.

Press Enter to apply a column filter. Error rows are red and warning rows are orange. The list is sorted from the newest records, and you cannot change the sort order.

Time range

Field	Purpose
From, To	Date and time of the start and end of the period.
Save	Applies the range and loads the list from the first page.
Reset	Clears the time range.
Close	Closes the window without making changes.

The page remembers the range only while you are working with it. The range is not saved on the server.

Record detail

The detail shows the time and the full message. Below it is an expandable meta section with the technical data of the record, and for errors also the error stack trace. Click Download log to save the whole record as a JSON file, for example to send it to the vendor. Records that are too large are not shown in the window and can only be downloaded as a file.

Calculation Logs

Records written by template calculations and scripts using debugging functions (debug.log). Template authors use them to check what a calculation did while it ran. The screenshot shows the list filtered on text that no record contains.

No.	Element	Purpose
1	Detail	Opens the record detail, including the variable values written by the calculation.
2	Refresh	Reloads the list.
3	Message	Text written by the calculation. Can be filtered.
4	Inserted	When the record was created. Can be filtered by day.
5	Case	Name of the case in which the calculation ran.
6	Task name	The task whose calculation wrote the record. If the task still exists, click it to open its detail.
7	Task ID	Identifier of the task.
8	Trace ID	Identifier of the request. Click it to filter records of the same request.
9	Export	Exports the list to Excel or CSV.

Performance Logs

How long important operations take. They help you find the template, task or overview that is slowing down the application. The screenshot shows the list filtered to an order template.

No.	Element	Purpose
1	Detail	Opens a chart of the duration of comparable operations.
2	Open case	Opens the case of the selected row. Active only for rows that have a case.
3	Refresh	Reloads the list.
4	Filter	Saved filters of the list.
5	Export	Exports the list to Excel or CSV.

List columns:

Column	Content
Category	Type of operation, see the table below.
Template, Case, Task	Where the operation took place.
User	Who started the operation.
Duration (ms)	Length of the operation in milliseconds. The filter shows operations longer than the entered value.
Date	When the operation took place. By default, the list is sorted from the newest.
Case ID, Entity ID	Identifiers of the case and of another object, for example an overview.

Category	When it is recorded
Case creation	A user creates a case.
Overview display	A user opens an overview.
Task completion	A user completes a task.
CASE OVERVIEW display	A user opens the Case Overview.
Print creation	A print is created.
XML process import	A process is imported from XML.
Statistics	A statistic is displayed.
Process archiving, Process unarchiving	A case is archived or restored from the archive.
Task copying (Multiinstance)	A copy of a multi-instance task is created.
Calculation, Email notification, Link conditions, Case completion check, Solver search	Individual steps of task processing.

What is recorded
The scope of performance logs is set by the featureFlag.perfLogs.category item in Configuration. The value 0 turns recording off, 1 (default) records user actions, 2 adds task copying, and 3 also adds the individual steps of task processing.

Duration chart

The chart shows the duration of the same type of operation on the same template, task or overview over time. Above the chart, choose how many of the latest records to show (All, 1000, 500, 200, 100, 50, 10), or enter your own number in the field and press Enter. The average duration in milliseconds is shown on the right.

How long logs are kept

Old records are deleted every night by a scheduled job with the technical name DeleteLogs. By default, it deletes errors and warnings after 20 days, other records and calculation logs after 10 days, and meta technical data after 30 days. You can change these periods in the parameters of this job in the Crons section. Performance logs are deleted by the Cleanup old data from Database job. You cannot delete records manually on the Logs page.

How to find the cause of an error
When a user reports an error, find out the case ID or the approximate time. Filter the Logs by case ID or time range, find the red row and click its Trace ID. You will see all records of the same request, including those that came before the error.

Related: Crons, Configuration, Scripts.

HR agenda and agenda handover

Archiving

(opens in a new tab)