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

default response
default response
object
A single diagram/graph

Examples

No request body required
get /stats/pool-names

Get available Ceph pools for statistics.

Parameters

pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.

Responses

default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.

Examples

No request body required
get /stats/server-names

Get available server names for statistics.

Responses

default response
default response
array
Array of ServerNameAndId objects - Server id/hostname pairs for querying the stats APIs.

Examples

No request body required
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

default response
default response
array
Array of S3UserName objects

Examples

No request body required
get /stats/monitored-rbds

Get the Rbd images that are monitored for statistics.

Responses

default response
default response
array
Array of MonitoredRbd objects

Examples

No request body required
put /stats/monitored-rbds

Set the Rbd images that are monitored for statistics.

Replaces the currently configured set of Rbd images.

Parameters

body array
Rbd images to monitor continuously. (Array of MonitoredRbd objects)

Examples

Request Body

[
  {
    "rbdName": "string",
    "poolName": "string",
    "namespace": "string"
  }
]
post /stats/monitored-rbds

Add images to the set of monitored Rbds.

Parameters

body array
Additional Rbd images to monitor continuously. (Array of MonitoredRbd objects)

Examples

Request Body

[
  {
    "rbdName": "string",
    "poolName": "string",
    "namespace": "string"
  }
]
delete /stats/monitored-rbds

Remove images from the set of monitored Rbds.

Parameters

body array
Rbd images to stop monitoring. (Array of MonitoredRbd objects)

Examples

Request Body

[
  {
    "rbdName": "string",
    "poolName": "string",
    "namespace": "string"
  }
]
get /stats/s3-bucket-names

Get available S3 buckets for statistics.

Responses

default response
default response
array
Array of S3BucketName objects

Examples

No request body required
get /stats/cephfs-monitored-dirs

Get CephFS directories that are monitored for statistics.

Responses

default response
default response
array
Array of CephFsMonitoredDir objects

Examples

No request body required
put /stats/cephfs-monitored-dirs

Set the CephFS directories that are monitored for statistics.

Replaces the currently configured set of directories.

Parameters

body array
CephFS directories to monitor continuously. (Array of string items)

Examples

Request Body

[
  "string"
]