- Setting XEvent session duration for Azure SQL and SQL Server 2025+.

Author: paulmedynski

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

@@ -1257,15 +1257,40 @@ protected virtual void OnMatchingEventWritten(EventWrittenEventArgs eventData)
 
         public readonly ref struct XEventScope : IDisposable
         {
-            private const int MaxXEventsLatencyS = 5;
+            # region Private Fields
 
+            // Maximum dispatch latency for XEvents, in seconds.
+            private const int MaxDispatchLatencySeconds = 5;
+
+            // The connection to use for all operations.
             private readonly SqlConnection _connection;
-            private readonly ushort _durationInMinutes;
+
+            // True if connected to an Azure SQL instance.
             private readonly bool _isAzureSql;
+
+            // True if connected to a non-Azure SQL Server version 17 or higher.
             private readonly bool _isVersion17OrHigher;
 
+            // Duration for the XEvent session, in minutes.
+            private readonly ushort _durationInMinutes;
+
+            # endregion
+
+            # region Properties
+
+            // The name of the XEvent session, derived from the session name
+            // provided at construction time, with a unique suffix appended.
             public string SessionName { get; }
 
+            #endregion
+
+            #region Construction
+
+            // Construct with the specified parameters.
+            //
+            // This will use the connection to query the server properties and
+            // setup and start the XEvent session.
+            //
             public XEventScope(
                 string sessionName,
                 // The connection must already be open.
@@ -1284,13 +1309,56 @@ public XEventScope(
                 // SQL Azure only supports database-scoped XEvent sessions
                 _isAzureSql = GetSqlServerProperty(connection, ServerProperty.EngineEdition) == "5";
                 _isVersion17OrHigher = int.Parse(GetSqlServerProperty(connection, ServerProperty.ProductMajorVersion)) >= 17;
+
+                // Setup and start the XEvent session.
+                string sessionLocation = _isAzureSql ? "DATABASE" : "SERVER";
 
-                SetupXEvent(eventSpecification, targetSpecification);
+                // Both Azure SQL and SQL Server 2025 (v17.x) and higher support
+                // setting a maximum duration for the XEvent session.
+                string duration =
+                    _isAzureSql || _isVersion17OrHigher
+                    ? $"MAX_DURATION={_durationInMinutes} MINUTES,"
+                    : string.Empty;
+
+                string xEventCreateAndStartCommandText =
+                    $@"CREATE EVENT SESSION [{SessionName}] ON {sessionLocation}
+                        {eventSpecification}
+                        {targetSpecification}
+                        WITH (
+                            {duration}
+                            MAX_MEMORY=16 MB,
+                            EVENT_RETENTION_MODE=ALLOW_SINGLE_EVENT_LOSS,
+                            MAX_DISPATCH_LATENCY={MaxDispatchLatencySeconds} SECONDS,
+                            MAX_EVENT_SIZE=0 KB,
+                            MEMORY_PARTITION_MODE=NONE,
+                            TRACK_CAUSALITY=ON,
+                            STARTUP_STATE=OFF)
+                            
+                        ALTER EVENT SESSION [{SessionName}] ON {sessionLocation} STATE = START ";
+
+                using SqlCommand createXEventSession = new SqlCommand(xEventCreateAndStartCommandText, _connection);
+                createXEventSession.ExecuteNonQuery();
             }
 
+            // Disposal stops and drops the XEvent session.
             public void Dispose()
-                => DropXEvent();
+            {
+                string dropXEventSessionCommand = _isAzureSql
+                    ? $"IF EXISTS (select * from sys.dm_xe_database_sessions where name ='{SessionName}')" +
+                        $" DROP EVENT SESSION [{SessionName}] ON DATABASE"
+                    : $"IF EXISTS (select * from sys.dm_xe_sessions where name ='{SessionName}')" +
+                        $" DROP EVENT SESSION [{SessionName}] ON SERVER";
+
+                using SqlCommand command = new SqlCommand(dropXEventSessionCommand, _connection);
+                command.ExecuteNonQuery();
+            }
+
+            #endregion
 
+            #region Public Methods
+
+            // Query the XEvent session for its collected events, returning them
+            // as an XML document.
             public System.Xml.XmlDocument GetEvents()
             {
                 string xEventQuery = _isAzureSql
@@ -1307,7 +1375,7 @@ INNER JOIN sys.dm_xe_sessions AS xe
 
                 using SqlCommand command = new SqlCommand(xEventQuery, _connection);
 
-                Thread.Sleep(MaxXEventsLatencyS * 1000);
+                Thread.Sleep(MaxDispatchLatencySeconds * 1000);
 
                 string? targetData = command.ExecuteScalar() as string;
                 Assert.NotNull(targetData);
@@ -1318,43 +1386,7 @@ INNER JOIN sys.dm_xe_sessions AS xe
                 return xmlDocument;
             }
 
-            private void SetupXEvent(string eventSpecification, string targetSpecification)
-            {
-                string sessionLocation = _isAzureSql ? "DATABASE" : "SERVER";
-                
-                // TODO: Does Azure SQL support setting duration as well?
-                string duration = _isVersion17OrHigher ? $"MAX_DURATION={_durationInMinutes} MINUTES," : string.Empty;
-
-                string xEventCreateAndStartCommandText = $@"CREATE EVENT SESSION [{SessionName}] ON {sessionLocation}
-                        {eventSpecification}
-                        {targetSpecification}
-                        WITH (
-                            {duration}
-                            MAX_MEMORY=16 MB,
-                            EVENT_RETENTION_MODE=ALLOW_SINGLE_EVENT_LOSS,
-                            MAX_DISPATCH_LATENCY={MaxXEventsLatencyS} SECONDS,
-                            MAX_EVENT_SIZE=0 KB,
-                            MEMORY_PARTITION_MODE=NONE,
-                            TRACK_CAUSALITY=ON,
-                            STARTUP_STATE=OFF)
-                            
-                        ALTER EVENT SESSION [{SessionName}] ON {sessionLocation} STATE = START ";
-
-                using SqlCommand createXEventSession = new SqlCommand(xEventCreateAndStartCommandText, _connection);
-                createXEventSession.ExecuteNonQuery();
-            }
-
-            private void DropXEvent()
-            {
-                string dropXEventSessionCommand = _isAzureSql
-                    ? $"IF EXISTS (select * from sys.dm_xe_database_sessions where name ='{SessionName}')" +
-                        $" DROP EVENT SESSION [{SessionName}] ON DATABASE"
-                    : $"IF EXISTS (select * from sys.dm_xe_sessions where name ='{SessionName}')" +
-                        $" DROP EVENT SESSION [{SessionName}] ON SERVER";
-
-                using SqlCommand command = new SqlCommand(dropXEventSessionCommand, _connection);
-                command.ExecuteNonQuery();
-            }
+            #endregion
         }
 
         /// <summary>