Share via

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

public DataSet EnumTracerTokenHistory (
    int tracerTokenId
)

public:
DataSet^ EnumTracerTokenHistory (
    int tracerTokenId
)

public DataSet EnumTracerTokenHistory (
    int tracerTokenId
)

public function EnumTracerTokenHistory (
    tracerTokenId : int
) : DataSet

Parameters

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

Return Value

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).

The EnumTracerTokenHistory method is available only with SQL Server 2005.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

PublicationMonitor Class
PublicationMonitor Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Measure Latency and Validate Connections for Transactional Replication (RMO Programming)