Skip to content

xp-logevent-transact-sql.md

Latest commit

 

History

History
95 lines (64 loc) · 3.08 KB

xp-logevent-transact-sql.md

File metadata and controls

95 lines (64 loc) · 3.08 KB
title xp_logevent (Transact-SQL)
description Logs a user-defined message in the SQL Server log file and in the Windows Event log.
author MashaMSFT
ms.author mathoma
ms.reviewer randolphwest
ms.date 06/23/2025
ms.service sql
ms.subservice system-objects
ms.topic reference
f1_keywords
xp_logevent
xp_logevent_TSQL
helpviewer_keywords
xp_logevent
dev_langs
TSQL

xp_logevent (Transact-SQL)

[!INCLUDE SQL Server]

Logs a user-defined message in the [!INCLUDE ssNoVersion] log file and in the Windows Event log. xp_logevent can be used to send an alert without sending a message to the client.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

xp_logevent { error_number , 'message' } [ , 'severity' ]

Arguments

[!INCLUDE extended-stored-procedures]

error_number

A user-defined error number larger than 50000. The maximum value is 2147483647 (2^31 - 1).

'message'

A character string with a maximum of 2048 characters.

'severity'

One of three character strings: INFORMATIONAL, WARNING, or ERROR. severity is optional, with a default of INFORMATIONAL.

Return code values

0 (success) or 1 (failure).

Result set

xp_logevent returns the following error message for the included code example:

The command(s) completed successfully.

Remarks

When you send messages from [!INCLUDE tsql] procedures, triggers, batches, and so on, use the RAISERROR statement instead of xp_logevent. xp_logevent doesn't call a message handler of a client, or set @@ERROR. To write messages to the Windows Event log and to the [!INCLUDE ssNoVersion] error log file within an instance of [!INCLUDE ssNoVersion], execute the RAISERROR statement.

Permissions

Requires membership in the db_owner fixed database role in the master database, or membership in the sysadmin fixed server role.

Examples

The following example logs the message, with variables passed to the message in the Windows Event Viewer.

DECLARE @@TABNAME VARCHAR(30),
    @@USERNAME VARCHAR(30),
    @@MESSAGE VARCHAR(255);

SET @@TABNAME = 'customers';
SET @@USERNAME = USER_NAME();

SELECT @@MESSAGE = 'The table ' + @@TABNAME + ' is not owned by the user
   ' + @@USERNAME + '.';

USE master;

EXECUTE xp_logevent 60000,
    @@MESSAGE, informational;

Related content