GeoServer monitoring requests

Request provides details about OWS and REST requests that GeoServer has handled
More information: https://geoserver.org/comm/
Contact Info: geoserver-users@osgeo.org
Version: 1.0.0
BasePath:/geoserver/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Monitoring

Monitoring

Up 
delete /monitor/requests/{request}
(deleteMonitorRequest)
Invalid. Cannot delete a specific request

Responses

405

Method Not Allowed
Up 
delete /monitor/requests
(deleteMonitorRequests)
Clears all reqests

Responses

200

OK
Up 
get /monitor/requests/{request}
Get a list of requests (getMonitorRequest)
Returns a specific request, by identifier The HTML format returns all details of the request. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/request/1.xls" for Excel).

Path parameters

request (required)
Path Parameter — The request identifier

Query parameters

fields (optional)
Query Parameter — Comma separated list of fields to be returned

Return type

Request

Example data

Content-Type: application/csv
"Bbox,BodyAsString,BodyContentLength,BodyContentType,Category,EndTime,ErrorMessage,Host,HttpMethod,HttpReferer,Id,InternalHost,Operation,OwsVersion,Path,QueryString,RemoteAddr,RemoteCity,RemoteCountry,RemoteHost,RemoteLat,RemoteLon,RemoteUser,RemoteUserAgent,Resources,ResourcesList,ResponseContentType,ResponseLength,ResponseStatus,Service,StartTime,Status,SubOperation,TotalTime\n\"ReferencedEnvelope[-180.0 : 180.0, -90.0 : 90.0]\",,0,,OWS,2017-04-01T11:26:06.439,,localhost,GET,http://localhost:8080/geoserver/web/wicket/bookmarkable/org.geoserver.web.demo.MapPreviewPage?7,2,hydra,GetMap,1.3.0,/tiger/wms,\"service=WMS&version=1.1.0&request=GetMap&layers=tiger:giant_polygon&styles=&bbox=-180.0,-90.0,180.0,90.0&width=768&height=384&srs=EPSG:4326&format=application/openlayers\",127.0.0.1,,,localhost,0.0,0.0,admin,\"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/57.0.2987.110 Safari/537.36\",[tiger:giant_polygon],tiger:giant_polygon,\"text/html; subtype=openlayers\",21997,200,WMS,2017-04-01T11:26:06.011,FINISHED,,428\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Request

Example data

Content-Type: application/csv
Bbox,BodyAsString,BodyContentLength,BodyContentType,Category,EndTime,ErrorMessage,Host,HttpMethod,HttpReferer,Id,InternalHost,Operation,OwsVersion,Path,QueryString,RemoteAddr,RemoteCity,RemoteCountry,RemoteHost,RemoteLat,RemoteLon,RemoteUser,RemoteUserAgent,Resources,ResourcesList,ResponseContentType,ResponseLength,ResponseStatus,Service,StartTime,Status,SubOperation,TotalTime
"ReferencedEnvelope[-180.0 : 180.0, -90.0 : 90.0]",,0,,OWS,2017-04-01T11:26:06.439,,localhost,GET,http://localhost:8080/geoserver/web/wicket/bookmarkable/org.geoserver.web.demo.MapPreviewPage?7,2,hydra,GetMap,1.3.0,/tiger/wms,"service=WMS&version=1.1.0&request=GetMap&layers=tiger:giant_polygon&styles=&bbox=-180.0,-90.0,180.0,90.0&width=768&height=384&srs=EPSG:4326&format=application/openlayers",127.0.0.1,,,localhost,0.0,0.0,admin,"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/57.0.2987.110 Safari/537.36",[tiger:giant_polygon],tiger:giant_polygon,"text/html; subtype=openlayers",21997,200,WMS,2017-04-01T11:26:06.011,FINISHED,,428
Up 
get /monitor/requests
Get a list of requests (getMonitorRequests)
Returns a list of all requests known to the monitoring system. If no list of fields is specified, the full list will be returned, with the exception of Class, Body and Error fields. The HTML format return a summary of the requests, and links to the single request to gather details. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/requests.xls" for Excel).

Query parameters

from (optional)
Query Parameter — Specifies an inclusive lower bound on the timestamp for the start of a request. The timestamp must be expressed as an ISO can be specified to any desired precision (e..g, "2010-07-23", "2010-07-23T16:16:44")
to (optional)
Query Parameter — Specifies an inclusive lower bound on the timestamp for the start of a request. The timestamp must be expressed as an ISO can be specified to any desired precision (e..g, "2010-07-23", "2010-07-23T16:16:44")
filter (optional)
Query Parameter —

Specifies generic filter against the available fields, in the form "attributeName:OP:value" where OP can be:

  • EQ: equals
  • NEQ: not equals
  • LT: less than
  • LTE: less than or equals
  • GT: greater than
  • GTE: greater than or equals
  • IN: in list ("value" must be a comma separated list of values
order (optional)
Query Parameter — Specifies which request attribute to sort by, and optionally specifies the sort direction. The syntax is "attribute[;ASC|DESC]", where the sorting direction is optional
offset (optional)
Query Parameter — Specifies where in the result set records should be returned from
count (optional)
Query Parameter — Specifies how many records should be returned.
live (optional)
Query Parameter — Specifies which requests to return based on status. If true, only returns live (RUNNING, WAITING, CANCELLING) requests. If false, only returns completed (FINISHED, FAILED) requests. If not specified, all requests are returned regardless of status.
fields (optional)
Query Parameter — Comma separated list of fields to be returned

Return type

RequestList

Example data

Content-Type: application/csv
"id,path,startTime\n2,/tiger/wms,2017-04-01T11:26:06.011\n3,/tiger/wms,2017-04-01T11:26:06.603\n4,/tiger/wms,2017-04-01T11:26:07.369\n5,/rest/monitor/requests.csv,2017-04-01T11:26:37.919\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RequestList

Example data

Content-Type: application/csv
id,path,startTime
2,/tiger/wms,2017-04-01T11:26:06.011
3,/tiger/wms,2017-04-01T11:26:06.603
4,/tiger/wms,2017-04-01T11:26:07.369
5,/rest/monitor/requests.csv,2017-04-01T11:26:37.919
Up 
post /monitor/requests/{request}
(postMonitorRequest)
This resource cannot be modified

Responses

405

Method Not Allowed
Up 
post /monitor/requests
(postMonitorRequests)
Invalid. This resource cannot be modified.

Responses

405

Method Not Allowed
Up 
put /monitor/requests/{request}
(putMonitorRequest)
This resource cannot be modified

Responses

405

Method Not Allowed
Up 
put /monitor/requests
(putMonitorRequests)
Invalid. This resource cannot be modified.

Responses

405

Method Not Allowed

Models

[ Jump to Methods ]

Table of Contents

  1. Request - request
  2. RequestList - requests

Request - request Up

Bbox (optional)
String Requested bounding box
BodyAsString (optional)
String Body of the request (for POST/PUT)
BodyContentLength (optional)
Integer Request body content lenght
BodyContentType (optional)
String Request body content type
Category (optional)
String Can be OWS or REST
EndTime (optional)
String Request completion time
ErrorMessage (optional)
String The error message, in case the request failed, empt otherwise
Host (optional)
String Host GeoServer is running on
HttpMethod (optional)
String HTTP method of the request (e.g., GET, POST, ...)
HttpReferer (optional)
String HTTP referrer, if any
Id (optional)
String Request identifier
InternalHost (optional)
String Name of the host GeoServer is running on
Operation (optional)
String OGC operation, e.g. GetMap, GetFeature (available only for OWS requests)
OwsVersion (optional)
String OGC protocol version (e.g., 1.1.0, 1.1.3)
Path (optional)
String HTTP request path (e.g. "/topp/wms")
QueryString (optional)
String The HTTP request query string
RemoteAddr (optional)
String Remote request IP address
RemoteCity (optional)
String Remote client city (available only if GeoIP lookup is enabled)
RemoteCountry (optional)
String Remote client country (available only if GeoIP lookup is enabled)
RemoteHost (optional)
String Remote client host
RemoteLat (optional)
String Remote client latitude (available only if GeoIP lookup is enabled)
RemoteLon (optional)
String Remote client longitude (available only if GeoIP lookup is enabled)
RemoteUser (optional)
String User issuing the request
RemoteUserAgent (optional)
String Remote client user agent
Resources (optional)
String Name of the resources (layers, processes, ...) specified as part of the request
ResourcesList (optional)
String Name of the resources (layers, processes, ...) specified as part of the request
ResponseContentType (optional)
String Content type of the response
ResponseLength (optional)
Integer Size of the response in bytes
ResponseStatus (optional)
String HTTP status of the response
Service (optional)
String OGC service in use (available only for OGC requests)
StartTime (optional)
String Request start time
Status (optional)
String Status of the request (WAITING, RUNNING, CANCELLING, FAILED, FINISHED, CANCELLED, INTERRUPTED)
SubOperation (optional)
String The OGC sub operations, for the cases in which it applies (e.g., for WFS-T it can be Insert/Delete/Update)
TotalTime (optional)
Integer Total request time in milliseconds

RequestList - requests Up