Page Comparison

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,YY

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

Returns config server status texts and connection status

List servers which has available statistics (could be historical!)
Example URLS	http://localhost:5300/restservices/

status

statistics/list/

configserver/

servers/
Formatted example	[ {"name": "configserver1"}, {"name": "configserver2"}, {"name": "dispatcher1"}, {"name": "gateway1"}, {"name": "logserver1"}, {"name": "proxy1"}, {"name": "radiusserver1"}, {"name": "restservices"}, {"name": "sessionctrl1"}, {"name": "statisticsserver1"}, {"name": "useradmin1"}, {"name": "useradminapp"} ]

http://

localhost

server:

5300

port/restservices/statistics/list/status

/configserver

/?servers=

configserver1,useradmin1

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.
Description	Returns config server status texts and connection status
Example URLS	http://localhost:5300/restservices/statistics/list/status

/

?servers=configserver1,useradmin1
Formatted example	[

2]
0:

{
"name":

"

configserver1

dispatcher1",
"alias":

"dispatcher1",
"htlmStatus":

"Actions <!-- action="peer" title="Peers connections" resource="peer.connections" permission="read"...........”

null,
"state":

"

NOT_CONNECTED

UNKNOWN",
"pingTime":

0

-1
}

1:

,
{
"name":

"useradmin1",
"alias":

"useradmin1",
"htlmStatus":

"Time: Thu May 05 17:27:44 CEST 2016 Number of session listeners: 0 SessionCtrl server connection status: NIO TCP Peer useradmin1@localhost:...........”

null,
"state":

"

RUNNING

UNKNOWN",
"pingTime":

0

-1
}
]

http://server:port/restservices/statistics/list/

servers/

functions?servers=XX,YY
Optional parameter servers – a comma separated list of servers to get

status Example URLS

functions for. If no list is given, status is returned for all servers.
Description

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

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	[

19]
0:
{

{
"server": "dispatcher1",
"functions": [
{"name": "Agent.logon"},
{"name": "

configserver1

Agent.newSession"

},
{"name": "Application server 127.0.0.1:8080 down"},
{"name": "Application server down"},
{"name": "

dispatcher1"
}
2:
{

Get user info from Session Controller"},
{"name": "LoadbalancedPeer.dispatcher1.changeActive"},
{"name": "

logserver"
}
3:
{

LoadbalancedPeer.dispatcher1.peers"},

. . . .

{"name": "

logserver1"
}
4:
{

ThreadPool concurrent_active_threads"},
{"name": "free memory (kb)"},
{"name": "

logserver1/"
}
5:
{
.. .. .. ..
}
}

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

http://server:port/restservices/statistics/list/

functions

summary?servers=XX,YY

Optional

Required parameter servers – a comma separated list of servers to get

functions

statistical summary for. If no list is given,

status is returned for all servers.

Description

Returns functions with available statistics for the given servers

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/

functions/

summary?servers=useradmin1

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

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

functions

summary?servers=

dispatcher1

useradmin1&start=2017-01-01 12:00:00&end=2017-08-01 12:00:00
Formatted example	[

2]
0:

{
"server": "useradmin1",
"function": "ThreadPool concurrent active threads",
"statData": [ {
"

server

startTime": 1500653485852,
"

dispatcher1

endTime": 1500653982774,
"

function

total":

"Agent.newSession"
"statData":
[1]
0:

374,
"mean": 1.8333333333333333,
"count": 204,
"min": 1,
"max": 3,
"lower95Value": 1.927865859309491,
"upper95Value": 1.927865859309491
}]
},

. . . .

. . . .
{
"server": "useradmin1",
"function": "free memory (kb)",
"statData": [ {
"startTime":

1462460536414

1500653546432,
"endTime":

1462460536414

1500654822701,
"total":

1005

5010732,
"mean":

1005

313170.75,
"count":

1

16,
"min":

1005

172423,
"max":

1005

396615,
"lower95Value": 340214.2471190447,
"

NaN"
"upper95Value": "NaN"
}
}
1:
{
"server": "dispatcher1"
"function": "Garbage Collect"
"statData":
[1]
0:
{
"startTime": 1462460821933
"endTime": 1462463521918
"total": 1321
"mean": 132.1
"count": 10
"min": 101
"max": 175
"lower95Value": 147.97062185997203
"upper95Value": 147.97062185997203

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" } ]} }

Versions Compared

Old Version 1

New Version Current

Key