Jump to

• Request
• Response

View Incoming Statistics

get

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

Use this endpoint to view federation performance statistics from the perspective of the participant who receives federated data from 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 incoming statistics

Body ()

Root Schema : schema

Type: object

Show Source

• items(optional): array items

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

Nested Schema : items

Type: array

Show Source

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

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

Nested Schema : federationIncomingStatistics

Type: object

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

Show Source

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

  The bytes received per second.
• location(optional): string
  Read Only: true

  The location of the MBean server
• 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.
• msgsReceivedSecs(optional): integer(int64)
  Read Only: true

  The messages received 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
• 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.
• replicateMessageLastException(optional): string
  Read Only: true

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

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

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

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

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

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

  The total number of journal records that were received. A Journal Record could consist of multiple cache entries that are part of the same transaction.
• type(optional): string
  Read Only: true

  Allowed Values: [ "Origin" ]

  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":[
                "Origin"
            ],
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the remote participant",
            "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
        },
        "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
        },
        "bytesReceivedSecs":{
            "type":"integer",
            "format":"int64",
            "description":"The bytes received per second.",
            "readOnly":true
        },
        "msgsReceivedSecs":{
            "type":"integer",
            "format":"int64",
            "description":"The messages received per second.",
            "readOnly":true
        },
        "replicateMessageLastException":{
            "type":"string",
            "description":"The last exception recorded for a ReplicateMessage request.",
            "readOnly":true
        },
        "totalBytesReceived":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of bytes that were received.",
            "readOnly":true
        },
        "totalEntriesReceived":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of cache entries that were received.",
            "readOnly":true
        },
        "totalErrorRequests":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of ReplicateMessage requests with error. Check the log for details of the errors.",
            "readOnly":true
        },
        "totalRecordsReceived":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of journal records that were received. A Journal Record could consist of multiple cache entries that are part of the same transaction.",
            "readOnly":true
        },
        "totalMsgReceived":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of replication messages that were received. 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
        }
    }
}

Back to Top