PublisherMonitor.EnumLogReaderAgentSessionDetails(String, String) PublisherMonitor.EnumLogReaderAgentSessionDetails(String, String) PublisherMonitor.EnumLogReaderAgentSessionDetails(String, String) PublisherMonitor.EnumLogReaderAgentSessionDetails(String, String) Method

Definition

Returns detailed information about a Log Reader Agent session.

public:
 System::Data::DataSet ^ EnumLogReaderAgentSessionDetails(System::String ^ agentName, System::String ^ sessionId);
public System.Data.DataSet EnumLogReaderAgentSessionDetails (string agentName, string sessionId);
member this.EnumLogReaderAgentSessionDetails : string * string -> System.Data.DataSet
Public Function EnumLogReaderAgentSessionDetails (agentName As String, sessionId As String) As DataSet

Parameters

agentName
String String String String

A String value that specifies the name of the Log Reader Agent. You can obtain this value from the LogReaderAgentName property of the published database.

sessionId
String String String String

A String value that represents the data and time of the session for which details are returned. This value can be obtained from the time column returned by the EnumLogReaderAgentSessions(String, Int32, Boolean) method.

Returns

A DataSet object that contains the following columns.

Column Data type Description
runstatus Int32 The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail
time String Time of logging for session detail.
comments String Descriptive text.
duration Int32 Elapsed time of the logged session activity, in seconds.
delivery_rate Single Average number of commands delivered per second.
delivery_latency Int32 The time, in milliseconds, between a command being committed to the published database and being committed to the distribution database.
delivery_time Int32 Time the first transaction is delivered.
delivered_transactions Int32 Total number of transactions delivered in the session.
delivered_commands Int32 Total number of commands delivered in the session.
average_commands Int32 Average number of commands per transaction delivered in the session.
error_id Int32 The ID of the error in the [MSrepl_errors (Transact-SQL)](http://msdn.microsoft.com/library/c6e023c1-2c32-4269-8d76-e442ea309e4b) system table. Use the EnumErrorRecords(Int32) method to return detailed information about an error.

Remarks

You should commit any property changes to the PublisherMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.

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

Applies to

See also