Metric
Represents a single server metric series. Each metric is identified by its name and tag set, and exposes one or more numeric measurements. Metrics are available at GET /app/rest/server/metrics and are compatible with the Prometheus data model.
Related Help article: Metrics
Properties
name
The dot-separated metric identifier.
description
A human-readable description of what this metric measures. May be empty if the metric does not define a description.
prometheusName
The Prometheus-compatible metric name: dots replaced with underscores, with an optional unit suffix such as _bytes or _milliseconds.
metricValues
The numeric measurements for this metric. Simple metrics contain a single entry named value; compound metrics (timers, histograms) contain multiple named entries such as count and total.
metricTags
Key-value labels that identify this metric series. Always includes nodeId for multi-node setups; may include additional dimensional tags such as area or id.
Schema
Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.
A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.