Tidy up refactor to use record types for MetricData etc

Author: rob-bygrave

server/pom.xml

@@ -57,6 +57,13 @@
       <version>${avaje-jsonb.version}</version>
     </dependency>
 
+    <dependency>
+      <groupId>io.avaje</groupId>
+      <artifactId>avaje-record-builder</artifactId>
+      <version>${avaje-record-builder.version}</version>
+      <scope>provided</scope>
+    </dependency>
+
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-http-api</artifactId>
@@ -197,6 +204,11 @@
               <artifactId>avaje-jsonb-generator</artifactId>
               <version>${avaje-jsonb.version}</version>
             </path>
+            <path>
+              <groupId>io.avaje</groupId>
+              <artifactId>avaje-record-builder</artifactId>
+              <version>${avaje-record-builder.version}</version>
+            </path>
             <path>
               <groupId>io.avaje</groupId>
               <artifactId>avaje-http-jex-generator</artifactId>

server/src/main/java/org/ebean/monitor/api/MetricData.java

@@ -1,55 +1,47 @@
 package org.ebean.monitor.api;
 
 import io.avaje.jsonb.Json;
+import io.avaje.recordbuilder.RecordBuilder;
 
 /**
  * A timed metric with combined count, mean, max and total.
  * <p>
  * Times are generally expected to be in microseconds.
  * </p>
+ *
+ * @param name  The metric name.
+ * @param hash  Optional hash used to identify a query metric.
+ * @param loc   Optional location attribute. Code location of query or {@code @Transactional}.
+ * @param sql   SQL only supplied for SQL query metrics.
+ * @param tags  Optional canonical tags for v2 payloads, as a sorted delimited
+ *              {@code "key:value,key2:value2"} string (e.g.
+ *              {@code "kind:orm,label:Customer.findList,type:Customer"}). Null/absent for
+ *              legacy v1 payloads.
+ * @param count Timed metric count.
+ * @param mean  Timed metric mean.
+ * @param max   Timed metric max.
+ * @param total Timed metric total.
+ * @param value Non timed metrics just use the value attribute.
  */
+@RecordBuilder
 @Json
-public class MetricData {
+public record MetricData(
+  String name,
+  String hash,
+  String loc,
+  String sql,
+  String tags,
+  Long count,
+  Long mean,
+  Long max,
+  Long total,
+  Double value
+) {
 
   /**
-   * The metric name.
+   * Create a new builder.
    */
-  public String name;
-
-  /**
-   * Optional hash used to identify a query metric.
-   */
-  public String hash;
-
-  /**
-   * Optional location attribute. Code location of query or @Transactional.
-   */
-  public String loc;
-
-  /**
-   * SQL only supplied for SQL query metrics.
-   */
-  public String sql;
-
-  /**
-   * Optional canonical tags for v2 payloads, as a sorted delimited
-   * {@code "key:value,key2:value2"} string (e.g. {@code "kind:orm,label:Customer.findList,type:Customer"}).
-   * <p>
-   * Null/absent for legacy v1 payloads. Parsing only at this stage — not yet
-   * stored or used for metric identity.
-   */
-  public String tags;
-
-  /**
-   * Timed metrics have attributes of count, mean, max and total.
-   */
-  public Long count;
-  public Long mean;
-  public Long max;
-  public Long total;
-
-  /**
-   * Non timed metrics just use the value attribute.
-   */
-  public Double value;
+  public static MetricDataBuilder builder() {
+    return MetricDataBuilder.builder();
+  }
 }

server/src/main/java/org/ebean/monitor/api/MetricDbData.java

@@ -1,23 +1,32 @@
 package org.ebean.monitor.api;
 
 import io.avaje.jsonb.Json;
+import io.avaje.recordbuilder.RecordBuilder;
 
 import java.util.ArrayList;
 import java.util.List;
 
 /**
  * Database metrics.
+ *
+ * @param db      The Db name.
+ * @param metrics The metrics for the database.
  */
+@RecordBuilder
 @Json
-public class MetricDbData {
+public record MetricDbData(
+  String db,
+  List<MetricData> metrics
+) {
 
-  /**
-   * The Db name.
-   */
-  public String db;
+  public MetricDbData {
+    metrics = (metrics == null) ? new ArrayList<>() : metrics;
+  }
 
   /**
-   * The metrics for the database.
+   * Create a new builder.
    */
-  public List<MetricData> metrics = new ArrayList<>();
+  public static MetricDbDataBuilder builder() {
+    return MetricDbDataBuilder.builder();
+  }
 }

server/src/main/java/org/ebean/monitor/api/MetricRequest.java

@@ -1,6 +1,7 @@
 package org.ebean.monitor.api;
 
 import io.avaje.jsonb.Json;
+import io.avaje.recordbuilder.RecordBuilder;
 
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
@@ -9,69 +10,57 @@
 
 /**
  * Metrics to ingest.
+ *
+ * @param v              Metric payload format version. {@code 0}/absent means legacy v1 (flat
+ *                       names, no tags); {@code 2} means v2 (canonical family {@code name} +
+ *                       delimited {@code tags} string on each {@link MetricData}).
+ * @param startEventTime Optional start of the metric window provided by the client (epoch
+ *                       millis, typically the {@code eventTime} of the prior successful send,
+ *                       or the reporter start time on the first send). When non-zero, the OTLP
+ *                       forwarder uses this as {@code startTimeUnixNano} so consecutive deltas
+ *                       are truly disjoint and survive
+ *                       {@code otelcol.processor.deltatocumulative}.
+ * @param eventTime      The metric collection time.
+ * @param appName        The name of the application the metrics are collected for.
+ * @param version        The application version. Used to determine when new versions are released.
+ * @param environment    The name of the environment the metrics are collected for.
+ * @param instanceId     An Id for the server instance (eg. Kubernetes pod name).
+ * @param metrics        General metrics for the application (Rest endpoints, JVM metrics,
+ *                       CGroup metrics etc).
+ * @param dbs            The database metrics.
+ * @param resAttrs       Optional extra resource attributes — typically parsed from the standard
+ *                       {@code OTEL_RESOURCE_ATTRIBUTES} env var by the client. Forwarded
+ *                       verbatim to the OTLP {@code resource.attributes} list. The reserved
+ *                       per-app fields ({@code service.name}, {@code service.version},
+ *                       {@code service.instance.id}, {@code deployment.environment.name})
+ *                       sourced from the dedicated header fields above take precedence over any
+ *                       matching keys here.
  */
+@RecordBuilder
 @Json
-public class MetricRequest {
+public record MetricRequest(
+  int v,
+  long startEventTime,
+  long eventTime,
+  String appName,
+  String version,
+  String environment,
+  String instanceId,
+  List<MetricData> metrics,
+  List<MetricDbData> dbs,
+  Map<String, String> resAttrs
+) {
 
-  /**
-   * Metric payload format version. {@code 0}/absent means legacy v1 (flat names,
-   * no tags); {@code 2} means v2 (canonical family {@code name} + delimited
-   * {@code tags} string on each {@link MetricData}). Parsing only at this stage.
-   */
-  public int v;
-
-  /**
-   * Optional start of the metric window provided by the client (epoch millis,
-   * typically the {@code eventTime} of the prior successful send, or the
-   * reporter start time on the first send). When non-zero, the OTLP forwarder
-   * uses this as {@code startTimeUnixNano} so consecutive deltas are truly
-   * disjoint and survive {@code otelcol.processor.deltatocumulative}.
-   */
-  public long startEventTime;
-
-  /**
-   * The metric collection time.
-   */
-  public long eventTime;
-
-  /**
-   * The name of the application the metrics are collected for.
-   */
-  public String appName;
-
-  /**
-   * The application version. Used to determine when new versions are released.
-   */
-  public String version;
+  public MetricRequest {
+    metrics = (metrics == null) ? new ArrayList<>() : metrics;
+    dbs = (dbs == null) ? new ArrayList<>() : dbs;
+    resAttrs = (resAttrs == null) ? new LinkedHashMap<>() : resAttrs;
+  }
 
   /**
-   * The name of the environment the metrics are collected for.
+   * Create a new builder.
    */
-  public String environment;
-
-  /**
-   * An Id for the server instance (eg. Kubernetes pod name).
-   */
-  public String instanceId;
-
-  /**
-   * General metrics for the application (Rest endpoints, JVM metrics, CGroup metrics etc).
-   */
-  public List<MetricData> metrics = new ArrayList<>();
-
-  /**
-   * The database metrics.
-   */
-  public List<MetricDbData> dbs = new ArrayList<>();
-
-  /**
-   * Optional extra resource attributes — typically parsed from the standard
-   * {@code OTEL_RESOURCE_ATTRIBUTES} env var by the client. Forwarded verbatim
-   * to the OTLP {@code resource.attributes} list. The reserved per-app fields
-   * ({@code service.name}, {@code service.version}, {@code service.instance.id},
-   * {@code deployment.environment.name}) sourced from the dedicated header
-   * fields above take precedence over any matching keys here.
-   */
-  public Map<String, String> resAttrs = new LinkedHashMap<>();
-
+  public static MetricRequestBuilder builder() {
+    return MetricRequestBuilder.builder();
+  }
 }