ApiMetricSchema Data Model

A metric schema represents the schema for a specific metric monitored by the Cloudera Management Services.

Properties
name data type description
name string Name of the metric. This name is guaranteed to be unique among the metrics.
displayName string Display name of the metric.
description string Description of the metric.
isCounter boolean Is the metric a counter. A counter tracks the total count since a process / host started. The rate of change of a counter may often be more interesting than the raw value of a counter.
unitNumerator string Numerator for the unit of the metric.
unitDenominator string Denominator for the unit of the metric.
aliases array of string Aliases for the metric. An alias is unique per metric (per source and version) but is not globally unique. Aliases usually refer to previous names for the metric as metrics are renamed or replaced.
sources map of array of string Sources for the metric. Each source entry contains the name of the source and a list of versions for which this source is valid

Example

{
  "name" : "...",
  "displayName" : "...",
  "description" : "...",
  "isCounter" : true,
  "unitNumerator" : "...",
  "unitDenominator" : "...",
  "aliases" : [ "...", "..." ],
  "sources" : {
    "property1" : [ "...", "..." ],
    "property2" : [ "...", "..." ]
  }
}