Performance Monitor API
Version: 1.0.0
Status: 
PerformanceMonitor interface for Thunder framework.
(Defined by PerformanceMonitor.json)
Table of Contents
Introduction
Scope
This document describes purpose and functionality of the PerformanceMonitor interface (version 1.0.0). It includes detailed specification about its methods and properties provided.
Case Sensitivity
All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.
Acronyms, Abbreviations and Terms
The table below provides and overview of acronyms used in this document and their definitions.
| Acronym | Description |
|---|---|
| API | Application Programming Interface |
| HTTP | Hypertext Transfer Protocol |
| JSON | JavaScript Object Notation; a data interchange format |
| JSON-RPC | A remote procedure call protocol encoded in JSON |
The table below provides and overview of terms and abbreviations used in this document and their definitions.
| Term | Description |
|---|---|
| callsign | The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique. |
References
| Ref ID | Description |
|---|---|
| HTTP | HTTP specification |
| JSON-RPC | JSON-RPC 2.0 specification |
| JSON | JSON specification |
| Thunder | Thunder API Reference |
Description
Performance Monitor JSON-RPC interface.
Methods
The following methods are provided by the PerformanceMonitor interface:
PerformanceMonitor interface methods:
| Method | Description |
|---|---|
| clear | Clear all performance data collected |
| send | Interface to test send data |
| receive | Interface to test receive data |
| exchange | Interface to test exchange data |
clear method
Clear all performance data collected.
Parameters
This method takes no parameters.
Result
| Name | Type | M/O | Description |
|---|---|---|---|
| result | null | mandatory | Always null (default: None) |
Example
Request
{
"jsonrpc": "2.0",
"id": 42,
"method": "<callsign>.1.clear"
}
Response
{
"jsonrpc": "2.0",
"id": 42,
"result": null
}
send method
Interface to test send data.
Parameters
| Name | Type | M/O | Description |
|---|---|---|---|
| params | object | mandatory | ... |
| params?.data | string | optional | Any string data upto the size specified in the length |
| params?.length | integer | optional | Size of the data |
| params?.duration | integer | optional | Duration of the measurements |
Result
| Name | Type | M/O | Description |
|---|---|---|---|
| result | integer | mandatory | Size of data received by the jsonrpc interface |
Example
Request
{
"jsonrpc": "2.0",
"id": 42,
"method": "<callsign>.1.send",
"params": {
"data": "abababababab",
"length": 0,
"duration": 0
}
}
Response
{
"jsonrpc": "2.0",
"id": 42,
"result": 0
}
receive method
Interface to test receive data.
Parameters
| Name | Type | M/O | Description |
|---|---|---|---|
| params | integer | mandatory | Size of data to be provided by the jsonrpc interface |
Result
| Name | Type | M/O | Description |
|---|---|---|---|
| result | object | mandatory | ... |
| result?.data | string | optional | Any string data upto the size specified in the length |
| result?.length | integer | optional | Size of the data |
| result?.duration | integer | optional | Duration of the measurements |
Example
Request
{
"jsonrpc": "2.0",
"id": 42,
"method": "<callsign>.1.receive",
"params": 0
}
Response
{
"jsonrpc": "2.0",
"id": 42,
"result": {
"data": "abababababab",
"length": 0,
"duration": 0
}
}
exchange method
Interface to test exchange data.
Parameters
| Name | Type | M/O | Description |
|---|---|---|---|
| params | object | mandatory | ... |
| params?.data | string | optional | Any string data upto the size specified in the length |
| params?.length | integer | optional | Size of the data |
| params?.duration | integer | optional | Duration of the measurements |
Result
| Name | Type | M/O | Description |
|---|---|---|---|
| result | object | mandatory | ... |
| result?.data | string | optional | Any string data upto the size specified in the length |
| result?.length | integer | optional | Size of the data |
| result?.duration | integer | optional | Duration of the measurements |
Example
Request
{
"jsonrpc": "2.0",
"id": 42,
"method": "<callsign>.1.exchange",
"params": {
"data": "abababababab",
"length": 0,
"duration": 0
}
}
Response
{
"jsonrpc": "2.0",
"id": 42,
"result": {
"data": "abababababab",
"length": 0,
"duration": 0
}
}
Properties
The following properties are provided by the PerformanceMonitor interface:
PerformanceMonitor interface properties:
| Property | R/W | Description |
|---|---|---|
| measurement | read-only | Retrieve the performance measurement against given package size |
measurement property
Provides access to the retrieve the performance measurement against given package size. Measurements will be provided in milliseconds.
This property is read-only.
The package size parameter shall be passed as the index to the property, i.e.
measurement@<package-size>.
Index
| Name | Type | M/O | Description |
|---|---|---|---|
| package-size | string | mandatory | Size of package whose statistics info has to be retrieved |
Value
| Name | Type | M/O | Description |
|---|---|---|---|
| (property) | object | mandatory | Retrieve the performance measurement against given package size. Measurements will be provided in milliseconds |
| (property).serialization | object | mandatory | Time taken to complete serialization |
| (property).serialization?.minimum | integer | optional | Minimum value of measurements |
| (property).serialization?.maximum | integer | optional | Maximum value of measurements |
| (property).serialization?.average | integer | optional | Average value of measurements |
| (property).serialization?.count | integer | optional | How many times measurement has been collected |
| (property).deserialization | object | mandatory | Time taken to complete deserialization |
| (property).deserialization?.minimum | integer | optional | Minimum value of measurements |
| (property).deserialization?.maximum | integer | optional | Maximum value of measurements |
| (property).deserialization?.average | integer | optional | Average value of measurements |
| (property).deserialization?.count | integer | optional | How many times measurement has been collected |
| (property).execution | object | mandatory | Time taken to complete execution |
| (property).execution?.minimum | integer | optional | Minimum value of measurements |
| (property).execution?.maximum | integer | optional | Maximum value of measurements |
| (property).execution?.average | integer | optional | Average value of measurements |
| (property).execution?.count | integer | optional | How many times measurement has been collected |
| (property).threadpool | object | mandatory | Time taken to complete threadpool wait |
| (property).threadpool?.minimum | integer | optional | Minimum value of measurements |
| (property).threadpool?.maximum | integer | optional | Maximum value of measurements |
| (property).threadpool?.average | integer | optional | Average value of measurements |
| (property).threadpool?.count | integer | optional | How many times measurement has been collected |
| (property).communication | object | mandatory | Time taken to complete communication |
| (property).communication?.minimum | integer | optional | Minimum value of measurements |
| (property).communication?.maximum | integer | optional | Maximum value of measurements |
| (property).communication?.average | integer | optional | Average value of measurements |
| (property).communication?.count | integer | optional | How many times measurement has been collected |
| (property).total | object | mandatory | Time taken to complete whole jsonrpc process |
| (property).total?.minimum | integer | optional | Minimum value of measurements |
| (property).total?.maximum | integer | optional | Maximum value of measurements |
| (property).total?.average | integer | optional | Average value of measurements |
| (property).total?.count | integer | optional | How many times measurement has been collected |
| Name | Type | M/O | Description |
|---|---|---|---|
| (property) | null | mandatory | Always null (default: None) |
Example
Get Request
{
"jsonrpc": "2.0",
"id": 42,
"method": "<callsign>.1.measurement@1000"
}
Get Response
{
"jsonrpc": "2.0",
"id": 42,
"result": null
}