Jump to

• Request
• Response

View Outgoing Statistics

get

/management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/federation/statistics/outgoing/participants

Use this endpoint to view federation performance statistics from the perspective of the participant who sends federated data to remote federation participants. A list of statistics is returned for each remote participant.

Request

Path Parameters

• memberIdentifier: string
  An identifier of the member, it can either be the name or the nodeId of the member.
• serviceName: string
  Name of the cache service.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns a list of outgoing statistics

Body ()

Root Schema : schema

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/federationOutgoingStatistics"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object federationOutgoingStatistics
  Provides out-going replication statistics from a destination's perspective.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/federationOutgoingStatistics"
    }
}

Nested Schema : federationOutgoingStatistics

Type: object

Provides out-going replication statistics from a destination's perspective.

Show Source

• bytesSentSecs(optional): integer(int64)
  Read Only: true

  The bytes sent per second.
• connectRetryTimeoutMillis(optional): integer(int64)
  Return the configured connect retry timeout.
• currentBandwidth(optional): number(double)
  Read Only: true

  The current utilized bandwidth in megabits per second for sending replicate message.
• errorDescription(optional): string
  Read Only: true

  Return an error description. This only returns a value if the sender is in an ERROR state.
• estimatedReplicateAllRemainingTime(optional): integer(int64)
  Read Only: true

  The estimated remaining time (in milliseconds) in completing the replicateAll request.
• geoIp(optional): string
  Read Only: true

  Return the Geo-Ip metadata.
• location(optional): string
  Read Only: true

  The location of the MBean server
• maxBandwidth(optional): number(double)
  Read Only: true

  The maximum bandwidth in megabits per second for sending replicate message. "-1.0" means the max-bandwidth is not specified.
• member(optional): string
  Read Only: true

  Name of the cluster member
• msgApplyTimePercentileMillis(optional): integer(int64)
  Read Only: true

  The 90-percentile value of the time (in milliseconds) it took to apply the replication messages on the destination.
• msgNetworkRoundTripTimePercentileMillis(optional): integer(int64)
  Read Only: true

  The 90-percentile value of the time (in milliseconds) taken by transmission of replication messages and the corresponding ack messages over the network.
• msgsSentSecs(optional): integer(int64)
  Read Only: true

  The messages sent per second.
• name(optional): string
  Read Only: true

  Name of the remote participant
• nodeId(optional): integer(int64)
  Read Only: true

  The ID of member to which the MBean belongs
• participantType(optional): string
  Read Only: true

  Return the participant type. Valid types are cluster and interceptor.
• recordBacklogDelayTimePercentileMillis(optional): integer(int64)
  Read Only: true

  The 90-percentile value of the time (in milliseconds) the Journal Records are in the Cache waiting to be replicated.
• replicateAllLastException(optional): string
  Read Only: true

  The last exception recorded for a replicateAll request.
• replicateAllPartitionCompletedCount(optional): integer(int64)
  Read Only: true

  The total number of partitions completed for the replicateAll request.
• replicateAllPartitionCount(optional): integer(int64)
  Read Only: true

  The total number of partitions in the replicateAll request.
• replicateAllPartitionErrorCount(optional): integer(int64)
  Read Only: true

  The number of partitions with error responses for the replicateAll request. Check ReplicateAllLastException for details of the last exception and the log for details of all the errors.
• replicateAllPercentComplete(optional): integer(int64)
  Read Only: true

  The percent of work completed for the replicateAll request. If there are any problem in replicateAll, ReplicateAllPartitionErrorCount will be greater than 0. Please look at the server log for details of the errors.
• replicateAllTotalTime(optional): integer(int64)
  Read Only: true

  The total time (in milliseconds) the replicateAll request took.
• sendTimeoutMillis(optional): integer(int64)
  Read Only: true

  Return the configured send timeout.
• state(optional): string
  Read Only: true

  Return the participant state.
• stateCode(optional): integer(int32)
  Read Only: true

  Return the participant state code. The value of: 0: INITIAL 1: STARTING 2: CONNECTING 3: CONNECT_WAIT 4: IDLE 5: READY 6: SENDING 7: STOPPED 8: PAUSED 9: ERROR 10: YIELDING 11: DISCONNECTED 12: DISCONNECTING
• status(optional): integer(int32)
  Read Only: true

  Return the participant status. 0 implies ok, 1 implies Warning, 2 implies Error.
• totalBytesSent(optional): integer(int64)
  Read Only: true

  The total number of bytes that were sent.
• totalEntriesSent(optional): integer(int64)
  Read Only: true

  The total number of cache entries that were sent.
• totalErrorResponses(optional): integer(int64)
  Read Only: true

  The total number of responses with error. Check the log for details of the errors
• totalMsgSent(optional): integer(int64)
  Read Only: true

  The total number of replication messages that were sent. A Replication message could contain multiple journal records.
• totalMsgUnacked(optional): integer(int64)
  Read Only: true

  The total number of un-acked replication messages.
• totalRecordsSent(optional): integer(int64)
  Read Only: true

  The total number of journal records that were sent. A Journal Record could consist of multiple cache entries that are part of the same transaction.
• traceLogging(optional): boolean
  Default Value: false

  True if federation trace logging is turned on.
• type(optional): string
  Read Only: true

  Allowed Values: [ "Destination" ]

  The type of the MBean

{
    "type":"object",
    "description":"Provides out-going replication statistics from a destination's perspective.",
    "properties":{
        "nodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of member to which the MBean belongs",
            "readOnly":true
        },
        "location":{
            "type":"string",
            "description":"The location of the MBean server",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "Destination"
            ],
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the remote participant",
            "readOnly":true
        },
        "recordBacklogDelayTimePercentileMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The 90-percentile value of the time (in milliseconds) the Journal Records are in the Cache waiting to be replicated.",
            "readOnly":true
        },
        "sendTimeoutMillis":{
            "type":"integer",
            "format":"int64",
            "description":"Return the configured send timeout.",
            "readOnly":true
        },
        "connectRetryTimeoutMillis":{
            "type":"integer",
            "format":"int64",
            "description":"Return the configured connect retry timeout.",
            "readOnly":false
        },
        "geoIp":{
            "type":"string",
            "description":"Return the Geo-Ip metadata.",
            "readOnly":true
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"Return the participant status. 0 implies ok, 1 implies Warning, 2 implies Error.",
            "readOnly":true
        },
        "errorDescription":{
            "type":"string",
            "description":"Return an error description. This only returns a value if the sender is in an ERROR state.",
            "readOnly":true
        },
        "currentBandwidth":{
            "type":"number",
            "format":"double",
            "description":"The current utilized bandwidth in megabits per second for sending replicate message.",
            "readOnly":true
        },
        "maxBandwidth":{
            "type":"number",
            "format":"double",
            "description":"The maximum bandwidth in megabits per second for sending replicate message. \"-1.0\" means the max-bandwidth is not specified.",
            "readOnly":true
        },
        "participantType":{
            "type":"string",
            "description":"Return the participant type. Valid types are cluster and interceptor.",
            "readOnly":true
        },
        "msgApplyTimePercentileMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The 90-percentile value of the time (in milliseconds) it took to apply the replication messages on the destination.",
            "readOnly":true
        },
        "msgNetworkRoundTripTimePercentileMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The 90-percentile value of the time (in milliseconds) taken by transmission of replication messages and the corresponding ack messages over the network.",
            "readOnly":true
        },
        "replicateAllLastException":{
            "type":"string",
            "description":"The last exception recorded for a replicateAll request.",
            "readOnly":true
        },
        "replicateAllPartitionCompletedCount":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of partitions completed for the replicateAll request.",
            "readOnly":true
        },
        "replicateAllPartitionCount":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of partitions in the replicateAll request.",
            "readOnly":true
        },
        "replicateAllPartitionErrorCount":{
            "type":"integer",
            "format":"int64",
            "description":"The number of partitions with error responses for the replicateAll request. Check ReplicateAllLastException for details of the last exception and the log for details of all the errors.",
            "readOnly":true
        },
        "replicateAllPercentComplete":{
            "type":"integer",
            "format":"int64",
            "description":"The percent of work completed for the replicateAll request. If there are any problem in replicateAll, ReplicateAllPartitionErrorCount will be greater than 0.  Please look at the server log for details of the errors.",
            "readOnly":true
        },
        "estimatedReplicateAllRemainingTime":{
            "type":"integer",
            "format":"int64",
            "description":"The estimated remaining time (in milliseconds) in completing the replicateAll request.",
            "readOnly":true
        },
        "replicateAllTotalTime":{
            "type":"integer",
            "format":"int64",
            "description":"The total time (in milliseconds) the replicateAll request took.",
            "readOnly":true
        },
        "bytesSentSecs":{
            "type":"integer",
            "format":"int64",
            "description":"The bytes sent per second.",
            "readOnly":true
        },
        "msgsSentSecs":{
            "type":"integer",
            "format":"int64",
            "description":"The messages sent per second.",
            "readOnly":true
        },
        "state":{
            "type":"string",
            "description":"Return the participant state.",
            "readOnly":true
        },
        "stateCode":{
            "type":"integer",
            "format":"int32",
            "description":"Return the participant state code. The value of:\n 0: INITIAL\n 1: STARTING\n 2: CONNECTING\n 3: CONNECT_WAIT\n 4: IDLE\n 5: READY\n 6: SENDING\n 7: STOPPED\n 8: PAUSED\n 9: ERROR\n 10: YIELDING\n 11: DISCONNECTED\n 12: DISCONNECTING",
            "readOnly":true
        },
        "totalBytesSent":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of bytes that were sent.",
            "readOnly":true
        },
        "totalEntriesSent":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of cache entries that were sent.",
            "readOnly":true
        },
        "totalRecordsSent":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of journal records that were sent. A Journal Record could consist of multiple cache entries that are part of the same transaction.",
            "readOnly":true
        },
        "totalMsgSent":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of replication messages that were sent. A Replication message could contain multiple journal records.",
            "readOnly":true
        },
        "totalMsgUnacked":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of un-acked replication messages.",
            "readOnly":true
        },
        "totalErrorResponses":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of responses with error. Check the log for details of the errors",
            "readOnly":true
        },
        "traceLogging":{
            "default":"false",
            "type":"boolean",
            "description":"True if federation trace logging is turned on."
        }
    }
}

Back to Top