stats

Get statistics of the cluster and servers.
get /stats

Get a graph by name.

See resources/statistics/graphite-queries.yml for available graphs. Some queries like server-specific stats expect template parameter which are passed with template-{name} query parameters. Example: /stats?graph=server-disk-load&startTime=-600&maxDataPoints=50&template-server-id=1 startTime and endTime should be in the same format, i.e., either both > 0 or both <= 0

Parameters
graph string query
The graph to query.
startTime integer query
Start time of the graph. Either an absolute UNIX timestamp in seconds or a negative value in seconds for x seconds ago.
endTime integer query
End time of the graph, default = 0. Either an absolute UNIX timestamp in seconds or a negative value in seconds for x seconds ago.
maxDataPoints integer query
Maximum number of data points to return to thin out graphs over long time ranges. Default = 500
Responses
200 successful operation
GraphResponse object
A single diagram/graph
{
  "name": "string",
  "axis1": {
    "unit": "IOPS",
    "graphs": [
      {
        "name": "string",
        "tags": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "datapoints": [
          {
            "t": 0,
            "v": 0
          }
        ]
      }
    ]
  },
  "axis2": {
    "unit": "IOPS",
    "graphs": [
      {
        "name": "string",
        "tags": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "datapoints": [
          {
            "t": 0,
            "v": 0
          }
        ]
      }
    ]
  },
  "description": "string"
}
get /stats/pool-names

Get available Ceph pools for statistics.

Parameters
pagination string query
Responses
200 successful operation
PoolStatsInfo array
PoolStatsInfo object 
[
  {
    "queryName": "string",
    "quotaBytes": 0,
    "description": "string",
    "displayName": "string",
    "quotaObjects": 0
  }
]
get /stats/server-names

Get available server names for statistics.

Responses
200 successful operation
ServerNameAndId array
ServerNameAndId object
Server id/hostname pairs for querying the stats APIs.
[
  {
    "id": 0,
    "hostname": "string"
  }
]
get /stats/s3-user-names

Get available S3 users for statistics.

This API is somewhat expensive if there are a lot of S3 users, don't call this too often.

Responses
200 successful operation
S3UserName array
S3UserName object 
[
  {
    "queryName": "string",
    "displayName": "string"
  }
]
get /stats/monitored-rbds

Get the Rbd images that are monitored for statistics.

Responses
200 successful operation
MonitoredRbd array
MonitoredRbd object 
[
  {
    "rbdName": "string",
    "poolName": "string",
    "namespace": "string"
  }
]
put /stats/monitored-rbds

Set the Rbd images that are monitored for statistics.

Replaces the currently configured set of Rbd images.

Parameters
body array
MonitoredRbd object 
[
  {
    "rbdName": "string",
    "poolName": "string",
    "namespace": "string"
  }
]
Responses
default successful operation
post /stats/monitored-rbds

Add images to the set of monitored Rbds.

Parameters
body array
MonitoredRbd object 
[
  {
    "rbdName": "string",
    "poolName": "string",
    "namespace": "string"
  }
]
Responses
default successful operation
delete /stats/monitored-rbds

Remove images from the set of monitored Rbds.

Parameters
body array
MonitoredRbd object 
[
  {
    "rbdName": "string",
    "poolName": "string",
    "namespace": "string"
  }
]
Responses
default successful operation
get /stats/s3-bucket-names

Get available S3 buckets for statistics.

Responses
200 successful operation
S3BucketName array
S3BucketName object 
[
  {
    "queryName": "string",
    "quotaBytes": 0,
    "displayName": "string",
    "quotaObjects": 0
  }
]
get /stats/cephfs-monitored-dirs

Get CephFS directories that are monitored for statistics.

Responses
200 successful operation
CephFsMonitoredDir array
CephFsMonitoredDir object 
[
  {
    "queryName": "string",
    "quotaBytes": 0,
    "quotaFiles": 0,
    "displayName": "string"
  }
]
put /stats/cephfs-monitored-dirs

Set the CephFS directories that are monitored for statistics.

Replaces the currently configured set of directories.

Parameters
body array
string 
[
  "string"
]
Responses
default successful operation