properties should never be null

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

Author: zeitlinger

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

@@ -58,4 +58,41 @@ static ExporterPushgatewayProperties load(Map<Object, Object> properties)
     }
     return new ExporterPushgatewayProperties(address, job, scheme);
   }
+
+  public static Builder builder() {
+    return new Builder();
+  }
+
+  public static class Builder {
+    @Nullable private String address;
+    @Nullable private String job;
+    @Nullable private String scheme;
+    @Nullable private EscapingScheme escapingScheme;
+
+    private Builder() {}
+
+    public Builder address(String address) {
+      this.address = address;
+      return this;
+    }
+
+    public Builder job(String job) {
+      this.job = job;
+      return this;
+    }
+
+    public Builder scheme(String scheme) {
+      this.scheme = scheme;
+      return this;
+    }
+
+    public Builder escapingScheme(EscapingScheme escapingScheme) {
+      this.escapingScheme = escapingScheme;
+      return this;
+    }
+
+    public ExporterPushgatewayProperties build() {
+      return new ExporterPushgatewayProperties(address, job, scheme, escapingScheme);
+    }
+  }
 }

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

@@ -2,7 +2,6 @@
 
 import java.util.HashMap;
 import java.util.Map;
-import javax.annotation.Nullable;
 
 /**
  * The Prometheus Java client library can be configured at runtime (e.g. using a properties file).
@@ -13,14 +12,14 @@ public class PrometheusProperties {
 
   private static final PrometheusProperties instance = PrometheusPropertiesLoader.load();
 
-  @Nullable private final MetricsProperties defaultMetricsProperties;
+  private final MetricsProperties defaultMetricsProperties;
   private final Map<String, MetricsProperties> metricProperties = new HashMap<>();
-  @Nullable private final ExemplarsProperties exemplarProperties;
-  @Nullable private final ExporterProperties exporterProperties;
-  @Nullable private final ExporterFilterProperties exporterFilterProperties;
-  @Nullable private final ExporterHttpServerProperties exporterHttpServerProperties;
-  @Nullable private final ExporterOpenTelemetryProperties exporterOpenTelemetryProperties;
-  @Nullable private final ExporterPushgatewayProperties exporterPushgatewayProperties;
+  private final ExemplarsProperties exemplarProperties;
+  private final ExporterProperties exporterProperties;
+  private final ExporterFilterProperties exporterFilterProperties;
+  private final ExporterHttpServerProperties exporterHttpServerProperties;
+  private final ExporterOpenTelemetryProperties exporterOpenTelemetryProperties;
+  private final ExporterPushgatewayProperties exporterPushgatewayProperties;
 
   /**
    * Get the properties instance. When called for the first time, {@code get()} loads the properties
@@ -42,14 +41,14 @@ public static Builder builder() {
   }
 
   public PrometheusProperties(
-      @Nullable MetricsProperties defaultMetricsProperties,
+      MetricsProperties defaultMetricsProperties,
       Map<String, MetricsProperties> metricProperties,
-      @Nullable ExemplarsProperties exemplarProperties,
-      @Nullable ExporterProperties exporterProperties,
-      @Nullable ExporterFilterProperties exporterFilterProperties,
-      @Nullable ExporterHttpServerProperties httpServerConfig,
-      @Nullable ExporterPushgatewayProperties pushgatewayProperties,
-      @Nullable ExporterOpenTelemetryProperties otelConfig) {
+      ExemplarsProperties exemplarProperties,
+      ExporterProperties exporterProperties,
+      ExporterFilterProperties exporterFilterProperties,
+      ExporterHttpServerProperties httpServerConfig,
+      ExporterPushgatewayProperties pushgatewayProperties,
+      ExporterOpenTelemetryProperties otelConfig) {
     this.defaultMetricsProperties = defaultMetricsProperties;
     this.metricProperties.putAll(metricProperties);
     this.exemplarProperties = exemplarProperties;
@@ -64,7 +63,6 @@ public PrometheusProperties(
    * The default metric properties apply for metrics where {@link #getMetricProperties(String)} is
    * {@code null}.
    */
-  @Nullable
   public MetricsProperties getDefaultMetricProperties() {
     return defaultMetricsProperties;
   }
@@ -74,54 +72,51 @@ public MetricsProperties getDefaultMetricProperties() {
    * #getDefaultMetricProperties()}. May return {@code null} if no metric-specific properties are
    * configured for a metric name.
    */
-  @Nullable
   public MetricsProperties getMetricProperties(String metricName) {
     return metricProperties.get(metricName.replace(".", "_"));
   }
 
-  @Nullable
   public ExemplarsProperties getExemplarProperties() {
     return exemplarProperties;
   }
 
-  @Nullable
   public ExporterProperties getExporterProperties() {
     return exporterProperties;
   }
 
-  @Nullable
   public ExporterFilterProperties getExporterFilterProperties() {
     return exporterFilterProperties;
   }
 
-  @Nullable
   public ExporterHttpServerProperties getExporterHttpServerProperties() {
     return exporterHttpServerProperties;
   }
 
-  @Nullable
   public ExporterPushgatewayProperties getExporterPushgatewayProperties() {
     return exporterPushgatewayProperties;
   }
 
-  @Nullable
   public ExporterOpenTelemetryProperties getExporterOpenTelemetryProperties() {
     return exporterOpenTelemetryProperties;
   }
 
   public static class Builder {
-    @Nullable private MetricsProperties defaultMetricsProperties;
+    private MetricsProperties defaultMetricsProperties = MetricsProperties.builder().build();
     private Map<String, MetricsProperties> metricProperties = new HashMap<>();
-    @Nullable private ExemplarsProperties exemplarProperties;
-    @Nullable private ExporterProperties exporterProperties;
-    @Nullable private ExporterFilterProperties exporterFilterProperties;
-    @Nullable private ExporterHttpServerProperties exporterHttpServerProperties;
-    @Nullable private ExporterPushgatewayProperties pushgatewayProperties;
-    @Nullable private ExporterOpenTelemetryProperties otelConfig;
+    private ExemplarsProperties exemplarProperties = ExemplarsProperties.builder().build();
+    private ExporterProperties exporterProperties = ExporterProperties.builder().build();
+    private ExporterFilterProperties exporterFilterProperties =
+        ExporterFilterProperties.builder().build();
+    private ExporterHttpServerProperties exporterHttpServerProperties =
+        ExporterHttpServerProperties.builder().build();
+    private ExporterPushgatewayProperties pushGatewayProperties =
+        ExporterPushgatewayProperties.builder().build();
+    private ExporterOpenTelemetryProperties otelConfig =
+        ExporterOpenTelemetryProperties.builder().build();
 
     private Builder() {}
 
-    public Builder defaultMetricsProperties(@Nullable MetricsProperties defaultMetricsProperties) {
+    public Builder defaultMetricsProperties(MetricsProperties defaultMetricsProperties) {
       this.defaultMetricsProperties = defaultMetricsProperties;
       return this;
     }
@@ -137,36 +132,34 @@ public Builder putMetricProperty(String name, MetricsProperties props) {
       return this;
     }
 
-    public Builder exemplarProperties(@Nullable ExemplarsProperties exemplarProperties) {
+    public Builder exemplarProperties(ExemplarsProperties exemplarProperties) {
       this.exemplarProperties = exemplarProperties;
       return this;
     }
 
-    public Builder exporterProperties(@Nullable ExporterProperties exporterProperties) {
+    public Builder exporterProperties(ExporterProperties exporterProperties) {
       this.exporterProperties = exporterProperties;
       return this;
     }
 
-    public Builder exporterFilterProperties(
-        @Nullable ExporterFilterProperties exporterFilterProperties) {
+    public Builder exporterFilterProperties(ExporterFilterProperties exporterFilterProperties) {
       this.exporterFilterProperties = exporterFilterProperties;
       return this;
     }
 
     public Builder exporterHttpServerProperties(
-        @Nullable ExporterHttpServerProperties exporterHttpServerProperties) {
+        ExporterHttpServerProperties exporterHttpServerProperties) {
       this.exporterHttpServerProperties = exporterHttpServerProperties;
       return this;
     }
 
-    public Builder pushgatewayProperties(
-        @Nullable ExporterPushgatewayProperties pushgatewayProperties) {
-      this.pushgatewayProperties = pushgatewayProperties;
+    public Builder pushgatewayProperties(ExporterPushgatewayProperties pushgatewayProperties) {
+      this.pushGatewayProperties = pushgatewayProperties;
       return this;
     }
 
     public Builder exporterOpenTelemetryProperties(
-        @Nullable ExporterOpenTelemetryProperties exporterOpenTelemetryProperties) {
+        ExporterOpenTelemetryProperties exporterOpenTelemetryProperties) {
       this.otelConfig = exporterOpenTelemetryProperties;
       return this;
     }
@@ -179,7 +172,7 @@ public PrometheusProperties build() {
           exporterProperties,
           exporterFilterProperties,
           exporterHttpServerProperties,
-          pushgatewayProperties,
+          pushGatewayProperties,
           otelConfig);
     }
   }