add coverage check

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

Author: zeitlinger

checkstyle-suppressions.xml

@@ -5,5 +5,20 @@
   "https://checkstyle.org/dtds/suppressions_1_2.dtd">
 
 <suppressions>
-    <suppress checks="Javadoc" files="."/>
+  <!-- Suppress Javadoc paragraph formatting (empty line before <p> tag) globally. This is a
+       stylistic check that would require fixing hundreds of locations. We still enforce that
+       public APIs have documentation via other Javadoc checks. -->
+  <suppress checks="JavadocParagraph" files="."/>
+
+  <!-- Suppress all Javadoc checks for internal implementation packages -->
+  <suppress checks="Javadoc" files=".*[/\\]internal[/\\].*"/>
+
+  <!-- Suppress all Javadoc checks for example code -->
+  <suppress checks="Javadoc" files=".*[/\\]examples[/\\].*"/>
+
+  <!-- Suppress all Javadoc checks for benchmark code -->
+  <suppress checks="Javadoc" files=".*[/\\]benchmarks[/\\].*"/>
+
+  <!-- Suppress all Javadoc checks for integration tests -->
+  <suppress checks="Javadoc" files=".*[/\\]integration-tests[/\\].*"/>
 </suppressions>

pom.xml

@@ -264,6 +264,11 @@
                       <value>COVEREDRATIO</value>
                       <minimum>${jacoco.line-coverage}</minimum>
                     </limit>
+                    <limit>
+                      <counter>BRANCH</counter>
+                      <value>COVEREDRATIO</value>
+                      <minimum>0.50</minimum>
+                    </limit>
                   </limits>
                 </rule>
               </rules>

prometheus-metrics-exporter-httpserver/pom.xml

@@ -19,7 +19,7 @@
 
   <properties>
     <automatic.module.name>io.prometheus.metrics.exporter.httpserver</automatic.module.name>
-    <jacoco.line-coverage>0.45</jacoco.line-coverage>
+    <jacoco.line-coverage>0.60</jacoco.line-coverage>
   </properties>
 
   <dependencies>

prometheus-metrics-exposition-textformats/pom.xml

@@ -19,7 +19,7 @@
 
   <properties>
     <automatic.module.name>io.prometheus.writer.text</automatic.module.name>
-    <jacoco.line-coverage>0.50</jacoco.line-coverage>
+    <jacoco.line-coverage>0.60</jacoco.line-coverage>
   </properties>
 
   <dependencies>

prometheus-metrics-instrumentation-dropwizard5/pom.xml

@@ -19,7 +19,7 @@
 
   <properties>
     <automatic.module.name>io.prometheus.metrics.instrumentation.dropwizard5</automatic.module.name>
-    <jacoco.line-coverage>0.50</jacoco.line-coverage>
+    <jacoco.line-coverage>0.60</jacoco.line-coverage>
   </properties>
 
   <dependencies>

prometheus-metrics-instrumentation-jvm/pom.xml

@@ -19,7 +19,7 @@
 
   <properties>
     <automatic.module.name>io.prometheus.metrics.instrumentation.jvm</automatic.module.name>
-    <jacoco.line-coverage>0.55</jacoco.line-coverage>
+    <jacoco.line-coverage>0.60</jacoco.line-coverage>
   </properties>
 
   <dependencies>

prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/registry/Collector.java

@@ -65,8 +65,8 @@ default MetricSnapshot collect(
    *       and the metric name is excluded.
    * </ol>
    *
-   * Returning {@code null} means checks are omitted (registration the metric always succeeds), and
-   * the collector is always scraped (the result is dropped after scraping if a name filter is
+   * <p>Returning {@code null} means checks are omitted (registration the metric always succeeds),
+   * and the collector is always scraped (the result is dropped after scraping if a name filter is
    * present and the metric name is excluded).
    *
    * <p>If your metric has a name that does not change at runtime it is a good idea to overwrite

prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/registry/MultiCollector.java

@@ -60,9 +60,9 @@ default MetricSnapshots collect(
    *       and all names are excluded.
    * </ol>
    *
-   * Returning an empty list means checks are omitted (registration metric always succeeds), and the
-   * collector is always scraped (if a name filter is present and all names are excluded the result
-   * is dropped).
+   * <p>Returning an empty list means checks are omitted (registration metric always succeeds), and
+   * the collector is always scraped (if a name filter is present and all names are excluded the
+   * result is dropped).
    *
    * <p>If your collector returns a constant list of metrics that have names that do not change at
    * runtime it is a good idea to overwrite this and return the names.

prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/PrometheusNaming.java

@@ -27,7 +27,7 @@ public class PrometheusNaming {
    *   <li>OpenTelemetry: {@code process_runtime_jvm_buffer_count}
    * </ul>
    *
-   * We do not treat {@code _count} and {@code _sum} as reserved suffixes here for compatibility
+   * <p>We do not treat {@code _count} and {@code _sum} as reserved suffixes here for compatibility
    * with these libraries. However, there is a risk of name conflict if someone creates a gauge
    * named {@code my_data_count} and a histogram or summary named {@code my_data}, because the
    * histogram or summary will implicitly have a sample named {@code my_data_count}.
@@ -47,9 +47,9 @@ public class PrometheusNaming {
    *   <li>The name MUST NOT end with one of the {@link #RESERVED_METRIC_NAME_SUFFIXES}.
    * </ul>
    *
-   * If a metric has a {@link Unit}, the metric name SHOULD end with the unit as a suffix. Note that
-   * <a href="https://openmetrics.io/">OpenMetrics</a> requires metric names to have their unit as
-   * suffix, and we implement this in {@code prometheus-metrics-core}. However, {@code
+   * <p>If a metric has a {@link Unit}, the metric name SHOULD end with the unit as a suffix. Note
+   * that <a href="https://openmetrics.io/">OpenMetrics</a> requires metric names to have their unit
+   * as suffix, and we implement this in {@code prometheus-metrics-core}. However, {@code
    * prometheus-metrics-model} does not enforce Unit suffixes.
    *
    * <p>Example: If you create a Counter for a processing time with Unit {@link Unit#SECONDS

prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/Unit.java

@@ -9,8 +9,8 @@
  *     new Unit("myUnit");
  * </pre>
  *
- * Note that in Prometheus, units are largely based on SI base units (seconds, bytes, joules, grams,
- * meters, ratio, volts, amperes, and Celsius).
+ * <p>Note that in Prometheus, units are largely based on SI base units (seconds, bytes, joules,
+ * grams, meters, ratio, volts, amperes, and Celsius).
  */
 public final class Unit {