-
Notifications
You must be signed in to change notification settings - Fork 11
Collector REST API
pierre edited this page Mar 12, 2012
·
2 revisions
Query the datastore (both in-memory and persisted) for hosts and/or sample kinds.
-
On success: Return a JSON array of all hosts, e.g.:
["hostA.company.com","hostB.company.com"] -
On error: Return
Error 503 Service Unavailableif the database is not available. The exception is in theWarningheader. - Query parameters: pretty: true or false (default), enables JSON pretty-printing
-
On success: Return a JSON array of all sample types, e.g.:
["min_heapUsed","max_heapUsed"] -
On error: Return
Error 503 Service Unavailableif the database is not available. The exception is in theWarningheader. - Query parameters: pretty: true or false (default), enables JSON pretty-printing
-
On success: Return a JSON array of all samples for this host, e.g.:
[ "{\"sampleKind\":\"min_heapUsed\",\"samples\":\"1330665650,1.0657515698888E13\"}", "{\"sampleKind\":\"max_heapUsed\",\"samples\":\"1330665650,2.0768835511784E13\"}" ]Thesamplesvalue is a timeline representation of the samples, i.e."t1,v1,t2,v2,t3,v3"wheretiare the Unix timestamps andvithe associated values. -
On error: Return
Error 503 Service Unavailableif the database is not available. The exception is in theWarningheader. - Query parameters: pretty: true or false (default), enables JSON pretty-printing, from: timestamp (default epoch), start time for the samples, to: timestamp (default now), end time for the samples. Note that the from and to are not guaranteed (i.e. the endpoint does its best to honor them but the caller needs to narrow further on some occasion).
-
On success: Return a JSON array of all samples for this host and sample type, e.g.:
[ "{\"sampleKind\":\"min_heapUsed\",\"samples\":\"1330665650,1.0657515698888E13\"}", "{\"sampleKind\":\"min_heapUsed\",\"samples\":\"1330665650,2.0768835511784E13\"}" ]Thesamplesvalue is a timeline representation of the samples, i.e."t1,v1,t2,v2,t3,v3"wheretiare the Unix timestamps andvithe associated values. -
On error: Return
Error 503 Service Unavailableif the database is not available. The exception is in theWarningheader. - Query parameters: pretty: true or false (default), enables JSON pretty-printing, from: timestamp (default epoch), start time for the samples, to: timestamp (default now), end time for the samples. Note that the from and to are not guaranteed (i.e. the endpoint does its best to honor them but they caller needs to narrow further on some occasion).