You can set up the system to log deadlocks that occur in the SQL database. The deadlocks are recorded in the Windows event log of the computer running Business Central Server. The log entries provide information about the AL code that was run when the deadlock occurred, along with the deadlock report from SQL Server. This information can help you identify and resolve problem areas in the application design.
About database deadlocks
Deadlocks can prevent users from completing tasks in the Business Central client. A deadlock occurs when two or more processes or transactions block each other from continuing because each has locked a database resource that the other transaction needs. SQL Server resolves a deadlock by terminating and rolling back the transaction with the lowest deadlock priority. If priorities are equal, SQL Server chooses the transaction that's least expensive to roll back.
Learn more in SET DEADLOCK_PRIORITY.
Setting up deadlock logging
Setting up deadlock logging requires you to configure the SQL Server instance and the Business Central Server instance.
Note
In version 29, EnableDeadlockMonitoring defaults to false. Verify this setting and the SQL Server permissions even if you used the Install Demo option.
Configure the SQL Server instance
To configure the SQL Server instance to log deadlocks, you must assign specific permissions to the database login for the service account that is used on the Business Central Server instance. You can do this using SQL Server Management Studio.
In SQL Server Management Studio, connect to the SQL server instance for Business Central, and then grant the following permissions:
- On the database level, grant the login the View database state permission.
- On the SQL server instance level, grant the login both Alter any event session and View server state permissions.
On SQL Server 2022 and later, also grant VIEW SERVER PERFORMANCE STATE to read Extended Events diagnostic data. Keep the existing VIEW SERVER STATE and ALTER ANY EVENT SESSION permissions because Business Central Server checks them when initializing deadlock monitoring. Learn more in Quickstart: Extended Events.
Learn more about assigning the database permissions in Giving the account necessary database privileges in SQL Server.
After deadlock logging is enabled on the server instance and a client session accesses the database, a session for monitoring the Business Central database appears under Management > Extended Events.
Configure where to store deadlock events
By default, SQL Server uses an in-memory data structure called a ring_buffer target to store deadlock events. When Business Central Server is notified about the deadlock, it reads data from the ring_buffer target. You have the option to also store the events to a file on SQL Server, called an event_file target, and configure Business Central Server to read from this file instead of the ring_buffer target. Business Central creates the ring_buffer target with a memory limit of 1,024 KB. The target discards older events when it fills, and its XML output is truncated at 4 MB. The event_file target provides greater storage capacity. Using the event_file target can reduce the risk of losing deadlock reports in high-volume situations. If your setup has a high volume of database traffic, you might have to change SQL Server to write deadlock events to an event_file target as described in the steps that follow. If you want to use the default ring_buffer target, then no further action is required.
Note
Reading from the event_file target is only supported in Business Central Cumulative Update 3 and later.
Before following this optional procedure, enable deadlock logging on the server instance as described in the next section, restart the instance, and connect a client to the database.
Modify the deadlock monitoring session to use a file-based target (known as an event_file target).
The event_file target writes event session output from a buffer to a disk file that you specify. There are two ways to do this:
- From Object Explorer, open the session's Properties, and then on the Data Storage page, add an event_file type target.
- Using a query, run the ALTER EVENT SESSION transact-sql statement. For example:
ReplaceALTER EVENT SESSION [Demo Database BC_deadlock_monitor] ON SERVER ADD Target package0.event_file ( SET filename=N'C:\logging\mydeadlocks.xel',max_file_size=(10240) )C:\logging\mydeadlocks.xelwith the path and file name that you want to store the data.
Learn more in Alter an Extended Events Session and Targets for Extended Events in SQL Server.
In the Business Central database, create a view that has the name
dbo.deadlock_report_event_file_viewand uses the new event_file target.For example:
USE [Demo Database BC] GO SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO CREATE VIEW dbo.deadlock_report_event_file_view AS SELECT event_data AS event_raw_data FROM sys.fn_xe_file_target_read_file ('C:\logging\*.xel', null, null, null) GOReplace
C:\logging\with the path to the event file.Restart the Business Central Server instance so that the deadlock analyzer detects the view when it initializes the database.
Note
You can delete the ring_buffer target if you like. However, deletion isn't required.
Configure the Business Central Server instance
To log deadlocks, you must enable deadlock logging on the Business Central Server instance. In version 21 and later, use the Set-NAVServerConfiguration cmdlet in the Business Central Administration Shell. The Business Central Server Administration tool is available only in version 20 and earlier.
In version 20 and earlier, to enable deadlock logging by using the Business Central Server Administration tool, open the server instance for editing, and then select the Enable Deadlock Monitoring check box in the Database section.
Learn more in Business Central Server Administration Tool.
To enable logging by using the
Set-NAVServerConfigurationcmdlet, include the-KeyName EnableDeadlockMonitoring -KeyValue trueparameters in the command, such as:Set-NAVServerConfiguration -ServerInstance MyServerInstance -KeyName EnableDeadlockMonitoring -KeyValue trueRestart the server instance for the setting to take effect.
Learn more about the Business Central Administration Shell in Business Central PowerShell Cmdlets and Set-NAVServerConfiguration Cmdlet.
Viewing deadlocks in the Windows event log
Similar to other errors and events in Business Central, you can monitor deadlocks by using Event Viewer on the computer running Business Central Server. Deadlocks are recorded as warnings in Applications and Services Logs > Microsoft > DynamicsNAV > Common > Admin. Learn more in Monitor Business Central Server Events Using Event Viewer.
Deadlock event overview
Deadlock event log entries have the event ID 705 and task category 33 (TelemetryData). The following table describes some of the important information that is included in a deadlock log entry:
| Information | Description |
|---|---|
| instanceName | Specifies the Business Central Server instance on which the event occurred. |
| user | Specifies the Business Central user account that ran the transaction that caused the event. |
| AL ObjectType | Specifies the Business Central object in AL that ran the transaction, such as a page or report. |
| AL ObjectNumber | Specifies the ID of the object that was run. |
| AL ScopeName | Specifies the AL function that ran the transaction that caused the event. |
| SQL Server deadlock XML report | Includes the deadlock report that was received from SQL Server. Learn more in Analyze Deadlocks. |
Note
The system can't record information about AL code that was executed on a different Business Central Server. Therefore, the three attributes AL ObjectType, AL ObjectNumber, and AL ScopeName might be empty in a given event log entry.
View a graphical representation of the deadlock event
To view a graphical representation of the deadlock, perform the following steps:
- Open the deadlock event in Event Viewer.
- On the General tab, go to the SQL Server deadlock XML report section, and then copy the text in the deadlock tag, including the start and end tags, to a text editor such as Notepad or Visual Studio Code.
- Save the file with the
.xdlextension. - Open the file in SQL Server Management Studio.
Filter on deadlock events
All deadlock events have the trace tag 00000DI. If you only want to see deadlocks events in the log, you can use this tag in an XML path filter on the log, as shown in the following example:
<QueryList>
<Query Id="0" Path="Microsoft-DynamicsNAV-Common/Admin">
<Select Path="Microsoft-DynamicsNAV-Common/Admin">
*[EventData[Data[@Name='tag']='00000DI']]
</Select>
</Query>
</QueryList>
Learn more about XML filtering in Advanced XML filtering in the Windows Event Viewer.
Monitor using Application Insights
If your deployment is enabled for telemetry, you can also view data about deadlocks in an Application Insights resource in Azure. Learn more in the following articles:
Related information
Monitoring Business Central Server Events
Monitoring SQL Database Locks
Monitoring Business Central Server
Use SQL Server Management Studio