format

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

Author: zeitlinger

.editorconfig

@@ -1,8 +1,18 @@
 root = true
 
-[*]
-max_line_length = 100
-indent_size = 2
+[version-rules.xml]
+max_line_length = 200
+
+[*.java]
+# checked by google-java-format
+max_line_length = 200
 
 [pom.xml]
 indent_size = 4
+
+[docs/themes/**.*]
+max_line_length = 400
+
+[*]
+max_line_length = 150
+indent_size = 2

.github/super-linter.env

@@ -3,19 +3,22 @@ IGNORE_GITIGNORED_FILES=true
 JAVA_FILE_NAME=google_checks.xml
 # disable kubernetes linter - complains about resource limits, etc
 VALIDATE_CHECKOV=false
+VALIDATE_CSS=false
+VALIDATE_CSS_PRETTIER=false
 VALIDATE_DOCKERFILE_HADOLINT=false
 VALIDATE_GIT_COMMITLINT=false
 # done by maven
 VALIDATE_GOOGLE_JAVA_FORMAT=false
 # times out
 VALIDATE_GO_MODULES=false
+VALIDATE_HTML=false
 # done by checkstyle
 VALIDATE_JAVA=false
 # contradicting with prettier
 VALIDATE_JAVASCRIPT_STANDARD=false
 # we have many duplicate code in our codebase for demo purposes
 VALIDATE_JSCPD=false
-VALIDATE_PYTHON_PYINK=false
+VALIDATE_PYTHON_PYLINT=false
 
 # FILTER_REGEX_EXCLUDE=src/main/generated/.*|docs/themes/.*
 

CONTRIBUTING.md

@@ -13,15 +13,17 @@ Prometheus uses GitHub to manage reviews of pull requests.
 
 ## Formatting
 
-This repository uses [Google Java Format](https://github.com/google/google-java-format) to format the code.
+This repository uses [Google Java Format](https://github.com/google/google-java-format) to format
+the code.
 
 Run `./mvnw spotless:apply` to format the code (only changed files) before committing.
 
 ## Running Tests
 
 If you're getting errors when running tests:
 
-- Make sure that the IDE uses only the "Maven Shade" dependency of "prometheus-metrics-exposition-formats" and the "prometheus-metrics-tracer\*" dependencies.
+- Make sure that the IDE uses only the "Maven Shade" dependency of "
+  prometheus-metrics-exposition-formats" and the "prometheus-metrics-tracer\*" dependencies.
 
 ### Avoid failures while running tests
 
@@ -30,7 +32,8 @@ If you're getting errors when running tests:
 - Use `-Dcheckstyle.skip=true` to skip the checkstyle check during development.
 - Use `-Dwarnings=-nowarn` to skip the warnings during development.
 
-Combine all with `./mvnw test -DskipTests=true -Dspotless.check.skip=true -Dcoverage.skip=true -Dcheckstyle.skip=true -Dwarnings=-nowarn`.
+Combine all with
+`./mvnw test -DskipTests=true -Dspotless.check.skip=true -Dcoverage.skip=true -Dcheckstyle.skip=true -Dwarnings=-nowarn`.
 
 ## Updating the Protobuf Java Classes
 

README.md

@@ -8,13 +8,17 @@
 
 # Contributing and community
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) and the [community section](http://prometheus.io/community/) of the Prometheus homepage.
+See [CONTRIBUTING.md](CONTRIBUTING.md) and the [community section](http://prometheus.io/community/)
+of the Prometheus homepage.
 
-The Prometheus Java community is present on the [CNCF Slack](https://cloud-native.slack.com) on `#prometheus-java`, and we have a fortnightly community call in the [Prometheus public calendar](https://prometheus.io/community/).
+The Prometheus Java community is present on the [CNCF Slack](https://cloud-native.slack.com) on
+`#prometheus-java`, and we have a fortnightly community call in
+the [Prometheus public calendar](https://prometheus.io/community/).
 
 # Previous Releases
 
-The source code for 0.16.0 and older is on the [simpleclient](https://github.com/prometheus/client_java/tree/simpleclient) branch.
+The source code for 0.16.0 and older is on
+the [simpleclient](https://github.com/prometheus/client_java/tree/simpleclient) branch.
 
 # License
 

RELEASING.md

@@ -2,5 +2,6 @@
 
 1. Go to <https://github.com/prometheus/client_java/releases/new>
 2. Click on "Choose a tag", enter the tag name (e.g. `v0.1.0`), and click "Create a new tag".
-3. Click on "Generate release notes" to auto-generate the release notes based on the commits since the last release.
+3. Click on "Generate release notes" to auto-generate the release notes based on the commits since
+   the last release.
 4. Click on "Publish release".

docs/README.md

@@ -51,7 +51,8 @@ Here's how the initial `docs/` folder was set up:
 hugo new site docs
 cd docs/
 mkdir -p themes/hugo-geekdoc/
-curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/download/v0.41.1/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1
+curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/download/v0.41.1/hugo-geekdoc.tar.gz \
+  | tar -xz -C themes/hugo-geekdoc/ --strip-components=1
 ```
 
 Create the initial `hugo.toml` file as described

docs/content/exporters/httpserver.md

@@ -4,29 +4,34 @@ weight: 3
 ---
 
 The `HTTPServer` is a standalone server for exposing a metric endpoint. A minimal example
-application for `HTTPServer` can be found in the [examples](https://github.com/prometheus/client_java/tree/1.0.x/examples) directory.
+application for `HTTPServer` can be found in
+the [examples](https://github.com/prometheus/client_java/tree/1.0.x/examples) directory.
 
 ```java
 HTTPServer server = HTTPServer.builder()
-    .port(9400)
-    .buildAndStart();
+  .port(9400)
+  .buildAndStart();
 ```
 
 By default, `HTTPServer` binds to any IP address, you can change this with
-[hostname()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#hostname(java.lang.String)>) or [inetAddress()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#inetAddress(java.net.InetAddress)>).
+[hostname()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#hostname(java.lang.String)>)
+or [inetAddress()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#inetAddress(java.net.InetAddress)>).
 
 `HTTPServer` is configured with three endpoints:
 
 - `/metrics` for Prometheus scraping.
 - `/-/healthy` for simple health checks.
 - `/` the default handler is a static HTML page.
 
-The default handler can be changed with [defaultHandler()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#defaultHandler(com.sun.net.httpserver.HttpHandler)>).
+The default handler can be changed
+with [defaultHandler()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#defaultHandler(com.sun.net.httpserver.HttpHandler)>).
 
 ## Authentication and HTTPS
 
-- [authenticator()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#authenticator(com.sun.net.httpserver.Authenticator)>) is for configuring authentication.
-- [httpsConfigurator()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#httpsConfigurator(com.sun.net.httpserver.HttpsConfigurator)>) is for configuring HTTPS.
+- [authenticator()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#authenticator(com.sun.net.httpserver.Authenticator)>)
+  is for configuring authentication.
+- [httpsConfigurator()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#httpsConfigurator(com.sun.net.httpserver.HttpsConfigurator)>)
+  is for configuring HTTPS.
 
 You can find an example of authentication and SSL in the [jmx_exporter](https://github.com/prometheus/jmx_exporter).
 

docs/content/exporters/spring.md

@@ -5,7 +5,8 @@ weight: 5
 
 ## Alternative: Use Spring's Built-in Metrics Library
 
-[Spring Boot](https://spring.io/projects/spring-boot) has a built-in metric library named [Micrometer](https://micrometer.io/), which supports Prometheus
+[Spring Boot](https://spring.io/projects/spring-boot) has a built-in metric library named
+[Micrometer](https://micrometer.io/), which supports Prometheus
 exposition format and can be set up in three simple steps:
 
 1. Add the `org.springframework.boot:spring-boot-starter-actuator` dependency.
@@ -25,7 +26,8 @@ Spring anyway. Maybe you want full support for all Prometheus metric types,
 or you want to use the new Prometheus native histograms.
 
 The easiest way to use the Prometheus metrics library in Spring is to configure the
-[PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html) to expose metrics.
+[PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html)
+to expose metrics.
 
 Dependencies:
 
@@ -51,35 +53,37 @@ import org.springframework.web.bind.annotation.RestController;
 @RestController
 public class DemoApplication {
 
-    private static final Counter requestCount = Counter.builder()
-            .name("requests_total")
-            .register();
-
-    public static void main(String[] args) {
-        SpringApplication.run(DemoApplication.class, args);
-        JvmMetrics.builder().register();
-    }
-
-    @GetMapping("/")
-    public String sayHello() throws InterruptedException {
-        requestCount.inc();
-        return "Hello, World!\n";
-    }
-
-    @Bean
-    public ServletRegistrationBean<PrometheusMetricsServlet> createPrometheusMetricsEndpoint() {
-        return new ServletRegistrationBean<>(new PrometheusMetricsServlet(), "/metrics/*");
-    }
+  private static final Counter requestCount = Counter.builder()
+    .name("requests_total")
+    .register();
+
+  public static void main(String[] args) {
+    SpringApplication.run(DemoApplication.class, args);
+    JvmMetrics.builder().register();
+  }
+
+  @GetMapping("/")
+  public String sayHello() throws InterruptedException {
+    requestCount.inc();
+    return "Hello, World!\n";
+  }
+
+  @Bean
+  public ServletRegistrationBean<PrometheusMetricsServlet> createPrometheusMetricsEndpoint() {
+    return new ServletRegistrationBean<>(new PrometheusMetricsServlet(), "/metrics/*");
+  }
 }
 ```
 
 The important part are the last three lines: They configure the
-[PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html) to expose metrics on `/metrics`:
+[PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html)
+to expose metrics on `/metrics`:
 
 ```java
+
 @Bean
 public ServletRegistrationBean<PrometheusMetricsServlet> createPrometheusMetricsEndpoint() {
-    return new ServletRegistrationBean<>(new PrometheusMetricsServlet(), "/metrics/*");
+  return new ServletRegistrationBean<>(new PrometheusMetricsServlet(), "/metrics/*");
 }
 ```
 

docs/content/migration/simpleclient.md

@@ -3,14 +3,21 @@ title: Simpleclient
 weight: 1
 ---
 
-The Prometheus Java client library 1.0.0 is a complete rewrite of the underlying data model, and is not backwards compatible with releases 0.16.0 and older for a variety of reasons:
+The Prometheus Java client library 1.0.0 is a complete rewrite of the underlying data model, and is not backwards
+compatible with releases 0.16.0 and older for a variety of reasons:
 
-- The old data model was based on [OpenMetrics](https://openmetrics.io). Native histograms don't fit with the OpenMetrics model because they don't follow the "every sample has exactly one double value" paradigm. It was a lot cleaner to implement a dedicated `prometheus-metrics-model` than trying to fit native histograms into the existing OpenMetrics-based model.
-- Version 0.16.0 and older has multiple Maven modules sharing the same Java package name. This is not supported by the Java module system. To support users of Java modules, we renamed all packages and made sure no package is reused across multiple Maven modules.
+- The old data model was based on [OpenMetrics](https://openmetrics.io). Native histograms don't fit with the
+  OpenMetrics model because they don't follow the "every sample has exactly one double value" paradigm. It was a lot
+  cleaner to implement a dedicated `prometheus-metrics-model` than trying to fit native histograms into the existing
+  OpenMetrics-based model.
+- Version 0.16.0 and older has multiple Maven modules sharing the same Java package name. This is not supported by the
+  Java module system. To support users of Java modules, we renamed all packages and made sure no package is reused
+  across multiple Maven modules.
 
 ## Migration using the Simpleclient Bridge
 
-Good news: Users of version 0.16.0 and older do not need to refactor all their instrumentation code to get started with 1.0.0.
+Good news: Users of version 0.16.0 and older do not need to refactor all their instrumentation code to get started with
+1.0.0.
 
 We provide a migration module for bridging the old simpleclient `CollectorRegistry` to the new `PrometheusRegistry`.
 
@@ -27,10 +34,11 @@ implementation 'io.prometheus:prometheus-metrics-simpleclient-bridge:1.0.0'
 {{< tab "Maven" >}}
 
 ```xml
+
 <dependency>
-    <groupId>io.prometheus</groupId>
-    <artifactId>prometheus-metrics-simpleclient-bridge</artifactId>
-    <version>1.0.0</version>
+  <groupId>io.prometheus</groupId>
+  <artifactId>prometheus-metrics-simpleclient-bridge</artifactId>
+  <version>1.0.0</version>
 </dependency>
 ```
 
@@ -40,20 +48,29 @@ implementation 'io.prometheus:prometheus-metrics-simpleclient-bridge:1.0.0'
 Then add the following to your code:
 
 ```java
-SimpleclientCollector.builder().register();
+SimpleclientCollector.builder().
+
+register();
 ```
 
-This will make all metrics registered with simpleclient's `CollectorRegistry.defaultRegistry` available in the new `PrometheusRegistry.defaultRegistry`.
+This will make all metrics registered with simpleclient's `CollectorRegistry.defaultRegistry` available in the new
+`PrometheusRegistry.defaultRegistry`.
 
 If you are using custom registries, you can specify them like this:
 
 ```java
 CollectorRegistry simpleclientRegistry = ...;
 PrometheusRegistry prometheusRegistry = ...;
 
-SimpleclientCollector.builder()
-    .collectorRegistry(simpleclientRegistry)
-    .register(prometheusRegistry);
+  SimpleclientCollector.
+
+builder()
+    .
+
+collectorRegistry(simpleclientRegistry)
+    .
+
+register(prometheusRegistry);
 ```
 
 ## Refactoring the Instrumentation Code
@@ -67,20 +84,26 @@ Dependencies:
 - `simpleclient_httpserver` -> `prometheus-metrics-exporter-httpserver`
 - `simpleclient_servlet_jakarta` -> `prometheus-metrics-exporter-servlet-jakarta`
 
-As long as you are using high-level metric API like `Counter`, `Gauge`, `Histogram`, and `Summary` converting code to the new API is relatively straightforward. You will need to adapt the package name and apply some minor changes like using `builder()` instead of `build()` or using `labelValues()` instead of `labels()`.
+As long as you are using high-level metric API like `Counter`, `Gauge`, `Histogram`, and `Summary` converting code to
+the new API is relatively straightforward. You will need to adapt the package name and apply some minor changes like
+using `builder()` instead of `build()` or using `labelValues()` instead of `labels()`.
 
 Example of the old 0.16.0 API:
 
 ```java
 import io.prometheus.client.Counter;
 
 Counter counter = Counter.build()
-        .name("test")
-        .help("test counter")
-        .labelNames("path")
-        .register();
+  .name("test")
+  .help("test counter")
+  .labelNames("path")
+  .register();
 
-counter.labels("/hello-world").inc();
+counter.
+
+labels("/hello-world").
+
+inc();
 ```
 
 Example of the new 1.0.0 API:
@@ -89,17 +112,27 @@ Example of the new 1.0.0 API:
 import io.prometheus.metrics.core.metrics.Counter;
 
 Counter counter = Counter.builder()
-        .name("test")
-        .help("test counter")
-        .labelNames("path")
-        .register();
+  .name("test")
+  .help("test counter")
+  .labelNames("path")
+  .register();
+
+counter.
 
-counter.labelValues("/hello-world").inc();
+labelValues("/hello-world").
+
+inc();
 ```
 
-Reasons why we changed the API: Changing the package names was a necessity because the previous package names were incompatible with the Java module system. However, renaming packages requires changing code anyway, so we decided to clean up some things. For example, the name `builder()` for a builder method is very common in the Java ecosystem, it's used in Spring, Lombok, and so on. So naming the method `builder()` makes the Prometheus library more aligned with the broader Java ecosystem.
+Reasons why we changed the API: Changing the package names was a necessity because the previous package names were
+incompatible with the Java module system. However, renaming packages requires changing code anyway, so we decided to
+clean up some things. For example, the name `builder()` for a builder method is very common in the Java ecosystem, it's
+used in Spring, Lombok, and so on. So naming the method `builder()` makes the Prometheus library more aligned with the
+broader Java ecosystem.
 
-If you are using the low level `Collector` API directly, you should have a look at the new callback metric types, see [/getting-started/callbacks/](../../getting-started/callbacks/). Chances are good that the new callback metrics have an easier way to achieve what you need than the old 0.16.0 code.
+If you are using the low level `Collector` API directly, you should have a look at the new callback metric types,
+see [/getting-started/callbacks/](../../getting-started/callbacks/). Chances are good that the new callback metrics have
+an easier way to achieve what you need than the old 0.16.0 code.
 
 ## JVM Metrics
 
@@ -113,7 +146,9 @@ With version 1.0.0 these metrics moved to the `prometheus-metrics-instrumentatio
 are initialized as follows:
 
 ```java
-JvmMetrics.builder().register();
+JvmMetrics.builder().
+
+register();
 ```
 
 A full list of the available JVM metrics can be found