PublicationMonitor.EnumTracerTokenHistory Method

  • Article

Returns Subscriber latency information for a single tracer token record inserted into a monitored transactional publication.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Function EnumTracerTokenHistory ( _
    tracerTokenId As Integer _
) As DataSet
'Usage
Dim instance As PublicationMonitor 
Dim tracerTokenId As Integer 
Dim returnValue As DataSet 

returnValue = instance.EnumTracerTokenHistory(tracerTokenId)

public DataSet EnumTracerTokenHistory(
    int tracerTokenId
)

public:
DataSet^ EnumTracerTokenHistory(
    int tracerTokenId
)

member EnumTracerTokenHistory : 
        tracerTokenId:int -> DataSet

public function EnumTracerTokenHistory(
    tracerTokenId : int
) : DataSet

Parameters

  • tracerTokenId
    Type: System.Int32
    An Int32 value that specifies the ID value that uniquely identifies the tracer token.

Return Value

Type: System.Data.DataSet
A DataSet object that contains the following columns.

Column

Data type

Description

distributor_latency

Int64

Number of seconds between the tracer token record being committed at the Publisher and being committed at the Distributor.

subscriber

String

Name of the Subscriber that received the tracer token.

subscriber_db

String

Name of the subscription database into which the tracer token record was inserted.

subscriber_latency

Int64

Number of seconds between the tracer token record being committed at the Distributor and being committed at the Subscriber.

overall_latency

Int64

Number of seconds between the tracer token record being committed at the Publisher and being committed at the Subscriber.

Remarks

One row is returned for each subscription that received the tracer token record. Call EnumTracerTokens to get the tracer tokens inserted into the monitored publication.

The EnumTracerTokenHistory method is only valid for transactional publications.

The EnumTracerTokenHistory method can only be called by members of the db_owner or replmonitor fixed database roles in the distribution database.

Calling EnumTracerTokenHistory is equivalent to executing sp_helptracertokenhistory (Transact-SQL).

See Also

Reference

PublicationMonitor Class

Microsoft.SqlServer.Replication Namespace

Other Resources

NIB Measure Latency and Validate Connections for Transactional Replication (RMO Programming)