naming

Signed-off-by: Gregor Zeitlinger <[email protected]>

Author: zeitlinger

prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterProperties.java

@@ -7,18 +7,20 @@ public class ExporterProperties {
 
   private static final String INCLUDE_CREATED_TIMESTAMPS = "includeCreatedTimestamps";
   // milliseconds is the default - we only provide a boolean flag to avoid a breaking change
-  private static final String TIMESTAMPS_IN_MS = "timestampsInMs";
+  private static final String PROMETHEUS_TIMESTAMPS_IN_MS = "prometheusTimestampsInMs";
   private static final String EXEMPLARS_ON_ALL_METRIC_TYPES = "exemplarsOnAllMetricTypes";
   private static final String PREFIX = "io.prometheus.exporter";
 
   private final Boolean includeCreatedTimestamps;
-  private final Boolean timestampsInMs;
+  private final Boolean prometheusTimestampsInMs;
   private final Boolean exemplarsOnAllMetricTypes;
 
   private ExporterProperties(
-      Boolean includeCreatedTimestamps, Boolean timestampsInMs, Boolean exemplarsOnAllMetricTypes) {
+      Boolean includeCreatedTimestamps,
+      Boolean prometheusTimestampsInMs,
+      Boolean exemplarsOnAllMetricTypes) {
     this.includeCreatedTimestamps = includeCreatedTimestamps;
-    this.timestampsInMs = timestampsInMs;
+    this.prometheusTimestampsInMs = prometheusTimestampsInMs;
     this.exemplarsOnAllMetricTypes = exemplarsOnAllMetricTypes;
   }
 
@@ -27,9 +29,9 @@ public boolean getIncludeCreatedTimestamps() {
     return includeCreatedTimestamps != null && includeCreatedTimestamps;
   }
 
-  /** Use milliseconds for timestamps in text format? Default is {@code false}. */
-  public boolean getTimestampsInMs() {
-    return timestampsInMs != null && timestampsInMs;
+  /** Use milliseconds for timestamps in prometheus text format? Default is {@code false}. */
+  public boolean getPrometheusTimestampsInMs() {
+    return prometheusTimestampsInMs != null && prometheusTimestampsInMs;
   }
 
   /**
@@ -48,10 +50,9 @@ static ExporterProperties load(Map<Object, Object> properties)
       throws PrometheusPropertiesException {
     Boolean includeCreatedTimestamps =
         Util.loadBoolean(PREFIX + "." + INCLUDE_CREATED_TIMESTAMPS, properties);
-    Boolean timestampsInMs = Util.loadBoolean(PREFIX + "." + TIMESTAMPS_IN_MS, properties);
+    Boolean timestampsInMs = Util.loadBoolean(PREFIX + "." + PROMETHEUS_TIMESTAMPS_IN_MS, properties);
     Boolean exemplarsOnAllMetricTypes =
         Util.loadBoolean(PREFIX + "." + EXEMPLARS_ON_ALL_METRIC_TYPES, properties);
-    // new prop?
     return new ExporterProperties(
         includeCreatedTimestamps, timestampsInMs, exemplarsOnAllMetricTypes);
   }
@@ -64,7 +65,7 @@ public static class Builder {
 
     private Boolean includeCreatedTimestamps;
     private Boolean exemplarsOnAllMetricTypes;
-    boolean timestampsInMs;
+    boolean prometheusTimestampsInMs;
 
     private Builder() {}
 
@@ -80,15 +81,15 @@ public Builder exemplarsOnAllMetricTypes(boolean exemplarsOnAllMetricTypes) {
       return this;
     }
 
-    /** See {@link #getTimestampsInMs()}. */
-    public Builder setTimestampsInMs(boolean timestampsInMs) {
-      this.timestampsInMs = timestampsInMs;
+    /** See {@link #getPrometheusTimestampsInMs()}. */
+    public Builder prometheusTimestampsInMs(boolean prometheusTimestampsInMs) {
+      this.prometheusTimestampsInMs = prometheusTimestampsInMs;
       return this;
     }
 
     public ExporterProperties build() {
       return new ExporterProperties(
-          includeCreatedTimestamps, timestampsInMs, exemplarsOnAllMetricTypes);
+          includeCreatedTimestamps, prometheusTimestampsInMs, exemplarsOnAllMetricTypes);
     }
   }
 }

prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/ExporterPropertiesTest.java

@@ -48,6 +48,7 @@ void builder() {
         ExporterProperties.builder()
             .includeCreatedTimestamps(true)
             .exemplarsOnAllMetricTypes(true)
+          .prometheusTimestampsInMs(false)
             .build();
     assertThat(properties.getIncludeCreatedTimestamps()).isTrue();
     assertThat(properties.getExemplarsOnAllMetricTypes()).isTrue();

prometheus-metrics-exporter-pushgateway/src/main/java/io/prometheus/metrics/exporter/pushgateway/PushGateway.java

@@ -80,7 +80,7 @@ public class PushGateway {
 
   private final URL url;
   private final ExpositionFormatWriter writer;
-  private final boolean timestampsInMs;
+  private final boolean prometheusTimestampsInMs;
   private final Map<String, String> requestHeaders;
   private final PrometheusRegistry registry;
   private final HttpConnectionFactory connectionFactory;
@@ -91,12 +91,12 @@ private PushGateway(
       URL url,
       HttpConnectionFactory connectionFactory,
       Map<String, String> requestHeaders,
-      boolean timestampsInMs) {
+      boolean prometheusTimestampsInMs) {
     this.registry = registry;
     this.url = url;
     this.requestHeaders = Collections.unmodifiableMap(new HashMap<>(requestHeaders));
     this.connectionFactory = connectionFactory;
-    this.timestampsInMs = timestampsInMs;
+    this.prometheusTimestampsInMs = prometheusTimestampsInMs;
     writer = getWriter(format);
     if (!writer.isAvailable()) {
       throw new RuntimeException(writer.getClass() + " is not available");
@@ -106,7 +106,9 @@ private PushGateway(
   @SuppressWarnings("deprecation")
   private ExpositionFormatWriter getWriter(Format format) {
     if (format == Format.PROMETHEUS_TEXT) {
-      return PrometheusTextFormatWriter.builder().setTimestampsInMs(this.timestampsInMs).build();
+      return PrometheusTextFormatWriter.builder()
+          .setTimestampsInMs(this.prometheusTimestampsInMs)
+          .build();
     } else {
       // use reflection to avoid a compile-time dependency on the expositionformats module
       return new PrometheusProtobufWriter();
@@ -268,7 +270,7 @@ public static class Builder {
     private String address;
     private Scheme scheme;
     private String job;
-    private boolean timestampsInMs;
+    private boolean prometheusTimestampsInMs;
     private final Map<String, String> requestHeaders = new HashMap<>();
     private PrometheusRegistry registry = PrometheusRegistry.defaultRegistry;
     private HttpConnectionFactory connectionFactory = new DefaultHttpConnectionFactory();
@@ -389,14 +391,15 @@ public Builder registry(PrometheusRegistry registry) {
      * Use milliseconds for timestamps in text format? Default is {@code false}. Can be overwritten
      * at runtime with the {@code io.prometheus.exporter.timestampsInMs} property.
      */
-    public Builder setTimestampsInMs(boolean timestampsInMs) {
-      this.timestampsInMs = timestampsInMs;
+    public Builder prometheusTimestampsInMs(boolean prometheusTimestampsInMs) {
+      this.prometheusTimestampsInMs = prometheusTimestampsInMs;
       return this;
     }
 
-    private boolean getTimestampsInMs() {
+    private boolean getPrometheusTimestampsInMs() {
       // accept either to opt in to timestamps in milliseconds
-      return config.getExporterProperties().getTimestampsInMs() || this.timestampsInMs;
+      return config.getExporterProperties().getPrometheusTimestampsInMs()
+          || this.prometheusTimestampsInMs;
     }
 
     private Scheme getScheme(ExporterPushgatewayProperties properties) {
@@ -477,7 +480,7 @@ public PushGateway build() {
             makeUrl(properties),
             connectionFactory,
             requestHeaders,
-            getTimestampsInMs());
+            getPrometheusTimestampsInMs());
       } catch (MalformedURLException e) {
         throw new PrometheusPropertiesException(
             address + ": Invalid address. Expecting <host>:<port>");

prometheus-metrics-exporter-pushgateway/src/test/java/io/prometheus/metrics/exporter/pushgateway/BasicAuthPushGatewayTest.java

@@ -29,6 +29,7 @@ public void setUp() {
             .address("localhost:" + mockServerClient.getPort())
             .basicAuth("testUser", "testPwd")
             .registry(registry)
+            .prometheusTimestampsInMs(true)
             .job("j")
             .build();
   }

prometheus-metrics-exposition-textformats/src/main/java/io/prometheus/metrics/expositionformats/ExpositionFormats.java

@@ -28,12 +28,11 @@ public static ExpositionFormats init(ExporterProperties properties) {
         new PrometheusProtobufWriter(),
         PrometheusTextFormatWriter.builder()
             .setIncludeCreatedTimestamps(properties.getIncludeCreatedTimestamps())
-            .setTimestampsInMs(properties.getTimestampsInMs())
+            .setTimestampsInMs(properties.getPrometheusTimestampsInMs())
             .build(),
         OpenMetricsTextFormatWriter.builder()
             .setCreatedTimestampsEnabled(properties.getIncludeCreatedTimestamps())
             .setExemplarsOnAllMetricTypesEnabled(properties.getExemplarsOnAllMetricTypes())
-            .setTimestampsInMs(properties.getTimestampsInMs())
             .build());
   }
 

prometheus-metrics-exposition-textformats/src/main/java/io/prometheus/metrics/expositionformats/OpenMetricsTextFormatWriter.java

@@ -4,7 +4,7 @@
 import static io.prometheus.metrics.expositionformats.TextFormatUtil.writeEscapedLabelValue;
 import static io.prometheus.metrics.expositionformats.TextFormatUtil.writeLabels;
 import static io.prometheus.metrics.expositionformats.TextFormatUtil.writeLong;
-import static io.prometheus.metrics.expositionformats.TextFormatUtil.writeTimestamp;
+import static io.prometheus.metrics.expositionformats.TextFormatUtil.writeOpenMetricsTimestamp;
 
 import io.prometheus.metrics.model.snapshots.ClassicHistogramBuckets;
 import io.prometheus.metrics.model.snapshots.CounterSnapshot;
@@ -39,7 +39,6 @@ public class OpenMetricsTextFormatWriter implements ExpositionFormatWriter {
 
   public static class Builder {
     boolean createdTimestampsEnabled;
-    boolean timestampsInMs = true;
     boolean exemplarsOnAllMetricTypesEnabled;
 
     private Builder() {}
@@ -61,22 +60,15 @@ public Builder setExemplarsOnAllMetricTypesEnabled(boolean exemplarsOnAllMetricT
       return this;
     }
 
-    @Deprecated
-    public Builder setTimestampsInMs(boolean timestampsInMs) {
-      this.timestampsInMs = timestampsInMs;
-      return this;
-    }
-
     public OpenMetricsTextFormatWriter build() {
       return new OpenMetricsTextFormatWriter(
-          createdTimestampsEnabled, timestampsInMs, exemplarsOnAllMetricTypesEnabled);
+          createdTimestampsEnabled, exemplarsOnAllMetricTypesEnabled);
     }
   }
 
   public static final String CONTENT_TYPE =
       "application/openmetrics-text; version=1.0.0; charset=utf-8";
   private final boolean createdTimestampsEnabled;
-  private final boolean timestampsInMs;
   private final boolean exemplarsOnAllMetricTypesEnabled;
 
   /**
@@ -85,18 +77,9 @@ public OpenMetricsTextFormatWriter build() {
    * @deprecated this constructor is deprecated and will be removed in the next major version -
    *     {@link #builder()} or {@link #create()} instead
    */
-  @Deprecated
   public OpenMetricsTextFormatWriter(
       boolean createdTimestampsEnabled, boolean exemplarsOnAllMetricTypesEnabled) {
-    this(createdTimestampsEnabled, false, exemplarsOnAllMetricTypesEnabled);
-  }
-
-  private OpenMetricsTextFormatWriter(
-      boolean createdTimestampsEnabled,
-      boolean timestampsInMs,
-      boolean exemplarsOnAllMetricTypesEnabled) {
     this.createdTimestampsEnabled = createdTimestampsEnabled;
-    this.timestampsInMs = timestampsInMs;
     this.exemplarsOnAllMetricTypesEnabled = exemplarsOnAllMetricTypesEnabled;
   }
 
@@ -355,10 +338,10 @@ private void writeCreated(Writer writer, MetricMetadata metadata, DataPointSnaps
       throws IOException {
     if (createdTimestampsEnabled && data.hasCreatedTimestamp()) {
       writeNameAndLabels(writer, metadata.getPrometheusName(), "_created", data.getLabels());
-      writeTimestamp(writer, data.getCreatedTimestampMillis(), timestampsInMs);
+      writeOpenMetricsTimestamp(writer, data.getCreatedTimestampMillis());
       if (data.hasScrapeTimestamp()) {
         writer.write(' ');
-        writeTimestamp(writer, data.getScrapeTimestampMillis(), timestampsInMs);
+        writeOpenMetricsTimestamp(writer, data.getScrapeTimestampMillis());
       }
       writer.write('\n');
     }
@@ -391,7 +374,7 @@ private void writeScrapeTimestampAndExemplar(
       Writer writer, DataPointSnapshot data, Exemplar exemplar) throws IOException {
     if (data.hasScrapeTimestamp()) {
       writer.write(' ');
-      writeTimestamp(writer, data.getScrapeTimestampMillis(), timestampsInMs);
+      writeOpenMetricsTimestamp(writer, data.getScrapeTimestampMillis());
     }
     if (exemplar != null) {
       writer.write(" # ");
@@ -400,7 +383,7 @@ private void writeScrapeTimestampAndExemplar(
       writeDouble(writer, exemplar.getValue());
       if (exemplar.hasTimestamp()) {
         writer.write(' ');
-        writeTimestamp(writer, exemplar.getTimestampMillis(), timestampsInMs);
+        writeOpenMetricsTimestamp(writer, exemplar.getTimestampMillis());
       }
     }
     writer.write('\n');

prometheus-metrics-exposition-textformats/src/main/java/io/prometheus/metrics/expositionformats/PrometheusTextFormatWriter.java

@@ -4,7 +4,7 @@
 import static io.prometheus.metrics.expositionformats.TextFormatUtil.writeEscapedLabelValue;
 import static io.prometheus.metrics.expositionformats.TextFormatUtil.writeLabels;
 import static io.prometheus.metrics.expositionformats.TextFormatUtil.writeLong;
-import static io.prometheus.metrics.expositionformats.TextFormatUtil.writeTimestamp;
+import static io.prometheus.metrics.expositionformats.TextFormatUtil.writePrometheusTimestamp;
 
 import io.prometheus.metrics.model.snapshots.ClassicHistogramBuckets;
 import io.prometheus.metrics.model.snapshots.CounterSnapshot;
@@ -108,7 +108,7 @@ public void write(OutputStream out, MetricSnapshots metricSnapshots) throws IOEx
     // "summary".
     Writer writer = new BufferedWriter(new OutputStreamWriter(out, StandardCharsets.UTF_8));
     for (MetricSnapshot snapshot : metricSnapshots) {
-      if (snapshot.getDataPoints().size() > 0) {
+      if (!snapshot.getDataPoints().isEmpty()) {
         if (snapshot instanceof CounterSnapshot) {
           writeCounter(writer, (CounterSnapshot) snapshot);
         } else if (snapshot instanceof GaugeSnapshot) {
@@ -128,7 +128,7 @@ public void write(OutputStream out, MetricSnapshots metricSnapshots) throws IOEx
     }
     if (writeCreatedTimestamps) {
       for (MetricSnapshot snapshot : metricSnapshots) {
-        if (snapshot.getDataPoints().size() > 0) {
+        if (!snapshot.getDataPoints().isEmpty()) {
           if (snapshot instanceof CounterSnapshot) {
             writeCreated(writer, snapshot);
           } else if (snapshot instanceof HistogramSnapshot) {
@@ -152,14 +152,14 @@ public void writeCreated(Writer writer, MetricSnapshot snapshot) throws IOExcept
           metadataWritten = true;
         }
         writeNameAndLabels(writer, metadata.getPrometheusName(), "_created", data.getLabels());
-        writeTimestamp(writer, data.getCreatedTimestampMillis(), timestampsInMs);
+        writePrometheusTimestamp(writer, data.getCreatedTimestampMillis(), timestampsInMs);
         writeScrapeTimestampAndNewline(writer, data);
       }
     }
   }
 
   private void writeCounter(Writer writer, CounterSnapshot snapshot) throws IOException {
-    if (snapshot.getDataPoints().size() > 0) {
+    if (!snapshot.getDataPoints().isEmpty()) {
       MetricMetadata metadata = snapshot.getMetadata();
       writeMetadata(writer, "_total", "counter", metadata);
       for (CounterSnapshot.CounterDataPointSnapshot data : snapshot.getDataPoints()) {
@@ -409,7 +409,7 @@ private void writeScrapeTimestampAndNewline(Writer writer, DataPointSnapshot dat
       throws IOException {
     if (data.hasScrapeTimestamp()) {
       writer.write(' ');
-      writeTimestamp(writer, data.getScrapeTimestampMillis(), timestampsInMs);
+      writePrometheusTimestamp(writer, data.getScrapeTimestampMillis(), timestampsInMs);
     }
     writer.write('\n');
   }

prometheus-metrics-exposition-textformats/src/main/java/io/prometheus/metrics/expositionformats/TextFormatUtil.java

@@ -21,25 +21,30 @@ static void writeDouble(Writer writer, double d) throws IOException {
     }
   }
 
-  static void writeTimestamp(Writer writer, long timestampMs, boolean timestampsInMs)
+  static void writePrometheusTimestamp(Writer writer, long timestampMs, boolean timestampsInMs)
       throws IOException {
     if (timestampsInMs) {
-      // correct as per
+      // correct for prometheus exposition format
       // https://prometheus.io/docs/instrumenting/exposition_formats/#text-format-details
       writer.write(Long.toString(timestampMs));
     } else {
-      // this is incorrect - but we need to support it for backwards compatibility
-      writer.write(Long.toString(timestampMs / 1000L));
-      writer.write(".");
-      long ms = timestampMs % 1000;
-      if (ms < 100) {
-        writer.write("0");
-      }
-      if (ms < 10) {
-        writer.write("0");
-      }
-      writer.write(Long.toString(ms));
+      // incorrect for prometheus exposition format -
+      // but we need to support it for backwards compatibility
+      writeOpenMetricsTimestamp(writer, timestampMs);
+    }
+  }
+
+  static void writeOpenMetricsTimestamp(Writer writer, long timestampMs) throws IOException {
+    writer.write(Long.toString(timestampMs / 1000L));
+    writer.write(".");
+    long ms = timestampMs % 1000;
+    if (ms < 100) {
+      writer.write("0");
+    }
+    if (ms < 10) {
+      writer.write("0");
     }
+    writer.write(Long.toString(ms));
   }
 
   static void writeEscapedLabelValue(Writer writer, String s) throws IOException {

prometheus-metrics-exposition-textformats/src/test/java/io/prometheus/metrics/expositionformats/TextFormatUtilTest.java

@@ -31,7 +31,7 @@ void testWriteTimestamp() throws IOException {
 
   private static String writeTimestamp(boolean timestampsInMs) throws IOException {
     StringWriter writer = new StringWriter();
-    TextFormatUtil.writeTimestamp(writer, 1000, timestampsInMs);
+    TextFormatUtil.writePrometheusTimestamp(writer, 1000, timestampsInMs);
     return writer.toString();
   }
 }