make protobuf optional

zeitlinger · zeitlinger · commit 091d1807141c · 2024-11-04T18:08:22.000+01:00
Signed-off-by: Gregor Zeitlinger &lt;gregor.zeitlinger@grafana.com&gt;
diff --git a/pom.xml b/pom.xml
@@ -64,6 +64,7 @@
         <module>prometheus-metrics-config</module>
         <module>prometheus-metrics-model</module>
         <module>prometheus-metrics-tracer</module>
+        <module>prometheus-writer-textformat</module>
         <module>prometheus-metrics-exposition-formats</module>
         <module>prometheus-metrics-exporter-common</module>
         <module>prometheus-metrics-exporter-servlet-jakarta</module>
diff --git a/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/CounterTest.java b/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/CounterTest.java
@@ -7,7 +7,7 @@
 
 import io.prometheus.metrics.core.exemplars.ExemplarSamplerConfigTestUtil;
 import io.prometheus.metrics.expositionformats.PrometheusProtobufWriter;
-import io.prometheus.metrics.expositionformats.TextFormatUtil;
+import io.prometheus.metrics.expositionformats.ProtobufUtil;
 import io.prometheus.metrics.expositionformats.generated.com_google_protobuf_4_28_2.Metrics;
 import io.prometheus.metrics.model.snapshots.CounterSnapshot;
 import io.prometheus.metrics.model.snapshots.Exemplar;
@@ -113,7 +113,7 @@ public void testTotalStrippedFromName() {
         }) {
       Counter counter = Counter.builder().name(name).unit(Unit.SECONDS).build();
       Metrics.MetricFamily protobufData = new PrometheusProtobufWriter().convert(counter.collect());
-      assertThat(TextFormatUtil.shortDebugString(protobufData))
+      assertThat(ProtobufUtil.shortDebugString(protobufData))
           .isEqualTo(
               "name: \"my_counter_seconds_total\" type: COUNTER metric { counter { value: 0.0 } }");
     }
diff --git a/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/HistogramTest.java b/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/HistogramTest.java
@@ -9,7 +9,7 @@
 import io.prometheus.metrics.core.exemplars.ExemplarSamplerConfigTestUtil;
 import io.prometheus.metrics.expositionformats.OpenMetricsTextFormatWriter;
 import io.prometheus.metrics.expositionformats.PrometheusProtobufWriter;
-import io.prometheus.metrics.expositionformats.TextFormatUtil;
+import io.prometheus.metrics.expositionformats.ProtobufUtil;
 import io.prometheus.metrics.expositionformats.generated.com_google_protobuf_4_28_2.Metrics;
 import io.prometheus.metrics.model.snapshots.ClassicHistogramBucket;
 import io.prometheus.metrics.model.snapshots.Exemplar;
@@ -92,7 +92,7 @@ private void run() throws NoSuchFieldException, IllegalAccessException {
           new PrometheusProtobufWriter().convert(histogram.collect());
       String expectedWithMetadata =
           "name: \"test\" type: HISTOGRAM metric { histogram { " + expected + " } }";
-      assertThat(TextFormatUtil.shortDebugString(protobufData))
+      assertThat(ProtobufUtil.shortDebugString(protobufData))
           .as("test \"" + name + "\" failed")
           .isEqualTo(expectedWithMetadata);
     }
@@ -941,7 +941,7 @@ public void testDefaults() throws IOException {
 
     // protobuf
     Metrics.MetricFamily protobufData = new PrometheusProtobufWriter().convert(snapshot);
-    assertThat(TextFormatUtil.shortDebugString(protobufData)).isEqualTo(expectedProtobuf);
+    assertThat(ProtobufUtil.shortDebugString(protobufData)).isEqualTo(expectedProtobuf);
 
     // text
     ByteArrayOutputStream out = new ByteArrayOutputStream();
diff --git a/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/InfoTest.java b/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/InfoTest.java
@@ -5,7 +5,7 @@
 
 import io.prometheus.metrics.expositionformats.OpenMetricsTextFormatWriter;
 import io.prometheus.metrics.expositionformats.PrometheusProtobufWriter;
-import io.prometheus.metrics.expositionformats.TextFormatUtil;
+import io.prometheus.metrics.expositionformats.ProtobufUtil;
 import io.prometheus.metrics.expositionformats.generated.com_google_protobuf_4_28_2.Metrics;
 import io.prometheus.metrics.model.snapshots.Labels;
 import io.prometheus.metrics.model.snapshots.MetricSnapshots;
@@ -28,7 +28,7 @@ public void testInfoStrippedFromName() {
         Info info = Info.builder().name(name).labelNames(labelName).build();
         info.addLabelValues("value");
         Metrics.MetricFamily protobufData = new PrometheusProtobufWriter().convert(info.collect());
-        assertThat(TextFormatUtil.shortDebugString(protobufData))
+        assertThat(ProtobufUtil.shortDebugString(protobufData))
             .isEqualTo(
                 "name: \"jvm_runtime_info\" type: GAUGE metric { label { name: \"my_key\" value: \"value\" } gauge { value: 1.0 } }");
       }
diff --git a/prometheus-metrics-exposition-formats/pom.xml b/prometheus-metrics-exposition-formats/pom.xml
@@ -25,12 +25,7 @@
     <dependencies>
         <dependency>
             <groupId>io.prometheus</groupId>
-            <artifactId>prometheus-metrics-model</artifactId>
-            <version>${project.version}</version>
-        </dependency>
-        <dependency>
-            <groupId>io.prometheus</groupId>
-            <artifactId>prometheus-metrics-config</artifactId>
+            <artifactId>prometheus-writer-textformat</artifactId>
             <version>${project.version}</version>
         </dependency>
         <dependency>
diff --git a/prometheus-metrics-exposition-formats/src/main/java/io/prometheus/metrics/expositionformats/ProtobufUtil.java b/prometheus-metrics-exposition-formats/src/main/java/io/prometheus/metrics/expositionformats/ProtobufUtil.java
@@ -1,5 +1,7 @@
 package io.prometheus.metrics.expositionformats;
 
+import com.google.protobuf.MessageOrBuilder;
+import com.google.protobuf.TextFormat;
 import com.google.protobuf.Timestamp;
 
 public class ProtobufUtil {
@@ -10,4 +12,8 @@ static Timestamp timestampFromMillis(long timestampMillis) {
         .setNanos((int) (timestampMillis % 1000L * 1000000L))
         .build();
   }
+
+  public static String shortDebugString(MessageOrBuilder protobufData) {
+    return TextFormat.printer().emittingSingleLine(true).printToString(protobufData);
+  }
 }
diff --git a/prometheus-metrics-exposition-formats/src/test/java/io/prometheus/metrics/expositionformats/ExpositionFormatsTest.java b/prometheus-metrics-exposition-formats/src/test/java/io/prometheus/metrics/expositionformats/ExpositionFormatsTest.java
@@ -2662,7 +2662,7 @@ private void assertPrometheusTextWithoutCreated(String expected, MetricSnapshot<
   private void assertPrometheusProtobuf(String expected, MetricSnapshot<?> snapshot) {
     PrometheusProtobufWriter writer = new PrometheusProtobufWriter();
     Metrics.MetricFamily protobufData = writer.convert(snapshot);
-    String actual = TextFormatUtil.shortDebugString(protobufData);
+    String actual = ProtobufUtil.shortDebugString(protobufData);
     assertThat(actual).isEqualTo(expected);
   }
 }
diff --git a/prometheus-metrics-instrumentation-caffeine/pom.xml b/prometheus-metrics-instrumentation-caffeine/pom.xml
@@ -44,7 +44,7 @@
         <!-- test dependencies -->
         <dependency>
             <groupId>io.prometheus</groupId>
-            <artifactId>prometheus-metrics-exposition-formats</artifactId>
+            <artifactId>prometheus-writer-textformat</artifactId>
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
diff --git a/prometheus-metrics-instrumentation-dropwizard5/pom.xml b/prometheus-metrics-instrumentation-dropwizard5/pom.xml
@@ -43,7 +43,7 @@
         </dependency>
         <dependency>
             <groupId>io.prometheus</groupId>
-            <artifactId>prometheus-metrics-exposition-formats</artifactId>
+            <artifactId>prometheus-writer-textformat</artifactId>
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
diff --git a/prometheus-metrics-instrumentation-guava/pom.xml b/prometheus-metrics-instrumentation-guava/pom.xml
@@ -41,7 +41,7 @@
         </dependency>
         <dependency>
             <groupId>io.prometheus</groupId>
-            <artifactId>prometheus-metrics-exposition-formats</artifactId>
+            <artifactId>prometheus-writer-textformat</artifactId>
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
diff --git a/prometheus-metrics-instrumentation-jvm/pom.xml b/prometheus-metrics-instrumentation-jvm/pom.xml
@@ -37,7 +37,7 @@
         </dependency>
         <dependency>
             <groupId>io.prometheus</groupId>
-            <artifactId>prometheus-metrics-exposition-formats</artifactId>
+            <artifactId>prometheus-writer-textformat</artifactId>
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
diff --git a/prometheus-metrics-simpleclient-bridge/pom.xml b/prometheus-metrics-simpleclient-bridge/pom.xml
@@ -41,7 +41,7 @@
         <!-- test dependencies -->
         <dependency>
             <groupId>io.prometheus</groupId>
-            <artifactId>prometheus-metrics-exposition-formats</artifactId>
+            <artifactId>prometheus-writer-textformat</artifactId>
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
diff --git a/prometheus-writer-textformat/pom.xml b/prometheus-writer-textformat/pom.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>io.prometheus</groupId>
+        <artifactId>client_java</artifactId>
+        <version>1.3.2</version>
+    </parent>
+
+    <artifactId>prometheus-writer-textformat</artifactId>
+    <packaging>bundle</packaging>
+
+    <name>Prometheus Metrics Exposition Text Formats</name>
+    <description>
+        Prometheus exposition text formats.
+    </description>
+
+    <properties>
+        <automatic.module.name>io.prometheus.writer.text</automatic.module.name>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.prometheus</groupId>
+            <artifactId>prometheus-metrics-model</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.prometheus</groupId>
+            <artifactId>prometheus-metrics-config</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/prometheus-writer-textformat/src/main/java/io/prometheus/metrics/expositionformats/ExpositionFormatWriter.java b/prometheus-writer-textformat/src/main/java/io/prometheus/metrics/expositionformats/ExpositionFormatWriter.java
diff --git a/prometheus-writer-textformat/src/main/java/io/prometheus/metrics/expositionformats/OpenMetricsTextFormatWriter.java b/prometheus-writer-textformat/src/main/java/io/prometheus/metrics/expositionformats/OpenMetricsTextFormatWriter.java
diff --git a/prometheus-writer-textformat/src/main/java/io/prometheus/metrics/expositionformats/PrometheusTextFormatWriter.java b/prometheus-writer-textformat/src/main/java/io/prometheus/metrics/expositionformats/PrometheusTextFormatWriter.java
diff --git a/prometheus-writer-textformat/src/main/java/io/prometheus/metrics/expositionformats/TextFormatUtil.java b/prometheus-writer-textformat/src/main/java/io/prometheus/metrics/expositionformats/TextFormatUtil.java
@@ -1,7 +1,5 @@
 package io.prometheus.metrics.expositionformats;
 
-import com.google.protobuf.MessageOrBuilder;
-import com.google.protobuf.TextFormat;
 import io.prometheus.metrics.model.snapshots.Labels;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
@@ -83,8 +81,4 @@ static void writeLabels(
     }
     writer.write('}');
   }
-
-  public static String shortDebugString(MessageOrBuilder protobufData) {
-    return TextFormat.printer().emittingSingleLine(true).printToString(protobufData);
-  }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`package io.prometheus.metrics.expositionformats;`
`2`	`2`
	`3`	`+import com.google.protobuf.MessageOrBuilder;`
	`4`	`+import com.google.protobuf.TextFormat;`
`3`	`5`	`import com.google.protobuf.Timestamp;`
`4`	`6`
`5`	`7`	`public class ProtobufUtil {`
`@@ -10,4 +12,8 @@ static Timestamp timestampFromMillis(long timestampMillis) {`
`10`	`12`	`.setNanos((int) (timestampMillis % 1000L * 1000000L))`
`11`	`13`	`.build();`
`12`	`14`	`}`
	`15`	`+`
	`16`	`+ public static String shortDebugString(MessageOrBuilder protobufData) {`
	`17`	`+ return TextFormat.printer().emittingSingleLine(true).printToString(protobufData);`
	`18`	`+ }`
`13`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2662,7 +2662,7 @@ private void assertPrometheusTextWithoutCreated(String expected, MetricSnapshot<`
`2662`	`2662`	`private void assertPrometheusProtobuf(String expected, MetricSnapshot<?> snapshot) {`
`2663`	`2663`	`PrometheusProtobufWriter writer = new PrometheusProtobufWriter();`
`2664`	`2664`	`Metrics.MetricFamily protobufData = writer.convert(snapshot);`
`2665`		`- String actual = TextFormatUtil.shortDebugString(protobufData);`
	`2665`	`+ String actual = ProtobufUtil.shortDebugString(protobufData);`
`2666`	`2666`	`assertThat(actual).isEqualTo(expected);`
`2667`	`2667`	`}`
`2668`	`2668`	`}`