Jump to

• Request
• Response

View Network Statistics Between Members

get

/management/coherence/cluster/members/{memberIdentifier}/networkStats

Use this endpoint to determine network performance from the current viewing member to the specified viewed member. To specify the viewed member, enter the ID of the member.

Request

Path Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that includes network status and statistics

Body ()

Root Schema : networkStats

Type: object

Show Source

• currentMemberId(optional): integer
  The Id of the member who is viewing.
• deferredPackets(optional): integer(int32)
  Read Only: true

  The number of packets addressed to the viewed member that the viewing member is currently deferring to send. The viewing member will delay sending these packets until the number of outstanding packets falls below the value of the Threshold attribute. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
• deferring(optional): boolean
  Read Only: true

  Indicates whether or not the viewing member is currently deferring packets to the viewed member. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
• lastIn(optional): integer(int64)
  Read Only: true

  The number of milliseconds that have elapsed since the viewing member last received an acknowledgment from the viewed member.
• lastOut(optional): integer(int64)
  Read Only: true

  The number of milliseconds that have elapsed since the viewing member last sent a packet to the viewed member.
• lastSlow(optional): integer(int64)
  Read Only: true

  The number of milliseconds that have elapsed since the viewing member declared the viewed member as slow, or -1 if the viewed member has never been declared slow.
• location(optional): string
  Read Only: true

  The location of the MBean server
• member(optional): string
  Read Only: true

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

  The ID of member to which the MBean belongs
• outstandingPackets(optional): integer(int32)
  Read Only: true

  The number of packets that the viewing member has sent to the viewed member which have yet to be acknowledged. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
• paused(optional): boolean
  Read Only: true

  Indicates whether or not the viewing member currently considers the viewed member to be unresponsive. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
• pauseRate(optional): number(float)
  Read Only: true

  The percentage of time since the last time statistics were reset in which the viewing member considered the viewed member to be unresponsive. Under normal conditions this value should be very close to 0.0. Values near 1.0 would indicate that the viewed node is nearly inoperable, likely due to extremely long GC pauses. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
• publisherSuccessRate(optional): number(float)
  Read Only: true

  The publisher success rate from the viewing node to the viewed node since the statistics were last reset.
• receiverSuccessRate(optional): number(float)
  Read Only: true

  The receiver success rate from the viewing node to the viewed node since the statistics were last reset.
• refreshTime(optional): string(date-time)
  Read Only: true

  The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
• threshold(optional): integer(int32)
  Read Only: true

  The maximum number of outstanding packets for the viewed member that the viewing member is allowed to accumulate before initiating the deferral algorithm. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
• type(optional): string
  Read Only: true

  Allowed Values: [ "PointToPoint" ]

  The type of the MBean
• viewedMemberId(optional): integer(int32)
  The Id of the member being viewed.
• viewerStatistics(optional): array viewerStatistics
  Read Only: true

  Human readable summary of the point-to-point statistics from the viewing member for all other members.

{
    "type":"object",
    "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":[
                "PointToPoint"
            ],
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member",
            "readOnly":true
        },
        "currentMemberId":{
            "type":"integer",
            "description":"The Id of the member who is viewing."
        },
        "receiverSuccessRate":{
            "type":"number",
            "format":"float",
            "description":"The receiver success rate from the viewing node to the viewed node since the statistics were last reset.",
            "readOnly":true
        },
        "lastIn":{
            "type":"integer",
            "format":"int64",
            "description":"The number of milliseconds that have elapsed since the viewing member last received an acknowledgment from the viewed member.",
            "readOnly":true
        },
        "viewedMemberId":{
            "type":"integer",
            "format":"int32",
            "description":"The Id of the member being viewed.",
            "readOnly":false
        },
        "publisherSuccessRate":{
            "type":"number",
            "format":"float",
            "description":"The publisher success rate from the viewing node to the viewed node since the statistics were last reset.",
            "readOnly":true
        },
        "lastSlow":{
            "type":"integer",
            "format":"int64",
            "description":"The number of milliseconds that have elapsed since the viewing member declared the viewed member as slow, or -1 if the viewed member has never been declared slow.",
            "readOnly":true
        },
        "outstandingPackets":{
            "type":"integer",
            "format":"int32",
            "description":"The number of packets that the viewing member has sent to the viewed member which have yet to be acknowledged.  The value of this attribute is only meaningful if the viewing member has FlowControl enabled.",
            "readOnly":true
        },
        "refreshTime":{
            "type":"string",
            "format":"date-time",
            "description":"The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.",
            "readOnly":true
        },
        "viewerStatistics":{
            "type":"array",
            "description":"Human readable summary of the point-to-point statistics from the viewing member for all other members.",
            "items":{
                "type":"string"
            },
            "readOnly":true
        },
        "lastOut":{
            "type":"integer",
            "format":"int64",
            "description":"The number of milliseconds that have elapsed since the viewing member last sent a packet to the viewed member.",
            "readOnly":true
        },
        "deferring":{
            "type":"boolean",
            "description":"Indicates whether or not the viewing member is currently deferring packets to the viewed member.  The value of this attribute is only meaningful if the viewing member has FlowControl enabled.",
            "readOnly":true
        },
        "pauseRate":{
            "type":"number",
            "format":"float",
            "description":"The percentage of time since the last time statistics were reset in which the viewing member considered the viewed member to be unresponsive. Under normal conditions this value should be very close to 0.0.  Values near 1.0 would indicate that the viewed node is nearly inoperable, likely due to extremely long GC pauses. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.",
            "readOnly":true
        },
        "deferredPackets":{
            "type":"integer",
            "format":"int32",
            "description":"The number of packets addressed to the viewed member that the viewing member is currently deferring to send.  The viewing member will delay sending these packets until the number of outstanding packets falls below the value of the Threshold attribute. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.",
            "readOnly":true
        },
        "paused":{
            "type":"boolean",
            "description":"Indicates whether or not the viewing member currently considers the viewed member to be unresponsive.  The value of this attribute is only meaningful if the viewing member has FlowControl enabled.",
            "readOnly":true
        },
        "threshold":{
            "type":"integer",
            "format":"int32",
            "description":"The maximum number of outstanding packets for the viewed member that the viewing member is allowed to accumulate before initiating the deferral algorithm.  The value of this attribute is only meaningful if the viewing member has FlowControl enabled.",
            "readOnly":true
        }
    }
}

Nested Schema : viewerStatistics

Type: array

Read Only: true

Human readable summary of the point-to-point statistics from the viewing member for all other members.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Human readable summary of the point-to-point statistics from the viewing member for all other members.",
    "items":{
        "type":"string"
    },
    "readOnly":true
}

Back to Top