Package io.prometheus.client
Class SummaryMetricFamily
java.lang.Object
io.prometheus.client.Collector.MetricFamilySamples
io.prometheus.client.SummaryMetricFamily
Summary metric family, for custom collectors and exporters.
Most users want a normal Summary
instead.
Example usage:
class YourCustomCollector extends Collector {
List<MetricFamilySamples> collect() {
List<MetricFamilySamples> mfs = new ArrayList<MetricFamilySamples>();
// With no labels.
mfs.add(new SummaryMetricFamily("my_summary", "help", 1, 42));
// With labels. Record 95th percentile as 3, and 99th percentile as 5.
SummaryMetricFamily labeledSummary = new SummaryMetricFamily("my_other_summary", "help",
Arrays.asList("labelname"), Arrays.asList(.95, .99));
labeledSummary.addMetric(Arrays.asList("foo"), 2, 10, Arrays.asList(3.0, 5.0));
mfs.add(labeledSummary);
return mfs;
}
}
-
Nested Class Summary
Nested classes/interfaces inherited from class io.prometheus.client.Collector.MetricFamilySamples
Collector.MetricFamilySamples.Sample
-
Field Summary
FieldsModifier and TypeFieldDescriptionFields inherited from class io.prometheus.client.Collector.MetricFamilySamples
help, name, samples, type
-
Constructor Summary
ConstructorsConstructorDescriptionSummaryMetricFamily
(String name, String help, double count, double sum) SummaryMetricFamily
(String name, String help, List<String> labelNames) -
Method Summary
Modifier and TypeMethodDescriptionMethods inherited from class io.prometheus.client.Collector.MetricFamilySamples
equals, hashCode, toString
-
Field Details
-
labelNames
-
quantiles
-
-
Constructor Details
-
SummaryMetricFamily
-
SummaryMetricFamily
-
SummaryMetricFamily
-
-
Method Details
-
addMetric
-
addMetric
public SummaryMetricFamily addMetric(List<String> labelValues, double count, double sum, List<Double> quantiles)
-