-
Notifications
You must be signed in to change notification settings - Fork 804
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for Dropwizard Instrumentation with 1.0.0 (#912)
* Rename project simpleclient-archive/simpleclient_dropwizard to prometheus-metrics-instrumentation-dropwizard Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk> * Implement DropwizardExports Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk> * Label Changes Attempt 1 Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk> * Label Changes Attempt2 Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk> * Support for Custom Labels Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk> * Minor Refactor Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk> * Add builder for dwexports and change package name to dw5 Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk> * Rename package to dw5 Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk> * Rename to dropwizard5 Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk> --------- Signed-off-by: Kinshuk Bairagi <hi@kinsh.uk>
- Loading branch information
Showing
17 changed files
with
735 additions
and
855 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
221 changes: 221 additions & 0 deletions
221
...d5/src/main/java/io/prometheus/metrics/instrumentation/dropwizard5/DropwizardExports.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| package io.prometheus.metrics.instrumentation.dropwizard5; | ||
|
|
||
| import io.dropwizard.metrics5.Timer; | ||
| import io.dropwizard.metrics5.*; | ||
| import io.prometheus.metrics.instrumentation.dropwizard5.labels.CustomLabelMapper; | ||
| import io.prometheus.metrics.model.registry.MultiCollector; | ||
| import io.prometheus.metrics.model.registry.PrometheusRegistry; | ||
| import io.prometheus.metrics.model.snapshots.*; | ||
|
|
||
| import java.util.*; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** | ||
| * Collect Dropwizard metrics from a MetricRegistry. | ||
| */ | ||
| public class DropwizardExports implements MultiCollector { | ||
| private static final Logger LOGGER = Logger.getLogger(DropwizardExports.class.getName()); | ||
| private final MetricRegistry registry; | ||
| private final MetricFilter metricFilter; | ||
| private final Optional<CustomLabelMapper> labelMapper; | ||
|
|
||
| /** | ||
| * Creates a new DropwizardExports and {@link MetricFilter#ALL}. | ||
| * | ||
| * @param registry a metric registry to export in prometheus. | ||
| */ | ||
| DropwizardExports(MetricRegistry registry) { | ||
| super(); | ||
| this.registry = registry; | ||
| this.metricFilter = MetricFilter.ALL; | ||
| this.labelMapper = Optional.empty(); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new DropwizardExports with a custom {@link MetricFilter}. | ||
| * | ||
| * @param registry a metric registry to export in prometheus. | ||
| * @param metricFilter a custom metric filter. | ||
| */ | ||
| public DropwizardExports(MetricRegistry registry, MetricFilter metricFilter) { | ||
| this.registry = registry; | ||
| this.metricFilter = metricFilter; | ||
| this.labelMapper = Optional.empty(); | ||
| } | ||
|
|
||
| /** | ||
| * @param registry a metric registry to export in prometheus. | ||
| * @param metricFilter a custom metric filter. | ||
| * @param labelMapper a labelMapper to use to map labels. | ||
| */ | ||
| public DropwizardExports(MetricRegistry registry, MetricFilter metricFilter, CustomLabelMapper labelMapper) { | ||
| this.registry = registry; | ||
| this.metricFilter = metricFilter; | ||
| this.labelMapper = Optional.ofNullable(labelMapper); | ||
| } | ||
|
|
||
| private static String getHelpMessage(String metricName, Metric metric) { | ||
| return String.format("Generated from Dropwizard metric import (metric=%s, type=%s)", | ||
| metricName, metric.getClass().getName()); | ||
| } | ||
|
|
||
|
|
||
| private static MetricMetadata getMetricMetaData(String metricName, Metric metric) { | ||
| return new MetricMetadata(PrometheusNaming.sanitizeMetricName(metricName), getHelpMessage(metricName, metric)); | ||
| } | ||
|
|
||
| /** | ||
| * Export counter as Prometheus <a href="https://prometheus.io/docs/concepts/metric_types/#gauge">Gauge</a>. | ||
| */ | ||
| MetricSnapshot fromCounter(String dropwizardName, Counter counter) { | ||
| MetricMetadata metadata = getMetricMetaData(dropwizardName, counter); | ||
| CounterSnapshot.CounterDataPointSnapshot.Builder dataPointBuilder = CounterSnapshot.CounterDataPointSnapshot.builder().value(Long.valueOf(counter.getCount()).doubleValue()); | ||
| labelMapper.map(mapper -> dataPointBuilder.labels(mapper.getLabels(dropwizardName, Collections.emptyList(), Collections.emptyList()))); | ||
| return new CounterSnapshot(metadata, Collections.singletonList(dataPointBuilder.build())); | ||
| } | ||
|
|
||
| /** | ||
| * Export gauge as a prometheus gauge. | ||
| */ | ||
| MetricSnapshot fromGauge(String dropwizardName, Gauge gauge) { | ||
| Object obj = gauge.getValue(); | ||
| double value; | ||
| if (obj instanceof Number) { | ||
| value = ((Number) obj).doubleValue(); | ||
| } else if (obj instanceof Boolean) { | ||
| value = ((Boolean) obj) ? 1 : 0; | ||
| } else { | ||
| LOGGER.log(Level.FINE, String.format("Invalid type for Gauge %s: %s", PrometheusNaming.sanitizeMetricName(dropwizardName), | ||
| obj == null ? "null" : obj.getClass().getName())); | ||
| return null; | ||
| } | ||
| MetricMetadata metadata = getMetricMetaData(dropwizardName, gauge); | ||
| GaugeSnapshot.GaugeDataPointSnapshot.Builder dataPointBuilder = GaugeSnapshot.GaugeDataPointSnapshot.builder().value(value); | ||
| labelMapper.map(mapper -> dataPointBuilder.labels(mapper.getLabels(dropwizardName, Collections.emptyList(), Collections.emptyList()))); | ||
| return new GaugeSnapshot(metadata, Collections.singletonList(dataPointBuilder.build())); | ||
| } | ||
|
|
||
| /** | ||
| * Export a histogram snapshot as a prometheus SUMMARY. | ||
| * | ||
| * @param dropwizardName metric name. | ||
| * @param snapshot the histogram snapshot. | ||
| * @param count the total sample count for this snapshot. | ||
| * @param factor a factor to apply to histogram values. | ||
| */ | ||
| MetricSnapshot fromSnapshotAndCount(String dropwizardName, Snapshot snapshot, long count, double factor, String helpMessage) { | ||
| Quantiles quantiles = Quantiles.builder() | ||
| .quantile(0.5, snapshot.getMedian() * factor) | ||
| .quantile(0.75, snapshot.get75thPercentile() * factor) | ||
| .quantile(0.95, snapshot.get95thPercentile() * factor) | ||
| .quantile(0.98, snapshot.get98thPercentile() * factor) | ||
| .quantile(0.99, snapshot.get99thPercentile() * factor) | ||
| .quantile(0.999, snapshot.get999thPercentile() * factor) | ||
| .build(); | ||
|
|
||
| MetricMetadata metadata = new MetricMetadata(PrometheusNaming.sanitizeMetricName(dropwizardName), helpMessage); | ||
| SummarySnapshot.SummaryDataPointSnapshot.Builder dataPointBuilder = SummarySnapshot.SummaryDataPointSnapshot.builder().quantiles(quantiles).count(count); | ||
| labelMapper.map(mapper -> dataPointBuilder.labels(mapper.getLabels(dropwizardName, Collections.emptyList(), Collections.emptyList()))); | ||
| return new SummarySnapshot(metadata, Collections.singletonList(dataPointBuilder.build())); | ||
| } | ||
|
|
||
| /** | ||
| * Convert histogram snapshot. | ||
| */ | ||
| MetricSnapshot fromHistogram(String dropwizardName, Histogram histogram) { | ||
| return fromSnapshotAndCount(dropwizardName, histogram.getSnapshot(), histogram.getCount(), 1.0, | ||
| getHelpMessage(dropwizardName, histogram)); | ||
| } | ||
|
|
||
| /** | ||
| * Export Dropwizard Timer as a histogram. Use TIME_UNIT as time unit. | ||
| */ | ||
| MetricSnapshot fromTimer(String dropwizardName, Timer timer) { | ||
| return fromSnapshotAndCount(dropwizardName, timer.getSnapshot(), timer.getCount(), | ||
| 1.0D / TimeUnit.SECONDS.toNanos(1L), getHelpMessage(dropwizardName, timer)); | ||
| } | ||
|
|
||
| /** | ||
| * Export a Meter as a prometheus COUNTER. | ||
| */ | ||
| MetricSnapshot fromMeter(String dropwizardName, Meter meter) { | ||
| MetricMetadata metadata = getMetricMetaData(dropwizardName + "_total", meter); | ||
| CounterSnapshot.CounterDataPointSnapshot.Builder dataPointBuilder = CounterSnapshot.CounterDataPointSnapshot.builder().value(meter.getCount()); | ||
| labelMapper.map(mapper -> dataPointBuilder.labels(mapper.getLabels(dropwizardName, Collections.emptyList(), Collections.emptyList()))); | ||
| return new CounterSnapshot(metadata, Collections.singletonList(dataPointBuilder.build())); | ||
| } | ||
|
|
||
| @Override | ||
| public MetricSnapshots collect() { | ||
| MetricSnapshots.Builder metricSnapshots = MetricSnapshots.builder(); | ||
| for (SortedMap.Entry<MetricName, Gauge> entry : registry.getGauges(metricFilter).entrySet()) { | ||
| Optional.ofNullable(fromGauge(entry.getKey().getKey(), entry.getValue())).map(metricSnapshots::metricSnapshot); | ||
| } | ||
| for (SortedMap.Entry<MetricName, Counter> entry : registry.getCounters(metricFilter).entrySet()) { | ||
| metricSnapshots.metricSnapshot(fromCounter(entry.getKey().getKey(), entry.getValue())); | ||
| } | ||
| for (SortedMap.Entry<MetricName, Histogram> entry : registry.getHistograms(metricFilter).entrySet()) { | ||
| metricSnapshots.metricSnapshot(fromHistogram(entry.getKey().getKey(), entry.getValue())); | ||
| } | ||
| for (SortedMap.Entry<MetricName, Timer> entry : registry.getTimers(metricFilter).entrySet()) { | ||
| metricSnapshots.metricSnapshot(fromTimer(entry.getKey().getKey(), entry.getValue())); | ||
| } | ||
| for (SortedMap.Entry<MetricName, Meter> entry : registry.getMeters(metricFilter).entrySet()) { | ||
| metricSnapshots.metricSnapshot(fromMeter(entry.getKey().getKey(), entry.getValue())); | ||
| } | ||
| return metricSnapshots.build(); | ||
| } | ||
|
|
||
| public static Builder builder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| //Builder class for DropwizardExports | ||
| public static class Builder { | ||
| private MetricRegistry registry; | ||
| private MetricFilter metricFilter; | ||
| private CustomLabelMapper labelMapper; | ||
|
|
||
| private Builder() { | ||
| this.metricFilter = MetricFilter.ALL; | ||
| } | ||
|
|
||
| public Builder dropwizardRegistry(MetricRegistry registry) { | ||
| this.registry = registry; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder metricFilter(MetricFilter metricFilter) { | ||
| this.metricFilter = metricFilter; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder customLabelMapper(CustomLabelMapper labelMapper) { | ||
| this.labelMapper = labelMapper; | ||
| return this; | ||
| } | ||
|
|
||
| DropwizardExports build() { | ||
| if (registry == null) { | ||
| throw new IllegalArgumentException("MetricRegistry must be set"); | ||
| } | ||
| if (labelMapper == null) { | ||
| return new DropwizardExports(registry, metricFilter); | ||
| } else { | ||
| return new DropwizardExports(registry, metricFilter, labelMapper); | ||
| } | ||
| } | ||
|
|
||
| public void register() { | ||
| register(PrometheusRegistry.defaultRegistry); | ||
| } | ||
|
|
||
| public void register(PrometheusRegistry registry) { | ||
| DropwizardExports dropwizardExports = build(); | ||
| registry.register(dropwizardExports); | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...rd/samplebuilder/GraphiteNamePattern.java → ...opwizard5/labels/GraphiteNamePattern.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ropwizard/samplebuilder/MapperConfig.java → ...tion/dropwizard5/labels/MapperConfig.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.