Redigera

Dela via

sp_add_alert (Transact-SQL)

  • Artikel

Applies to: SQL Server

Creates an alert.

Transact-SQL syntax conventions

Syntax

sp_add_alert [ @name = ] N'name'
     [ , [ @message_id = ] message_id ]
     [ , [ @severity = ] severity ]
     [ , [ @enabled = ] enabled ]
     [ , [ @delay_between_responses = ] delay_between_responses ]
     [ , [ @notification_message = ] N'notification_message' ]
     [ , [ @include_event_description_in = ] include_event_description_in ]
     [ , [ @database_name = ] N'database_name' ]
     [ , [ @event_description_keyword = ] N'event_description_keyword' ]
     [ , { [ @job_id = ] job_id | [ @job_name = ] N'job_name' } ]
     [ , [ @raise_snmp_trap = ] raise_snmp_trap ]
     [ , [ @performance_condition = ] N'performance_condition' ]
     [ , [ @category_name = ] N'category_name' ]
     [ , [ @wmi_namespace = ] N'wmi_namespace' ]
     [ , [ @wmi_query = ] N'wmi_query' ]
[ ; ]

Arguments

[ @name = ] N'name'

The name of the alert. The name appears in the e-mail or pager message sent in response to the alert. It must be unique and can contain the percent (%) character. @name is sysname, with no default.

[ @message_id = ] message_id

The message error number that defines the alert. (It usually corresponds to an error number in the sysmessages table.) @message_id is int, with a default of 0. If @severity is used to define the alert, @message_id must be 0 or NULL.

Only sysmessages errors written to the Microsoft Windows application log can cause an alert to be sent.

[ @severity = ] severity

The severity level (from 1 through 25) that defines the alert. @severity is int, with a default of 0. Any SQL Server message stored in the sysmessages table sent to the Windows application log with the indicated severity causes the alert to be sent. If @message_id is used to define the alert, @severity must be 0.

[ @enabled = ] enabled

Indicates the current status of the alert. @enabled is tinyint, with a default of 1 (enabled). If 0, the alert isn't enabled and doesn't fire.

[ @delay_between_responses = ] delay_between_responses

The wait period, in seconds, between responses to the alert. @delay_between_responses is int, with a default of 0, which means there's no waiting between responses (each occurrence of the alert generates a response). The response can be in either or both of these forms:

  • One or more notifications sent through e-mail or pager
  • A job to execute

By setting this value, it's possible to prevent, for example, unwanted e-mail messages from being sent when an alert repeatedly occurs in a short period of time.

[ @notification_message = ] N'notification_message'

An optional additional message sent to the operator as part of the e-mail, net send, or pager notification. @notification_message is nvarchar(512), with a default of NULL. Specifying @notification_message is useful for adding special notes such as remedial procedures.

[ @include_event_description_in = ] include_event_description_in

Whether the description of the SQL Server error should be included as part of the notification message. @include_event_description_in is tinyint, with a default of 5 (e-mail and net send), and can have one or more of these values combined with an OR logical operator.

Important

The Pager and net send options will be removed from SQL Server Agent in a future version of SQL Server. Avoid using these features in new development work, and plan to modify applications that currently use these features.

Value Description
0 None
1 E-mail
2 Pager
4 net send

[ @database_name = ] N'database_name'

The database in which the error must occur for the alert to fire. If @database_name isn't supplied, the alert fires regardless of where the error occurred. @database_name is sysname, with a default of NULL. Names that are enclosed in brackets ([ ]) aren't allowed.

[ @event_description_keyword = ] N'event_description_keyword'

A sequence of characters that must be found in the description of the SQL Server error in the error message log. @event_description_keyword is nvarchar(100), with a default of NULL. This parameter is useful for filtering object names (for example, customer_table).

Note

Transact-SQL LIKE expression pattern-matching characters can't be used.

[ @job_id = ] job_id

The job identification number of the job to run in response to this alert. @job_id is uniqueidentifier, with a default of NULL.

Either @job_id or @job_name must be specified, but both can't be specified.

[ @job_name = ] N'job_name'

The name of the job to be executed in response to this alert. @job_name is sysname, with a default of NULL.

Either @job_id or @job_name must be specified, but both can't be specified.

[ @raise_snmp_trap = ] raise_snmp_trap

Not implemented in SQL Server version 7.0. @raise_snmp_trap is tinyint, with a default of 0.

[ @performance_condition = ] N'performance_condition'

A value expressed in the format 'ItemComparatorValue'. @performance_condition is nvarchar(512), with a default of NULL, and consists of these elements.

Format element Description
Item A performance object, performance counter, or named instance of the counter.
Comparator One of these operators: >, <, or =.
Value Numeric value of the counter.

[ @category_name = ] N'category_name'

The name of the alert category. @category_name is sysname, with a default of NULL.

[ @wmi_namespace = ] N'wmi_namespace'

The WMI namespace to query for events. @wmi_namespace is sysname, with a default of NULL. Only namespaces on the local server are supported.

[ @wmi_query = ] N'wmi_query'

The query that specifies the WMI event for the alert. @wmi_query is nvarchar(512), with a default of NULL.

Return code values

0 (success) or 1 (failure).

Result set

None.

Remarks

sp_add_alert must be run from the msdb database.

These are the circumstances under which errors/messages generated by SQL Server and SQL Server applications are sent to the Windows application log and can therefore raise alerts:

  • Severity 19 or higher sys.messages errors
  • Any RAISERROR statement invoked with WITH LOG syntax
  • Any sys.messages error modified or created using sp_altermessage
  • Any event logged using xp_logevent

SQL Server Management Studio provides an easy, graphical way to manage the entire alerting system and is the recommended way to configure an alert infrastructure.

If an alert isn't functioning properly, check whether:

  • The SQL Server Agent service is running

  • The event appeared in the Windows application log

  • The alert is enabled

  • Events generated with xp_logevent occur in the master database. Therefore, xp_logevent doesn't trigger an alert unless the @database_name for the alert is master or NULL.

Permissions

By default, only members of the sysadmin fixed server role can execute sp_add_alert.

Examples

The following example adds an alert (Test Alert) that runs the Back up the AdventureWorks2022 Database job when fired.

Note

This example assumes that the message 55001 and the Back up the AdventureWorks2022 Database job already exist. The example is shown for illustrative purposes only.

USE msdb;
GO

EXEC dbo.sp_add_alert
    @name = N'Test Alert',
    @message_id = 55001,
    @severity = 0,
    @notification_message = N'Error 55001 has occurred. The database will be backed up...',
    @job_name = N'Back up the AdventureWorks2022 Database';
GO

Related content