GeoServer System Status

Request provides details about OWS and REST requests that GeoServer has handled
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
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

SystemStatus

SystemStatus

Up
get /about/system-status
Get a list of requests (getMonitorRequests)
Returns a list of system-level information. Major operating systems (Linux, Windows and MacOX) are supported out of the box.

Return type

Metrics

Example data

Content-Type: application/json
"{\n  \"metrics\": {\n      \"metric\": [\n          {\n        \"available\": true,\n        \"category\": \"FILE_SYSTEM\",\n        \"description\": \"Partition [/dev/nvme0n1p2] total space\",\n        \"identifier\": \"/dev/nvme0n1p2\",\n        \"name\": \"PARTITION_TOTAL\",\n        \"priority\": 507,\n        \"unit\": \"bytes\",\n        \"value\": 99614720\n    },\n          (...)\n"

Example data

Content-Type: application/xml
"\n  \n    99614720\n    true\n    Partition [/dev/nvme0n1p2] total space\n    PARTITION_TOTAL\n    bytes\n    FILE_SYSTEM\n    /dev/nvme0n1p2\n    507\n  \n  (...)\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 Metrics

Example data

Content-Type: application/json
{
  "metrics": {
      "metric": [
          {
        "available": true,
        "category": "FILE_SYSTEM",
        "description": "Partition [/dev/nvme0n1p2] total space",
        "identifier": "/dev/nvme0n1p2",
        "name": "PARTITION_TOTAL",
        "priority": 507,
        "unit": "bytes",
        "value": 99614720
    },
          (...)

Example data

Content-Type: application/xml

  
    99614720
    true
    Partition [/dev/nvme0n1p2] total space
    PARTITION_TOTAL
    bytes
    FILE_SYSTEM
    /dev/nvme0n1p2
    507
  
  (...)

Models

[ Jump to Methods ]

Table of Contents

  1. Metrics - metrics
  2. metric -
  3. metricValue -

Metrics - metrics Up

Metrics for system status properties
metric (optional)

metric - Up

Metrics for system status properties
metrics (optional)
array[metricValue] Metrics for system status properties

metricValue - Up

value (optional)
String System information value
category (optional)
String Category of this system information
name (optional)
String Name of the metric
available (optional)
Boolean TRUE if the system information value is available
description (optional)
String Description of this system information
unit (optional)
String Unit of the system information, can be empty
priority (optional)
Integer This value can be used to render the metrics in a predefined order
identifier (optional)
String Identifies the resource associated with the metric, e.g. file partition name