Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Warning

This API is deprecated, and has been replaced with Statistics REST API in OpenAPI format, exposed on the Internal Ceptor Gateway.


Once statistics REST services are enabled and properly configured they can be accessed as shown below


http://server:port/restservices/statistics/list/status/?servers=XX,YYservers/

Optional parameter servers – a comma separated list of servers to get status for. If no list is given, status is returned for all servers.

DescriptionReturns config server status texts and connection status

List servers which has available statistics (could be historical!)

Example URLS

http://localhost:5300/restservices/statistics/list/status?servers=configserver1,useradmin1servers/

Formatted example

[
{"name": "configserver1"},
{"name": "dispatcher1configserver2"},
{"aliasname": "dispatcher1"},
{"htlmStatusname": null"gateway1"},
{"statename": "UNKNOWNlogserver1"},
{"pingTimename": -1
"proxy1"},
{"name": "radiusserver1"},
{
"name": "useradmin1restservices"},
{"aliasname": "useradmin1sessionctrl1"},
{"htlmStatusname": null"statisticsserver1"},
{"statename": "UNKNOWNuseradmin1"},
{"pingTimename": -1
"useradminapp"}
]



http://server:port/restservices/statistics/list/status/?servers/=XX,YY

Optional parameter servers – a comma separated list of servers to get status for. If no list is given, status is returned for all servers.

DescriptionList servers which has available statistics (could be historical!)

Returns config server status texts and connection status

Example URLS

http://localhost:5300/restservices/statistics/list/servers/status?servers=configserver1,useradmin1

Formatted example

[
{"name": "configserver1"},
{"name": "configserver2dispatcher1"},
{"namealias": "dispatcher1"},
{"namehtlmStatus": "gateway1"}null,
{"namestate": "logserver1UNKNOWN"},
{"namepingTime": "proxy1"-1
},
{
"name": "radiusserver1useradmin1"},
{"namealias": "restservicesuseradmin1"},
{"namehtlmStatus": "sessionctrl1"}null,
{"namestate": "statisticsserver1UNKNOWN"},
{"namepingTime": "useradmin1"},
{"name": "useradminapp"-1
}
]



http://server:port/restservices/statistics/list/functions?servers=XX,YY

Optional parameter servers – a comma separated list of servers to get functions for. If no list is given, status is returned for all servers.

Description

Returns functions with available statistics for the given servers

Example URLS

http://localhost:5300/restservices/statistics/list/functions/

http://localhost:5300/restservices/statistics/list/functions?servers=dispatcher1

Formatted example

[{
"server": "dispatcher1",
"functions": [
{"name": "Agent.logon"},
{"name": "Agent.newSession"},
{"name": "Application _ server _ 127.0.0.1:8080 _ down"},
{"name": "Application _ server _ down"},
{"name": "Get _ user _ info _ from _ Session _ Controller"},
{"name": "LoadbalancedPeer.dispatcher1.changeActive"},
{"name": "LoadbalancedPeer.dispatcher1.peers"},

. . . .

. . . .


{"name": "ThreadPool _ concurrent_active_threads"},
{"name": "free _ memory _ (kb)"},
{"name": "statistics _ send _ queue _ length"},
{"name": "total _ memory _ (kb)"},
{"name": "used _ memory _(kb)"}
]
}](kb)"}
]
}]



http://server:port/restservices/statistics/list/summary?servers=XX,YY

Required parameter servers – a comma separated list of servers to get statistical summary for. If no list is given, an error is thrown.

Optional parameters, start and end - can be provided in either milliseconds since midnight, January 1, 1970 UTC or formatted or direct date/time formatted as "yyyy-MM-dd HH:mm:ss" (24 hour clock). If either parameter is present the other is required. Default timespan is from now and one hour back (start=now-1hour, end=now)

Note: using start/end time will result in statistics being returned in the standard summed up intervals for the given period. For more information see Ceptor Statistics Server

Description

Returns a statistical summary for the given servers

note: server parameter is mandatory!

Using the detailed statistics required knowledge about the content of the values, what they represent. Each measurement is individual!

Example URLS

http://localhost:5300/restservices/statistics/list/summary?servers=useradmin1

http://localhost:5300/restservices/statistics/list/summary?servers=useradmin1&start=1500807215268&end=1500808433903

http://localhost:5300/restservices/statistics/list/summary?servers=useradmin1&start=2017-01-01 12:00:00&end=2017-08-01 12:00:00

Formatted example

[
{
"server": "useradmin1",
"function": "ThreadPool concurrent active threads",
"statData": [ {
"startTime": 1500653485852,
"endTime": 1500653982774,
"total": 374,
"mean": 1.8333333333333333,
"count": 204,
"min": 1,
"max": 3,
"lower95Value": 1.927865859309491,
"upper95Value": 1.927865859309491
}]
},

. . . .

. . . .
{
"server": "useradmin1",
"function": "free memory (kb)",
"statData": [ {
"startTime": 1500653546432,
"endTime": 1500654822701,
"total": 5010732,
"mean": 313170.75,
"count": 16,
"min": 172423,
"max": 396615,
"lower95Value": 340214.2471190447,
"upper95Value": 340214.2471190447
}]
}
]



http://server:port/restservices/statistics/statisticscollecteddetails/?servers=XX,YY&functions=MM,NN

Required parameter servers – a comma separated list of servers to get statistical details for. If no list is given, an error is thrown.

Required parameter functions – a comma separated list of functions to get statistical details for. If no list is given, an error is thrown.

Optional parameters, start and end - can be provided in either milliseconds since midnight, January 1, 1970 UTC or formatted or direct date/time formatted as "yyyy-MM-dd HH:mm:ss" (24 hour clock). If either parameter is present the other is required. Default timespan is from now and one hour back (start=now-1hour, end=now)

Note: using start/end time will result in statistics being returned in the standard summed up intervals for the given period. For more information see Ceptor Statistics Server

Description

Returns a statistical detail data for the given servers and functions

note: servers and functions parameters is mandatory!

Using the detailed statistics required knowledge about the content of the values, what they represent. Each measurement is individual!

Example URLS

http://localhost:5300/restservices/statistics/statisticscollecteddetails/?servers=configserver1&functions=total memory (kb)

http://localhost:5300/restservices/statistics/statisticscollecteddetails/?servers=configserver1&functions=total memory (kb)&start=1500807215268&end=1500808433903

http://localhost:5300/restservices/statistics/statisticscollecteddetails/?servers=configserver1&functions=total memory (kb)&start=2017-01-01 12:00:00&end=2017-08-01 12:00:00

Formatted example

{
"time": 1500656409483,
"server": null,
"counters": {},
"simpleTimers": {},
"timers": {"configserver1.total memory (kb)": [
{
"sqrValue": 2.170814464E11,
"minValue": 465920,
"maxValue": 465920,
"min95Value": 3.4028235E38,
"max95Value": 1.4E-45,
"totalValue": 465920,
"count": 1,
"startTime": 1500653540231,
"endTime": 1500653540231,
"callsPerMin": 0,
"millisecPerCall": 0,
"meanValue": 465920,
"lower98": "NaN",
"lower99": "NaN",
"stdError": "NaN",
"medianValue": 465920,
"upper98": "NaN",
"upper95": "NaN",
"upper90": "NaN",
"upper99": "NaN",
"deviation": "NaN",
"lower95": "NaN",
"variance": "NaN",
"lower90": "NaN"
},

. . . .

. . . .


{
"sqrValue": 2.07177908224E11,
"minValue": 455168,
"maxValue": 455168,
"min95Value": 3.4028235E38,
"max95Value": 1.4E-45,
"totalValue": 455168,
"count": 1,
"startTime": 1500656256252,
"endTime": 1500656256252,
"callsPerMin": 0,
"millisecPerCall": 0,
"meanValue": 455168,
"lower98": "NaN",
"lower99": "NaN",
"stdError": "NaN",
"medianValue": 455168,
"upper98": "NaN",
"upper95": "NaN",
"upper90": "NaN",
"upper99": "NaN",
"deviation": "NaN",
"lower95": "NaN",
"variance": "NaN",
"lower90": "NaN"
}
]}
}