sitestats-metrics (xml)

Provides SiteStats event aggregator metrics for the current server node
RESTful URLs: http://microformats.org/wiki/rest/urls
HTTP response codes as returned by the system:
200 - OK (request is ok and content returned)
201 - CREATED (request created new content, URL and id of content in the header)
204 - NO CONTENT (request is ok but no content to return)
400 - ERROR (general error in the request, probably invalid parameters or data)
401 - UNAUTHORIZED (user authentication required for this request)
403 - FORBIDDEN (authorization required, insufficient privileges, user is already authenticated)
404 - NOT FOUND (resource not found, URL is invalid in some way, id or action are invalid)
405 - METHOD NOT ALLOWED (the method is not supported for this entity type)
406 - NOT ACCEPTABLE (the data format requested is unavailable for this entity type)
500 - INTERNAL SERVER ERROR (general server failure, probably a failure in the provider)
501 - NOT IMPLEMENTED (indicates that a prefix is invalid)

Custom Actions

get-events-generated-per-sec : list (GET) : [/sitestats-metrics/get-events-generated-per-sec] (html) (xml) (json)
Get the average number of events generated by Sakai per second.
get-all-metrics : list (GET) : [/sitestats-metrics/get-all-metrics] (html) (xml) (json)
Gets all the metrics.
is-idle : list (GET) : [/sitestats-metrics/is-idle] (html) (xml) (json)
Check if event aggregator is idle (empty queue and no event being processed).
get-reset-time : list (GET) : [/sitestats-metrics/get-reset-time] (html) (xml) (json)
Get the time that occurred since start/last reset.
reset-all-metrics : list (GET) : [/sitestats-metrics/reset-all-metrics] (html) (xml) (json)
Resets all metrics.
get-time-ellapsed-since-reset : list (GET) : [/sitestats-metrics/get-time-ellapsed-since-reset] (html) (xml) (json)
Get the total time elapsed, in milliseconds, since start/last reset.
get-average-time-event-processing-per-event : list (GET) : [/sitestats-metrics/get-average-time-event-processing-per-event] (html) (xml) (json)
Get the average time spent, in milliseconds, for event processing per event
get-time-spent-processing-events : list (GET) : [/sitestats-metrics/get-time-spent-processing-events] (html) (xml) (json)
Get the total time, in milliseconds, spent in event processing.
get-total-events-processed : list (GET) : [/sitestats-metrics/get-total-events-processed] (html) (xml) (json)
Get the total number of events processed.
get-events-processed-per-sec : list (GET) : [/sitestats-metrics/get-events-processed-per-sec] (html) (xml) (json)
Get the average number of events processed per second.
get-queue-size : list (GET) : [/sitestats-metrics/get-queue-size] (html) (xml) (json)
Returns the total number of events waiting in the queue to be processed.

Entity class : java.lang.String

Type :: simple

Data and Request Handling

Output formats : html, xml, json
Input formats : html, xml, json
No Access Provider registered for request processing

Capabilities

NameTypeDescription
1EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
2ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
3AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
4Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
5Inputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
6Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
7Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

REST:: 1.0.1 SVN: $Revision$ : $Date$