GET /ops/performance

Description

Get performance data by category. See the cat parameter below for a list of categories.

For example, [/ops/performance?cat0=uri&cat1=method&ago=60h] requests for performance data grouped by uri in the first level of data grouping, and method in the second level of grouping, so the response will contain performance data for different URIs and different HTTP Methods.

The response object will be of the following format:

processID -
data - array of performance data objects of the following format
- object - array of values pertaining to the requested list of categories. The number of elements in this array corresponds to the number of requested categories, the first corresponding to the primary requested category (i.e. cat0), etc, etc.
- leg - leg in request processing
- numRequests - Number of requests
- AVG_bytesReceived - Average number of bytes received
- AVG_bytesSent - Average number of bytes sent
- AVG_duration - Average duration of request processing
- MIN_duration - Minumum duration of request processing
- MAX_duration - Maximum duration of request processing

Resource URL

http://localhost:8090/ops/performance

Parameters

cat{n}

mandatory

Specifies categories of groupings for which to get performance data. The category parameter can be specified multiple times. The category parameter must be suffixed with an integer value {n} (ranging from 0 to 13, which maps to the 14 categories listed below) specifying the priority of the specified category. E.g. the primary category of grouping will be cat0, etc. The possible categories are as follows:

Category	Description
correlationId	A correlation-Id is a transaction ID created by the API Server
remoteAddr	The IP (or other network protocol) address of the remote side of the established communication channel
remotePort	The port number at the remote system to identify this channel. Where the remote is a server, this will be the well known port number used to contact it. For connections received by the API Server, this will likely be an ephemeral port number allocated by the client�s network stack to identify the call.
localAddr	The IP (or other network protocol) address of the local side of the established connection. This address will be likely assigned to one of the network adapters on the system running the API Server.
localPort	The TCP port number the local system uses to identify the communications channel. For inbound connections, this is the well known port the gateway is listening on where the call arrived. For outbound connections, this will be an ephemeral port allocated by the API Server�s operating system.
sslsubject	For SSL associations, this represents the distinguished name of the peer, as taken from the subject field of their verified certificate. This will be optionally present for inbound associations where the client presented a certificate for mutual authentication.
remoteName	The name used to contact the remote system, before any DNS lookups are performed (eg, �www.server.com�)
uri	Destination URI
status	HTTP response status code
statustext	Data section of the HTTP response status code
method	HTTP 1.1 method
operation	WebService operation name
service	WebService name
subject	Contains the ID of the authenticated subject (for example, the username supplied by the client).

ago

optional

Integer value specifying the age in milliseconds of the transactions from which performance data will be generated. This value can also be suffixed with one of the following:

h - Hours
m - Minutes
s - Seconds

Response Codes

Response Code	Description
200	Success

Example Request

GET http://localhost:8090/ops/performance?cat0=uri&cat1=method&ago=60h

{
    "processId": "",
    "data": [
       {
           "object": [
               "/",
               "GET"
           ],
           "leg": 1,
           "numRequests": 331,
           "AVG_bytesReceived": 478,
           "AVG_bytesSent": 1812,
           "AVG_duration": 1812,
           "MIN_duration": 1812,
           "MAX_duration": 0
       },
       {
           "object": [
               "/favicon.ico",
               "GET"
           ],
           "leg": 2,
           "numRequests": 327,
           "AVG_bytesReceived": 463,
           "AVG_bytesSent": 2235,
           "AVG_duration": 1985,
           "MIN_duration": 2485,
           "MAX_duration": 0
       },
       {
           "object": [
               "/healthcheck",
               "GET"
           ],
           "leg": 1,
           "numRequests": 387,
           "AVG_bytesReceived": 507,
           "AVG_bytesSent": 2969,
           "AVG_duration": 2969,
           "MIN_duration": 2969,
           "MAX_duration": 0
       },
       {
           "object": [
               "/healthcheck",
               "POST"
           ],
           "leg": 2,
           "numRequests": 236,
           "AVG_bytesReceived": 314,
           "AVG_bytesSent": 4343,
           "AVG_duration": 1500,
           "MIN_duration": 7187,
           "MAX_duration": 0
       }
    ]
}