catalog.create_customized_logging_level

APPLIES TO: yesSQL Server, including on Linux yesAzure SQL Database yesAzure SQL Data Warehouse noParallel Data Warehouse

APPLIES TO: yesSQL Server noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

Creates a new customized logging level. For more info about customized logging levels, see Integration Services (SSIS) Logging.

Syntax

catalog.create_customized_logging_level [ @level_name = ] level_name  
    , [ @level_description = ] level_description  
    , [ @profile_value = ] profile_value  
    , [ @events_value = ] events_value  
    , [ @level_id = ] level_id OUT   

Arguments

[ @level_name = ] level_name
The name for the new existing customized logging level.

The level_name is nvarchar(128).

[ @level_description = ] level_description
The description for the new existing customized logging level.

The level_description is nvarchar(max).

[ @profile_value = ] profile_value
The statistics that you want the new customized logging level to log.

Valid values for statistics include the following. These values correspond to the values on the Statistics tab of the Customized Logging Level Management dialog box.

  • Execution = 0

  • Volume = 1

  • Performance = 2

The profile_value is a bigint.

[ @events_value = ] events_value
The events that you want the new customized logging level to log.

Valid values for events include the following. These values correspond to the values on the Events tab of the Customized Logging Level Management dialog box.

Events without event context Events with event context
OnVariableValueChanged = 0

OnExecutionStatusChanged = 1

OnPreExecute = 2

OnPostExecute = 3

OnPreValidate = 4

OnPostValidate = 5

OnWarning = 6

OnInformation = 7

OnError = 8

OnTaskFailed = 9

OnProgress = 10

OnQueryCancel = 11

OnBreakpointHit = 12

OnCustomEvent = 13

Diagnostic = 14

DiagnosticEx = 15

NonDiagnostic = 16
OnVariableValueChanged_IncludeContext = 32

OnExecutionStatusChanged_IncludeContext = 33

OnPreExecute_IncludeContext = 34

OnPostExecute_IncludeContext = 35

OnPreValidate_IncludeContext = 36

OnPostValidate_IncludeContext = 37

OnWarning_IncludeContext = 38

OnInformation_IncludeContext = 39

OnError_IncludeContext = 40

OnTaskFailed_IncludeContext = 41

OnProgress_IncludeContext = 42

OnQueryCancel_IncludeContext= 43

OnBreakpointHit_IncludeContext = 44

OnCustomEvent_IncludeContext = 45

Diagnostic_IncludeContext = 46

DiagnosticEx_IncludeContext = 47

NonDiagnostic_IncludeContext = 48

The events_value is a bigint.

[ @level_id = ] level_id OUT
The id of the new customized logging level.

The level_id is a bigint.

Remarks

To combine multiple values in Transact-SQL for the profile_value or events_value argument, follow this example. To capture the OnError (8) and DiagnosticEx (15) events, the formula to calculate events_value is 2^8 + 2^15 = 33024.

Return Codes

0 (success)

When the stored procedure fails, it throws an error.

Result Set

None

Permissions

This stored procedure requires one of the following permissions:

  • Membership in the ssis_admin database role

  • Membership in the sysadmin server role

Errors and Warnings

The following list describes conditions that cause the stored procedure to fail.

  • The user does not have the required permissions.