feat: Add readTimeout and conenctionTimeout as configurable parameters

Signed-off-by: huan.huynh <[email protected]>

Author: hmhuan

prometheus-metrics-exporter-pushgateway/pom.xml

@@ -39,5 +39,11 @@
       <version>${project.version}</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.squareup.okhttp3</groupId>
+      <artifactId>mockwebserver</artifactId>
+      <version>5.3.0</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 </project>

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

@@ -32,6 +32,7 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.TreeMap;
+import java.util.Optional;
 import javax.annotation.Nullable;
 
 /**
@@ -89,6 +90,8 @@ public class PushGateway {
   private final PrometheusRegistry registry;
   private final HttpConnectionFactory connectionFactory;
   private final EscapingScheme escapingScheme;
+  private final Integer connectionTimeout;
+  private final Integer readTimeout;
 
   private PushGateway(
       PrometheusRegistry registry,
@@ -97,13 +100,17 @@ private PushGateway(
       HttpConnectionFactory connectionFactory,
       Map<String, String> requestHeaders,
       boolean prometheusTimestampsInMs,
-      EscapingScheme escapingScheme) {
+      EscapingScheme escapingScheme,
+      @Nullable Integer connectionTimeout,
+      @Nullable Integer readTimeout) {
     this.registry = registry;
     this.url = url;
     this.requestHeaders = Collections.unmodifiableMap(new HashMap<>(requestHeaders));
     this.connectionFactory = connectionFactory;
     this.prometheusTimestampsInMs = prometheusTimestampsInMs;
     this.escapingScheme = escapingScheme;
+    this.connectionTimeout = Optional.ofNullable(connectionTimeout).orElse(10 * MILLISECONDS_PER_SECOND);
+    this.readTimeout = Optional.ofNullable(readTimeout).orElse(10 * MILLISECONDS_PER_SECOND);
     writer = getWriter(format);
     if (!writer.isAvailable()) {
       throw new RuntimeException(writer.getClass() + " is not available");
@@ -206,8 +213,8 @@ private void doRequest(@Nullable PrometheusRegistry registry, String method) thr
       }
       connection.setRequestMethod(method);
 
-      connection.setConnectTimeout(10 * MILLISECONDS_PER_SECOND);
-      connection.setReadTimeout(10 * MILLISECONDS_PER_SECOND);
+      connection.setConnectTimeout(this.connectionTimeout);
+      connection.setReadTimeout(this.readTimeout);
       connection.connect();
 
       try {
@@ -277,6 +284,8 @@ public static class Builder {
     @Nullable private String address;
     @Nullable private Scheme scheme;
     @Nullable private String job;
+    @Nullable private Integer connectionTimeout;
+    @Nullable private Integer readTimeout;
     private boolean prometheusTimestampsInMs;
     private final Map<String, String> requestHeaders = new HashMap<>();
     private PrometheusRegistry registry = PrometheusRegistry.defaultRegistry;
@@ -395,6 +404,30 @@ public Builder prometheusTimestampsInMs(boolean prometheusTimestampsInMs) {
       return this;
     }
 
+    /**
+     * Specify the connection timeout (in milliseconds) for HTTP connections to the PushGateway.
+     * Default is {@code 10000} (10 seconds).
+     *
+     * @param connectionTimeout timeout value in milliseconds
+     * @return this {@link Builder} instance
+     */
+    public Builder connectionTimeout(Integer connectionTimeout) {
+      this.connectionTimeout = connectionTimeout;
+      return this;
+    }
+
+    /**
+     * Specify the read timeout (in milliseconds) for reading the response from the PushGateway.
+     * Default is {@code 10000} (10 seconds).
+     *
+     * @param readTimeout timeout value in milliseconds
+     * @return this {@link Builder} instance
+     */
+    public Builder readTimeout(Integer readTimeout) {
+      this.readTimeout = readTimeout;
+      return this;
+    }
+
     private boolean getPrometheusTimestampsInMs() {
       // accept either to opt in to timestamps in milliseconds
       return config.getExporterProperties().getPrometheusTimestampsInMs()
@@ -496,7 +529,9 @@ public PushGateway build() {
             connectionFactory,
             requestHeaders,
             getPrometheusTimestampsInMs(),
-            getEscapingScheme(properties));
+            getEscapingScheme(properties),
+            connectionTimeout,
+            readTimeout);
       } catch (MalformedURLException e) {
         throw new PrometheusPropertiesException(
             address + ": Invalid address. Expecting <host>:<port>");

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

@@ -0,0 +1,75 @@
+package io.prometheus.metrics.exporter.pushgateway;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import java.util.concurrent.TimeUnit;
+
+import okhttp3.mockwebserver.MockResponse;
+import okhttp3.mockwebserver.MockWebServer;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+class PushGatewayTimeoutTest {
+
+  private MockWebServer mockWebServer;
+
+  @BeforeEach
+  void setUp() throws Exception {
+    mockWebServer = new MockWebServer();
+    mockWebServer.start();
+  }
+
+  @AfterEach
+  void tearDown() throws Exception {
+    mockWebServer.shutdown();
+  }
+
+  @Test
+  void connectionTimeoutIsEnforced() {
+    // Simulate server that never accepts connection: by binding but delaying accept.
+    // Since MockWebServer always accepts connection immediately, we instead use a short connect timeout and a response delay.
+    int shortConnectTimeoutMillis = 10;
+    int readTimeoutMillis = 1000;
+
+    PushGateway pushGateway = PushGateway.builder()
+      .connectionTimeout(shortConnectTimeoutMillis)
+      .readTimeout(readTimeoutMillis)
+      .build();
+
+    // Enqueue a response that delays sending headers to simulate slow connection
+    mockWebServer.enqueue(new MockResponse()
+      .setBody("ok")
+      .setBodyDelay(5, TimeUnit.SECONDS)); // very long delay
+
+    String url = mockWebServer.url("/").toString();
+
+    Exception thrown = assertThrows(Exception.class, pushGateway::pushAdd);
+
+    assertTrue(thrown.getMessage().contains("connect"), "Expected a connection‐timeout or connect error");
+  }
+
+  @Test
+  void readTimeoutIsEnforced() {
+    int connectTimeoutMillis = 1000;
+    int shortReadTimeoutMillis = 10;
+
+    PushGateway pushGateway = PushGateway.builder()
+      .connectionTimeout(connectTimeoutMillis)
+      .readTimeout(shortReadTimeoutMillis)
+      .build();
+
+    // Enqueue a response that sends headers but delays body
+    mockWebServer.enqueue(new MockResponse()
+      .setHeadersDelay(0, TimeUnit.SECONDS)
+      .setBodyDelay(5, TimeUnit.SECONDS)
+      .setBody("ok"));
+
+    String url = mockWebServer.url("/").toString();
+
+    Exception thrown = assertThrows(Exception.class, pushGateway::pushAdd);
+
+    assertTrue(thrown.getMessage().contains("read") || thrown.getMessage().contains("timeout"),
+      "Expected a read‐timeout error");
+  }
+}