diff options
| author | Yang Song <songy23@users.noreply.github.com> | 2018-05-18 09:17:44 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-18 09:17:44 -0700 |
| commit | b647dbda2e7131d7d350f63d28943c93fe94fc47 (patch) | |
| tree | 453d28c71ec0f380a610006563c8f2d9f875a16e /exporters | |
| parent | d61eb4727e9601328c62daf4739dc5221f46909a (diff) | |
| download | platform_external_opencensus-java-b647dbda2e7131d7d350f63d28943c93fe94fc47.tar.gz platform_external_opencensus-java-b647dbda2e7131d7d350f63d28943c93fe94fc47.tar.bz2 platform_external_opencensus-java-b647dbda2e7131d7d350f63d28943c93fe94fc47.zip | |
Prometheus exporter: remove namespace and prefix for help message. (#1203)
* Prometheus exporter: remove namespace and prefix for help message.
* Add this change to CHANGELOG.
Diffstat (limited to 'exporters')
3 files changed, 31 insertions, 84 deletions
diff --git a/exporters/stats/prometheus/src/main/java/io/opencensus/exporter/stats/prometheus/PrometheusExportUtils.java b/exporters/stats/prometheus/src/main/java/io/opencensus/exporter/stats/prometheus/PrometheusExportUtils.java index 6999b75b..fe54c4df 100644 --- a/exporters/stats/prometheus/src/main/java/io/opencensus/exporter/stats/prometheus/PrometheusExportUtils.java +++ b/exporters/stats/prometheus/src/main/java/io/opencensus/exporter/stats/prometheus/PrometheusExportUtils.java @@ -83,8 +83,6 @@ import org.checkerframework.checker.nullness.qual.Nullable; @SuppressWarnings("deprecation") final class PrometheusExportUtils { - @VisibleForTesting static final String OPENCENSUS_NAMESPACE = "opencensus"; - @VisibleForTesting static final String OPENCENSUS_HELP_MSG = "Opencensus Prometheus metrics: "; @VisibleForTesting static final String SAMPLE_SUFFIX_BUCKET = "_bucket"; @VisibleForTesting static final String SAMPLE_SUFFIX_COUNT = "_count"; @VisibleForTesting static final String SAMPLE_SUFFIX_SUM = "_sum"; @@ -93,8 +91,7 @@ final class PrometheusExportUtils { // Converts a ViewData to a Prometheus MetricFamilySamples. static MetricFamilySamples createMetricFamilySamples(ViewData viewData) { View view = viewData.getView(); - String name = - Collector.sanitizeMetricName(OPENCENSUS_NAMESPACE + '_' + view.getName().asString()); + String name = Collector.sanitizeMetricName(view.getName().asString()); Type type = getType(view.getAggregation(), view.getWindow()); List<String> labelNames = convertToLabelNames(view.getColumns()); List<Sample> samples = Lists.newArrayList(); @@ -103,15 +100,13 @@ final class PrometheusExportUtils { samples.addAll( getSamples(name, labelNames, entry.getKey(), entry.getValue(), view.getAggregation())); } - return new MetricFamilySamples( - name, type, OPENCENSUS_HELP_MSG + view.getDescription(), samples); + return new MetricFamilySamples(name, type, view.getDescription(), samples); } // Converts a View to a Prometheus MetricFamilySamples. // Used only for Prometheus metric registry, should not contain any actual samples. static MetricFamilySamples createDescribableMetricFamilySamples(View view) { - String name = - Collector.sanitizeMetricName(OPENCENSUS_NAMESPACE + '_' + view.getName().asString()); + String name = Collector.sanitizeMetricName(view.getName().asString()); Type type = getType(view.getAggregation(), view.getWindow()); List<String> labelNames = convertToLabelNames(view.getColumns()); if (containsDisallowedLeLabelForHistogram(labelNames, type)) { @@ -121,7 +116,7 @@ final class PrometheusExportUtils { + "Please remove this tag key from your view."); } return new MetricFamilySamples( - name, type, OPENCENSUS_HELP_MSG + view.getDescription(), Collections.<Sample>emptyList()); + name, type, view.getDescription(), Collections.<Sample>emptyList()); } @VisibleForTesting diff --git a/exporters/stats/prometheus/src/test/java/io/opencensus/exporter/stats/prometheus/PrometheusExportUtilsTest.java b/exporters/stats/prometheus/src/test/java/io/opencensus/exporter/stats/prometheus/PrometheusExportUtilsTest.java index 1d112a31..d8ab2d8d 100644 --- a/exporters/stats/prometheus/src/test/java/io/opencensus/exporter/stats/prometheus/PrometheusExportUtilsTest.java +++ b/exporters/stats/prometheus/src/test/java/io/opencensus/exporter/stats/prometheus/PrometheusExportUtilsTest.java @@ -18,8 +18,6 @@ package io.opencensus.exporter.stats.prometheus; import static com.google.common.truth.Truth.assertThat; import static io.opencensus.exporter.stats.prometheus.PrometheusExportUtils.LABEL_NAME_BUCKET_BOUND; -import static io.opencensus.exporter.stats.prometheus.PrometheusExportUtils.OPENCENSUS_HELP_MSG; -import static io.opencensus.exporter.stats.prometheus.PrometheusExportUtils.OPENCENSUS_NAMESPACE; import static io.opencensus.exporter.stats.prometheus.PrometheusExportUtils.SAMPLE_SUFFIX_BUCKET; import static io.opencensus.exporter.stats.prometheus.PrometheusExportUtils.SAMPLE_SUFFIX_COUNT; import static io.opencensus.exporter.stats.prometheus.PrometheusExportUtils.SAMPLE_SUFFIX_SUM; @@ -120,12 +118,10 @@ public class PrometheusExportUtilsTest { private static final CumulativeData CUMULATIVE_DATA = CumulativeData.create(Timestamp.fromMillis(1000), Timestamp.fromMillis(2000)); private static final IntervalData INTERVAL_DATA = IntervalData.create(Timestamp.fromMillis(1000)); - private static final String SAMPLE_NAME = OPENCENSUS_NAMESPACE + "_view"; + private static final String SAMPLE_NAME = "view"; @Test public void testConstants() { - assertThat(OPENCENSUS_NAMESPACE).isEqualTo("opencensus"); - assertThat(OPENCENSUS_HELP_MSG).isEqualTo("Opencensus Prometheus metrics: "); assertThat(SAMPLE_SUFFIX_BUCKET).isEqualTo("_bucket"); assertThat(SAMPLE_SUFFIX_COUNT).isEqualTo("_count"); assertThat(SAMPLE_SUFFIX_SUM).isEqualTo("_sum"); @@ -147,31 +143,19 @@ public class PrometheusExportUtilsTest { assertThat(PrometheusExportUtils.createDescribableMetricFamilySamples(VIEW1)) .isEqualTo( new MetricFamilySamples( - OPENCENSUS_NAMESPACE + "_view1", - Type.COUNTER, - OPENCENSUS_HELP_MSG + DESCRIPTION, - Collections.<Sample>emptyList())); + "view1", Type.COUNTER, DESCRIPTION, Collections.<Sample>emptyList())); assertThat(PrometheusExportUtils.createDescribableMetricFamilySamples(VIEW2)) .isEqualTo( new MetricFamilySamples( - OPENCENSUS_NAMESPACE + "_view2", - Type.SUMMARY, - OPENCENSUS_HELP_MSG + DESCRIPTION, - Collections.<Sample>emptyList())); + "view2", Type.SUMMARY, DESCRIPTION, Collections.<Sample>emptyList())); assertThat(PrometheusExportUtils.createDescribableMetricFamilySamples(VIEW3)) .isEqualTo( new MetricFamilySamples( - OPENCENSUS_NAMESPACE + "_view_3", - Type.HISTOGRAM, - OPENCENSUS_HELP_MSG + DESCRIPTION, - Collections.<Sample>emptyList())); + "view_3", Type.HISTOGRAM, DESCRIPTION, Collections.<Sample>emptyList())); assertThat(PrometheusExportUtils.createDescribableMetricFamilySamples(VIEW4)) .isEqualTo( new MetricFamilySamples( - OPENCENSUS_NAMESPACE + "__view4", - Type.UNTYPED, - OPENCENSUS_HELP_MSG + DESCRIPTION, - Collections.<Sample>emptyList())); + "_view4", Type.UNTYPED, DESCRIPTION, Collections.<Sample>emptyList())); } @Test @@ -283,89 +267,60 @@ public class PrometheusExportUtilsTest { VIEW1, ImmutableMap.of(Arrays.asList(V1, V2), COUNT_DATA), CUMULATIVE_DATA))) .isEqualTo( new MetricFamilySamples( - OPENCENSUS_NAMESPACE + "_view1", + "view1", Type.COUNTER, - OPENCENSUS_HELP_MSG + DESCRIPTION, + DESCRIPTION, Arrays.asList( new Sample( - OPENCENSUS_NAMESPACE + "_view1", - Arrays.asList("k1", "k2"), - Arrays.asList("v1", "v2"), - 12345)))); + "view1", Arrays.asList("k1", "k2"), Arrays.asList("v1", "v2"), 12345)))); assertThat( PrometheusExportUtils.createMetricFamilySamples( ViewData.create( VIEW2, ImmutableMap.of(Arrays.asList(V1), MEAN_DATA), CUMULATIVE_DATA))) .isEqualTo( new MetricFamilySamples( - OPENCENSUS_NAMESPACE + "_view2", + "view2", Type.SUMMARY, - OPENCENSUS_HELP_MSG + DESCRIPTION, + DESCRIPTION, Arrays.asList( - new Sample( - OPENCENSUS_NAMESPACE + "_view2_count", - Arrays.asList("k_3"), - Arrays.asList("v1"), - 22), - new Sample( - OPENCENSUS_NAMESPACE + "_view2_sum", - Arrays.asList("k_3"), - Arrays.asList("v1"), - 74.8)))); + new Sample("view2_count", Arrays.asList("k_3"), Arrays.asList("v1"), 22), + new Sample("view2_sum", Arrays.asList("k_3"), Arrays.asList("v1"), 74.8)))); assertThat( PrometheusExportUtils.createMetricFamilySamples( ViewData.create( VIEW3, ImmutableMap.of(Arrays.asList(V3), DISTRIBUTION_DATA), CUMULATIVE_DATA))) .isEqualTo( new MetricFamilySamples( - OPENCENSUS_NAMESPACE + "_view_3", + "view_3", Type.HISTOGRAM, - OPENCENSUS_HELP_MSG + DESCRIPTION, + DESCRIPTION, Arrays.asList( new Sample( - OPENCENSUS_NAMESPACE + "_view_3_bucket", + "view_3_bucket", Arrays.asList("k1", "le"), Arrays.asList("v-3", "-5.0"), 0), new Sample( - OPENCENSUS_NAMESPACE + "_view_3_bucket", - Arrays.asList("k1", "le"), - Arrays.asList("v-3", "0.0"), - 2), + "view_3_bucket", Arrays.asList("k1", "le"), Arrays.asList("v-3", "0.0"), 2), new Sample( - OPENCENSUS_NAMESPACE + "_view_3_bucket", - Arrays.asList("k1", "le"), - Arrays.asList("v-3", "5.0"), - 2), + "view_3_bucket", Arrays.asList("k1", "le"), Arrays.asList("v-3", "5.0"), 2), new Sample( - OPENCENSUS_NAMESPACE + "_view_3_bucket", + "view_3_bucket", Arrays.asList("k1", "le"), Arrays.asList("v-3", "+Inf"), 1), - new Sample( - OPENCENSUS_NAMESPACE + "_view_3_count", - Arrays.asList("k1"), - Arrays.asList("v-3"), - 5), - new Sample( - OPENCENSUS_NAMESPACE + "_view_3_sum", - Arrays.asList("k1"), - Arrays.asList("v-3"), - 22.0)))); + new Sample("view_3_count", Arrays.asList("k1"), Arrays.asList("v-3"), 5), + new Sample("view_3_sum", Arrays.asList("k1"), Arrays.asList("v-3"), 22.0)))); assertThat( PrometheusExportUtils.createMetricFamilySamples( ViewData.create( VIEW4, ImmutableMap.of(Arrays.asList(V1), COUNT_DATA), INTERVAL_DATA))) .isEqualTo( new MetricFamilySamples( - OPENCENSUS_NAMESPACE + "__view4", + "_view4", Type.UNTYPED, - OPENCENSUS_HELP_MSG + DESCRIPTION, + DESCRIPTION, Arrays.asList( - new Sample( - OPENCENSUS_NAMESPACE + "__view4", - Arrays.asList("k1"), - Arrays.asList("v1"), - 12345)))); + new Sample("_view4", Arrays.asList("k1"), Arrays.asList("v1"), 12345)))); } } diff --git a/exporters/stats/prometheus/src/test/java/io/opencensus/exporter/stats/prometheus/PrometheusStatsCollectorTest.java b/exporters/stats/prometheus/src/test/java/io/opencensus/exporter/stats/prometheus/PrometheusStatsCollectorTest.java index 3f97ac3c..7010ff03 100644 --- a/exporters/stats/prometheus/src/test/java/io/opencensus/exporter/stats/prometheus/PrometheusStatsCollectorTest.java +++ b/exporters/stats/prometheus/src/test/java/io/opencensus/exporter/stats/prometheus/PrometheusStatsCollectorTest.java @@ -100,13 +100,13 @@ public class PrometheusStatsCollectorTest { @Test public void testCollect() { PrometheusStatsCollector collector = new PrometheusStatsCollector(mockViewManager); - String name = "opencensus_view1"; + String name = "view1"; assertThat(collector.collect()) .containsExactly( new MetricFamilySamples( - "opencensus_view1", + "view1", Type.HISTOGRAM, - "Opencensus Prometheus metrics: View description", + "View description", Arrays.asList( new Sample( name + "_bucket", @@ -151,10 +151,7 @@ public class PrometheusStatsCollectorTest { assertThat(collector.describe()) .containsExactly( new MetricFamilySamples( - "opencensus_view1", - Type.HISTOGRAM, - "Opencensus Prometheus metrics: View description", - Collections.<Sample>emptyList())); + "view1", Type.HISTOGRAM, "View description", Collections.<Sample>emptyList())); } @Test |
