Jump to

• Request
• Response

Perform a JFR operation for a Cluster Member

post

/management/coherence/cluster/members/{memberIdentifier}/diagnostic-cmd/{jfrCmd}

Use this endpoint to perform a JFR operation on a specific member. Example: jfrStart?options=name=myJfr,duration=60s,filename=$jfrFolder/myRecording.jfr The $jfrFolder must already exist on the node where the JFR is taken. If no folder is specified, the JFR recording will be saved in the current directory of the MBeanServer.

Request

Path Parameters

• jfrCmd: string
  The JFR command with its options. Valid commands are: jfrStart: start a JFR recording jfrStop: stop a JFR recording jfrDump: dump the JFR recording to a file jfrCheck: check the status of a JFR recording See the jcmd JFR command for more information. Example: jfrStart?options=name=myJfr,duration=60s,filename=$jfrFolder/myRecording.jfr The $jfrFolder must already exist on the node where the JFR is taken. If no folder is specified, the JFR recording will be saved in the current directory of the MBeanServer. In the case of role based cluster wide operation, the filename can be a path and if so, the JFR recording will be stored in $name-$nodeId.jfr
• memberIdentifier: string
  An identifier of the member, it can either be the name or the nodeId of the member.

Query Parameters

• options: string
  A list of comma separated (JFR) options

Back to Top

Response

Supported Media Types

• application/json

200 Response

If the command invocation is successful, it returns the messages returned by jcmd from executing the command on each node. If the command invocation fails, it returns the exception for each node.

Body ()

Root Schema : schema

Type: object

Show Source

• status(optional): string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        }
    }
}

Back to Top