Distributed Replay Security
Applies to: 
SQL Server 2016 (13.x),
SQL Server 2017 (14.x), and
SQL Server 2019 (15.x)
Important
SQL Server Distributed Replay is not available with SQL Server 2022 (16.x).
Before you install and use the Microsoft SQL Server Distributed Replay feature, you should review the important security information in this topic. This topic describes the post-installation security configuration steps that are required before you can use Distributed Replay. This topic also describes important considerations regarding data protection and important removal steps.
User and Service Accounts
The following table describes the accounts that are used for Distributed Replay. After the Distributed Replay installation, you must assign the security principals that the controller and client service accounts will run as. Therefore, we recommend that you configure the corresponding domain user accounts before you install the Distributed Replay features.
| User Account | Requirements |
|---|---|
| SQL Server Distributed Replay controller service account | Can be a domain user account or local user account. If you use a local user account, the administration tool, controller, and client must all be running on the same computer. ** Security Note ** We recommend that the account isn't a member of the local Administrators group in Windows. |
| SQL Server Distributed Replay client service account | Can be a domain user account or local user account. If you use a local user account, the controller, client, and target SQL Server must all be running on the same computer. ** Security Note ** We recommend that the account isn't a member of the local Administrators group in Windows. |
| Interactive user account that is used to run the Distributed Replay administration tool | Can be either a local user or a domain user account. To use a local user account, the administration tool and controller must be running on the same computer. |
Important
When you configure Distributed Replay controller, you can specify one or more user accounts that will be used to run the Distributed Replay client services. The following is the list of supported accounts:
Domain user account
User created local user account
Administrator
Virtual account and MSA (Managed Service Account)
Network Services, Local Services, and System
Group accounts (local or domain) and other built-in accounts (like Everyone) aren't accepted.
To set the service accounts or their passwords after you install Distributed Replay, you can use the Windows Services tool. To change the service accounts associated with the Distributed Replay controller or client services, follow these steps:
Do either of the following, depending on the operating system:
Select Start, type services.msc in the Search box, and then press ENTER.
Select Start, select Run, type services.msc, and then press ENTER.
In the Services dialog box, right-click the service that you want to configure, and then select Properties.
On the Log On tab, select This account.
Configure the user account that you want to use.
File and Folder Permissions
After the service accounts have been specified, you must grant the necessary file and folder permissions to those service accounts. Configure file and folder permissions according to the following table:
| Account | Folder Permissions |
|---|---|
| SQL Server Distributed Replay controller service account | <Controller_Installation_Path>\DReplayController (Read, Write, Delete)DReplayServer.xml file (Read, Write) |
| SQL Server Distributed Replay client service account | <Client_Installation_Path>\DReplayClient (Read, Write, Delete)DReplayClient.xml file (Read, Write)The working and result directories, as specified in the client configuration file by the WorkingDirectory and ResultDirectory elements, respectively. (Read, Write) |
DCOM Permissions
DCOM is used for remote procedure call (RPC) communication between the controller and the administration tool, and between the controller and all clients. You must configure computer-wide and application-specific DCOM permissions on the controller after the Distributed Replay features have been installed.
To configure the controller DCOM permissions, follow these steps:
Open dcomcnfg.exe, the Component Services snap-in: This is the tool that is used to configure DCOM permissions.
On the controller computer, select Start.
Type dcomcnfg.exe in the Search box.
Press ENTER.
Configure computer-wide DCOM permissions: Grant the corresponding computer-wide DCOM permissions for each account listed in the following table. For more information about how to set computer-wide permissions, see Checklist: Manage DCOM Applications.
Configure application-specific DCOM permissions: Grant the corresponding application-specific DCOM permissions for each account listed in the following table. The DCOM application name for the controller service is DReplayController. For more information about how to set application-specific permissions, see Checklist: Manage DCOM Applications.
The following table describes which DCOM permissions are required for the administration tool interactive user account and the client service accounts:
| Feature | Account | Required DCOM Permissions on Controller |
|---|---|---|
| Distributed Replay administration tool | The interactive user account | Local Access Remote Access Local Launch Remote Launch Local Activation Remote Activation |
| Distributed Replay client | SQL Server Distributed Replay client service account | Local Access Remote Access Local Launch Remote Launch Local Activation Remote Activation |
Important
To help protect against malicious queries or denial of service attacks, make sure that you only use a trusted user account for the client service account. This account will be able to connect and replay workloads against the target instance of SQL Server.
SQL Server Permissions
The SQL Server Distributed Replay client service accounts are used to connect to the workload's target instance of SQL Server. Only Windows Authentication mode is supported for these connections.
After you install the SQL Server Distributed Replay client service on a set of computers, the security principal used for those service accounts must be granted the sysadmin server role on the instance of SQL Server that you intend to replay the trace workload against. This step isn't performed automatically during Distributed Replay Setup.
Data Protection
In the Distributed Replay environment, the following user accounts are granted full access to the target server instance of SQL Server, the input trace data and result trace files:
The interactive user account that is used to run the administration tool.
The controller service account.
The client service account.
Members of the local Administrators group on the controller.
Members of the local Administrators group on the clients.
Important
These accounts have full access to any personally identifiable information (PII) or sensitive information that is contained in the trace, intermediate, dispatch, or SQL Server data files that were used by Distributed Replay.
We recommend that you take the following security precautions:
Store the input trace data, output trace results, and database files in a location that uses the NTFS file system (NTFS), and apply the appropriate access control lists (ACLs). If it's needed, encrypt the data that is stored on the SQL Server computer. Be aware that ACLs aren't applied to the trace files and there's no data masking or obfuscation. You should delete these files quickly after use.
Apply the appropriate ACLs and retention policy to all intermediate and dispatch files that are generated by Distributed Replay.
Use Transport Layer Security (TLS), previously known as Secure Sockets Layer (SSL), to help secure the network transport.
Important Removal Steps
We recommend that you only use Distributed Replay in a test environment. After you have completed testing, and before you provision those computers for a different task, make sure that you do the following:
Uninstall the Distributed Replay features and remove the related configuration files from the controller and all clients.
Delete any trace, intermediate, dispatch, and SQL Server database files that were used for testing. The intermediate and dispatch files are stored in the working directory on the controller and client, respectively.
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for