TechNet
Export (0) Print
Expand All

Monitoring Traces (XMLA)

 

Applies To: SQL Server 2016 Preview

You can use the Subscribe command in XML for Analysis (XMLA) to monitor an existing trace defined on an instance of Microsoft SQL Server Analysis Services. The Subscribe command returns the results of a trace as a rowset.

The Object property of the Subscribe command must contain an object reference to either an Analysis Services instance or a trace on an Analysis Services instance. If the Object property is not specified, or a trace identifier is not specified in the Object property, the Subscribe command monitors the default session trace for the explicit session specified in the SOAP header for the command.

The Subscribe command returns a rowset containing the trace events captured by the specified trace. The Subscribe command returns trace results until the command is canceled by the Cancel command.

The rowset contains the columns listed in the following table.

ColumnData typeDescription
EventClassIntegerThe event class of the event received by the trace.
EventSubclassLong integerThe event subclass of the event received by the trace.
CurrentTimeDatetimeThe time at which the event started, when available. For filtering, expected formats are 'YYYY-MM-DD' and 'YYYY-MM-DD HH:MM:SS'.
StartTimeDatetimeThe time at which the event started, when available. For filtering, expected formats are 'YYYY-MM-DD' and 'YYYY-MM-DD HH:MM:SS'.
EndTimeDatetimeThe time at which the event ended, when available. For filtering, expected formats are 'YYYY-MM-DD' and 'YYYY-MM-DD HH:MM:SS'.

This column is not populated for event classes that describe the start of a process or action.
DurationLong integerThe amount of total time (in milliseconds) elapsed for the event.
CPUTimeLong integerThe amount of processor time (in milliseconds) elapsed for the event.
JobIDLong integerThe job identifier for the process.
SessionIDStringThe identifier of the session for which the event occurred.
SessionTypeStringThe type of the session for which the event occurred.
ProgressTotalLong integerThe total number or amount of progress reported by the event.
IntegerDataLong integerInteger data associated with the event. The contents of this column depend on the event class and subclass of the event.
ObjectIDStringThe identifier of the object for which the event occurred.
ObjectTypeStringThe type of the object specified in ObjectName.
ObjectNameStringThe name of the object for which the event occurred.
ObjectPathStringThe hierarchical path of the object for which the event occurred. The path is represented as a comma-delimited string of object identifiers for the parents of the object specified in ObjectName.
ObjectReferenceStringThe XML representation of the object reference for the object specified in ObjectName.
NestLevelIntegerThe level of the transaction for which the event occurred.
NumSegmentsLong integerThe number of data segments affected or accessed by the command for which the event occurred.
SeverityIntegerThe severity level of an exception for the event. The column can contain one of the following values:

 

0: Success

 

1: Information

 

2: Warning

 

3: Error
SuccessBooleanIndicates whether a command succeeded or failed.
ErrorLong integerThe error number of the event, if applicable.
ConnectionIDStringThe identifier of the connection for which the event occurred.
DatabaseNameStringThe name of the database for which the event occurred.
NTUserNameStringThe Windows user name of the user associated with the event.
NTDomainNameStringThe Windows domain of the user associated with the event.
ClientHostNameStringThe name of the computer on which the client application is running. This column is populated with the values passed by the client application.
ClientProcessIDLong integerThe process identifier of the client application.
ApplicationNameStringThe name of the client application that created the connection to the Analysis Services instance. This column is populated with the values passed by the client application, rather than the displayed name of the program.
NTCanonicalUserNameStringThe Windows canonical user name of the user associated with the event.
SPIDStringThe server process ID (SPID) of the session for which the event occurred. The value of this column directly corresponds to the session ID specified in the SOAP header of the XMLA message for which the event occurred.
TextDataStringThe text data associated with the event. The contents of this column depend on the event class and subclass of the event.
ServerNameStringThe name of the Analysis Services instance for which the event occurred.
RequestParametersStringThe parameters of the parameterized query or XMLA command for which the event occurred.
RequestPropertiesStringThe properties of the XMLA method for which the event occurred.

Developing with XMLA in Analysis Services

Community Additions

ADD
Show:
© 2016 Microsoft