Edit

SqlErrorLogEvent class

  • Article

Applies to: SQL Server

Provides properties for viewing events in a specified SQL Server log file.

Syntax

class SQLErrorLogEvent
{
    stringFileName;
    stringInstanceName;
    datetimeLogDate;
    stringMessage;
    stringProcessInfo;
};

Properties

The SQLErrorLogEvent class defines the following properties.

Property Description
FileName Data type: string

Access type: Read-only

The name of the error log file.
InstanceName Data type: string

Access type: Read-only

Qualifiers: Key

The name of the instance of SQL Server where the log file resides.
LogDate Data type: datetime

Access type: Read-only

Qualifiers: Key

The date and time that the event was recorded in the log file.
Message Data type: string

Access type: Read-only

The event message.
ProcessInfo Data type: string

Access type: Read-only

Information about the source server process ID (SPID) for the event.

Remarks

Type Name
MOF - sqlmgmprovider.mof (SQL Server 2022 (16.x) and later versions)
- sqlmgmproviderxpsp2up.mof (SQL Server 2019 (15.x) and earlier versions)
DLL sqlmgmprovider.dll
Namespace \root\Microsoft\SqlServer\ComputerManagement10

Example

The following example shows how to retrieve values for all logged events in a specified log file. To run the example, replace <Instance_Name> with the name of the instance of SQL Server, such as 'Instance1', and replace 'File_Name' with the name of the error log file, such as 'ERRORLOG.1'.

on error resume next
strComputer = "."
Set objWMIService = GetObject("winmgmts:" _
    & "{impersonationLevel=impersonate}!\\" _
    & strComputer & "\root\MICROSOFT\SqlServer\ComputerManagement10")
set logEvents = objWmiService.ExecQuery("SELECT * FROM SqlErrorLogEvent WHERE InstanceName = '<Instance_Name>' AND FileName = 'File_Name'")
  
For Each logEvent in logEvents
WScript.Echo "Instance Name: " & logEvent.InstanceName & vbNewLine _
    & "Log Date: " & logEvent.LogDate & vbNewLine _
    & "Log File Name: " & logEvent.FileName & vbNewLine _
    & "Process Info: " & logEvent.ProcessInfo & vbNewLine _
    & "Message: " & logEvent.Message & vbNewLine _
  
Next

Comments

When InstanceName or FileName aren't provided in the WQL statement, the query returns information for the default instance and the current SQL Server log file. For example, the following WQL statement returns all log events from the current log file (ERRORLOG) on the default instance (MSSQLSERVER).

"SELECT * FROM SqlErrorLogEvent"

Security

To connect to a SQL Server log file through WMI, you must have the following permissions on both the local and remote computers:

  • Read access to the Root\Microsoft\SqlServer\ComputerManagement10 WMI namespace. By default, everyone has read access through the Enable Account permission.

  • Read permission to the folder that contains the error logs. By default the error logs are located in the following path (where <Drive> represents the drive where you installed SQL Server and <InstanceName> is the name of the instance of SQL Server):

    <Drive>:\Program Files\Microsoft SQL Server\MSSQL13 .<InstanceName>\MSSQL\Log

If you're connecting through a firewall, ensure that an exception is set in the firewall for WMI on remote target computers. For more information, see Connecting to WMI Remotely Starting with Windows Vista.

See also