statistics (data type for replication link statistics property)

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The statistics data type in this section describes the statistics property of the link data type.

Replication link statistics data type properties

The following table describes the properties included in the statistics data type that describes the statistics property of the link data type.

Property name Data type Description Notes
bytesPending Long

Specifies the approximate amount of data currently waiting to be replicated from the local system to the remote system for the replication link, in bytes. This value is the sum of the amounts of data waiting to be sent in each HCP namespace included in the link. This value does not include data in the default namespace.

If the local system is the replica for an active/passive link, the value of this property during replication is zero. If the local system is the primary system for an active/passive link, the value of this property during data recovery is zero.

This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
bytesPendingRemote Long

Specifies the approximate amount of data currently waiting to be replicated from the remote system for the replication link to the local system, in bytes. This value is the sum of the amounts of data waiting to be sent in each HCP namespace included in the link. This value does not include data in the default namespace.

For an active/passive link, the value of this property is always zero.

This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
bytesPerSecond Double

Specifies the current rate of data transmission on the replication link, in bytes per second.

For an active/active link, the value of this property is the rate of data transmission from the local system to the remote system. For an active/passive link, the value of this property is the rate of data transmission during replication or recovery, whichever is happening at the time. In any case, the data transmission rate is cumulative for all the HCP namespaces and default-namespace directories included in the link.

This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
bytesReplicated Long Specifies the total number of bytes of data replicated from the local system to the remote system for the replication link since the link was created. This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
errors Long Specifies the total number of errors that have occurred during replication or recovery from the local system to the remote system for the replication link since the link was created. This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
errorsPerSecond Double

Specifies the current rate of errors on the replication link per second.

For an active/active link, the value of this property is the error rate for replication from the local system to the remote system for the link. For an active/passive link, the value of this property is the error rate during replication or recovery, whichever is happening at the time.

This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
objectsPending Long

Specifies the approximate number of objects currently waiting to be replicated from the local system to the remote system for the replication link. This value is the sum of the numbers of objects waiting to be sent in each HCP namespace included in the link. This value does not include objects in the default namespace.

If the local system is the replica for an active/passive link, the value of this property during replication is zero. If the local system is the primary system for an active/passive link, the value of this property during data recovery is zero.

This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
objectsPendingRemote Long

Specifies the approximate number of objects currently waiting to be replicated from the remote system for the replication link to the local system. This value is the sum of the numbers of objects waiting to be sent in each HCP namespace included in the link. This value does not include objects in the default namespace.

For an active/passive link, the value of this property is always zero.

This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
objectsReplicated Long Specifies the total number of objects replicated from the local system to the remote system for the replication link since the link was created. This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
objectsReplicatedAfterVerification Long Specifies the number of objects replicated by the Replication Verification service. This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
objectsVerified Long Specifies the number of objects analyzed by the Replication Verification service. This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
operationsPerSecond Double

Specifies the current rate of operations on the replication link per second. An operation is the replication of any of these:

  • An object, directory, symbolic link, metadata change, or object deletion
  • An HCP tenant or HCP namespace or the modification or deletion of an HCP tenant or HCP namespace
  • For HCP tenants only, the creation, modification, or deletion of a user account
  • The creation, modification, or deletion of a retention class
  • The creation, modification, or deletion of a content class
  • A tenant log message

For an active/active link, the value of this property is the operation rate for replication from the local system to the remote system for the link. For an active/passive link, the value of this property is the operation rate during replication or recovery, whichever is happening at the time. In any case, the operation rate is cumulative for all the tenants being replicated or recovered on the link.

This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
upToDateAsOfMillis Long

Specifies, in milliseconds since January 1, 1970, at 00:00:00 UTC:

  • For an active/active link, the date and time before which configuration changes and changes to namespace content are guaranteed to be synchronized in both directions between the two systems involved in the link
  • For an active/passive link, the date and time before which configuration changes and changes to namespace content are guaranteed to have been replicated or recovered on the link, as applicable
This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.
upToDateAsOfString String

Specifies, as a datetime string:

  • For an active/active link, the date and time before which configuration changes and changes to namespace content are guaranteed to be synchronized in both directions between the two systems involved in the link
  • For an active/passive link, the date and time before which configuration changes and changes to namespace content are guaranteed to have been replicated or recovered on the link, as applicable

The datetime string has this format:

yyyy-MM-ddThh:mm:ssZ

In this format, hh is the hour on a 24-hour clock, and Z represents the offset from UTC and is specified as:

(+|-)hhmm

For example:

2017-03-18T10:47:59-0400

This property is not valid on a PUT or POST request for a replication link. It is returned only by a verbose GET request.

Example

Here’s an XML example of the statistics data type that describes the statistics property of the link data type.

<statistics>
     <upToDateAsOfString>2019-07-12T10:47:59-0400</upToDateAsOfString>
     <upToDateAsOfMillis>1395154079640</upToDateAsOfMillis>
     <bytesPending>189027593061</bytesPending>
     <bytesPendingRemote>319740</bytesPendingRemote>
     <bytesReplicated>72254119306967</bytesReplicated>
     <bytesPerSecond>56215390</bytesPerSecond>
     <objectsPending>534</objectsPending>
     <objectsPendingRemote>2</objectsPendingRemote>
     <objectsReplicated>295661</objectsReplicated>
     <operationsPerSecond>119.1</operationsPerSecond>
     <errors>0</errors>
     <errorsPerSecond>0.0</errorsPerSecond>
     <objectsVerified>200000</objectsVerified>
     <objectsReplicatedAfterVerification>0</objectsReplicatedAfterVerification>
</statistics>