User-Configurable Event Class
Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance
Use the User-Configurable event category to monitor user-defined events. Create user-defined event classes to monitor events that cannot be monitored by the system-supplied event classes in other event categories. For example, a user-defined event can be created to monitor the progress of the application you are testing. As the application runs, it can generate events at predefined points, allowing you to determine the current execution point in your application.
User-Configurable Event Class Data Columns
Data column name | Data type | Description | Column ID | Filterable |
---|---|---|---|---|
ApplicationName | nvarchar | Name of the client application that created the connection to an instance of SQL Server. This column is populated with the values passed by the application rather than the displayed name of the program. | 10 | Yes |
BinaryData | image | Binary value dependent on the event class captured in the trace. | 2 | Yes |
ClientProcessID | int | ID assigned by the host computer to the process where the client application is running. This data column is populated if the client provides the client process ID. | 9 | Yes |
DatabaseID | int | ID of the database specified by the USE database statement or the default database if no USE database statement has been issued for a given instance. SQL Server Profiler displays the name of the database if the ServerName data column is captured in the trace and the server is available. Determine the value for a database by using the DB_ID function. | 3 | Yes |
DatabaseName | nvarchar | Name of the database in which the user statement is running. | 35 | Yes |
EventClass | int | Type of event = 82-91. | 27 | No |
EventSequence | int | The sequence of a given event within the request. | 51 | No |
GroupID | int | ID of the workload group where the SQL Trace event fires. | 66 | Yes |
HostName | nvarchar | Name of the computer on which the client is running. This data column is populated if the client provides the host name. To determine the host name, use the HOST_NAME function. | 8 | Yes |
IsSystem | int | Indicates whether the event occurred on a system process or a user process. 1 = system, 0 = user. | 60 | Yes |
LoginName | nvarchar | Name of the login of the user (either SQL Server security login or the Microsoft Windows login credentials in the form of DOMAIN\username). | 11 | Yes |
LoginSid | image | Security identifier (SID) of the logged-in user. You can find this information in the sys.server_principals catalog view. Each SID is unique for each login in the server. | 41 | Yes |
NTDomainName | nvarchar | Windows domain to which the user belongs. | 7 | Yes |
NTUserName | nvarchar | Windows user name. | 6 | Yes |
RequestID | int | The ID of the request containing the statement. | 49 | Yes |
SessionLoginName | nvarchar | Login name of the user who originated the session. For example, if you connect to SQL Server using Login1 and execute a statement as Login2, SessionLoginName shows Login1 and LoginName shows Login2. This column displays both SQL Server and Windows logins. | 64 | Yes |
SPID | int | ID of the session on which the event occurred. | 12 | Yes |
StartTime | datetime | Time at which the event started, if available. | 14 | Yes |
TextData | ntext | Text value dependent on the event class captured in the trace. | 1 | Yes |
TransactionID | bigint | System-assigned ID of the transaction. | 4 | Yes |
See Also
SQL Server Profiler
sp_trace_setevent (Transact-SQL)
sp_trace_generateevent (Transact-SQL)