Add Benchmark for TextFormatUtil

Signed-off-by: Philippe Marschall <[email protected]>

Author: marschall

benchmarks/pom.xml

@@ -42,20 +42,13 @@
             <version>${jmh.version}</version>
         </dependency>
         <dependency>
-            <groupId>org.openjdk.jmh</groupId>
-            <artifactId>jmh-generator-annprocess</artifactId>
-            <version>${jmh.version}</version>
-        </dependency>
-        <!--
-        <dependency>
-            <groupId>javax.annotation</groupId>
-            <artifactId>javax.annotation-api</artifactId>
-            <version>1.3.2</version>
+            <groupId>io.prometheus</groupId>
+            <artifactId>prometheus-metrics-core</artifactId>
+            <version>${project.version}</version>
         </dependency>
-        -->
         <dependency>
             <groupId>io.prometheus</groupId>
-            <artifactId>prometheus-metrics-core</artifactId>
+            <artifactId>prometheus-metrics-exposition-textformats</artifactId>
             <version>${project.version}</version>
         </dependency>
         <dependency>

benchmarks/src/main/java/io/prometheus/metrics/benchmarks/TextFormatUtilBenchmark.java

@@ -0,0 +1,122 @@
+package io.prometheus.metrics.benchmarks;
+
+import io.prometheus.metrics.expositionformats.ExpositionFormatWriter;
+import io.prometheus.metrics.expositionformats.OpenMetricsTextFormatWriter;
+import io.prometheus.metrics.expositionformats.PrometheusTextFormatWriter;
+import io.prometheus.metrics.model.snapshots.GaugeSnapshot;
+import io.prometheus.metrics.model.snapshots.GaugeSnapshot.GaugeDataPointSnapshot;
+import io.prometheus.metrics.model.snapshots.Labels;
+import io.prometheus.metrics.model.snapshots.MetricSnapshot;
+import io.prometheus.metrics.model.snapshots.MetricSnapshots;
+import io.prometheus.metrics.model.snapshots.SummarySnapshot;
+import io.prometheus.metrics.model.snapshots.SummarySnapshot.SummaryDataPointSnapshot;
+import io.prometheus.metrics.model.snapshots.Unit;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import org.openjdk.jmh.annotations.Benchmark;
+import org.openjdk.jmh.annotations.Scope;
+import org.openjdk.jmh.annotations.State;
+
+public class TextFormatUtilBenchmark {
+
+  private static final MetricSnapshots SNAPSHOTS;
+
+  static {
+    MetricSnapshot gaugeSnapshot =
+        GaugeSnapshot.builder()
+            .name("gauge_snapshot_name")
+            .dataPoint(
+                GaugeDataPointSnapshot.builder()
+                    .labels(Labels.of("name", "value"))
+                    .scrapeTimestampMillis(1000L)
+                    .value(123.45d)
+                    .build())
+            .build();
+
+    MetricSnapshot summaryDataPointSnapshot =
+        SummarySnapshot.builder()
+            .name("summary_snapshot_name_bytes")
+            .dataPoint(
+                SummaryDataPointSnapshot.builder()
+                    .count(5)
+                    .labels(Labels.of("name", "value"))
+                    .sum(123456d)
+                    .build())
+            .unit(Unit.BYTES)
+            .build();
+
+    SNAPSHOTS = MetricSnapshots.of(gaugeSnapshot, summaryDataPointSnapshot);
+  }
+
+  private static final ExpositionFormatWriter OPEN_METRICS_TEXT_FORMAT_WRITER =
+      new OpenMetricsTextFormatWriter(false, false);
+  private static final ExpositionFormatWriter PROMETHEUS_TEXT_FORMAT_WRITER =
+      new PrometheusTextFormatWriter(false);
+
+  @State(Scope.Benchmark)
+  public static class WriterState {
+
+    final ByteArrayOutputStream byteArrayOutputStream;
+
+    public WriterState() {
+      this.byteArrayOutputStream = new ByteArrayOutputStream();
+    }
+  }
+
+  @Benchmark
+  public OutputStream openMetricsWriteToByteArray(WriterState writerState) throws IOException {
+    // avoid growing the array
+    ByteArrayOutputStream byteArrayOutputStream = writerState.byteArrayOutputStream;
+    byteArrayOutputStream.reset();
+    OPEN_METRICS_TEXT_FORMAT_WRITER.write(byteArrayOutputStream, SNAPSHOTS);
+    return byteArrayOutputStream;
+  }
+
+  @Benchmark
+  public OutputStream openMetricsWriteToNull() throws IOException {
+    OutputStream nullOutputStream = NullOutputStream.INSTANCE;
+    OPEN_METRICS_TEXT_FORMAT_WRITER.write(nullOutputStream, SNAPSHOTS);
+    return nullOutputStream;
+  }
+
+  @Benchmark
+  public OutputStream prometheusWriteToByteArray(WriterState writerState) throws IOException {
+    // avoid growing the array
+    ByteArrayOutputStream byteArrayOutputStream = writerState.byteArrayOutputStream;
+    byteArrayOutputStream.reset();
+    PROMETHEUS_TEXT_FORMAT_WRITER.write(byteArrayOutputStream, SNAPSHOTS);
+    return byteArrayOutputStream;
+  }
+
+  @Benchmark
+  public OutputStream prometheusWriteToNull() throws IOException {
+    OutputStream nullOutputStream = NullOutputStream.INSTANCE;
+    PROMETHEUS_TEXT_FORMAT_WRITER.write(nullOutputStream, SNAPSHOTS);
+    return nullOutputStream;
+  }
+
+  static final class NullOutputStream extends OutputStream {
+
+    static final OutputStream INSTANCE = new NullOutputStream();
+
+    private NullOutputStream() {
+      super();
+    }
+
+    @Override
+    public void write(int b) {}
+
+    @Override
+    public void write(byte[] b) {}
+
+    @Override
+    public void write(byte[] b, int off, int len) {}
+
+    @Override
+    public void flush() {}
+
+    @Override
+    public void close() {}
+  }
+}