format

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

Author: zeitlinger

.github/super-linter.env

@@ -5,27 +5,28 @@ JAVA_FILE_NAME=google_checks.xml
 VALIDATE_CHECKOV=false
 VALIDATE_DOCKERFILE_HADOLINT=false
 VALIDATE_GIT_COMMITLINT=false
+# done by maven
+VALIDATE_GOOGLE_JAVA_FORMAT=false
 # times out
 VALIDATE_GO_MODULES=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
 
-FILTER_REGEX_EXCLUDE=src/main/generated/.*|docs/themes/.*
+# FILTER_REGEX_EXCLUDE=src/main/generated/.*|docs/themes/.*
 
 FIX_ENV=true
 FIX_GO=true
-FIX_GOOGLE_JAVA_FORMAT=true
 FIX_JAVASCRIPT_PRETTIER=true
 FIX_JSON=true
 FIX_JSONC=true
 FIX_JSONC_PRETTIER=true
 FIX_JSON_PRETTIER=true
 FIX_MARKDOWN=true
 FIX_MARKDOWN_PRETTIER=true
-FIX_PYTHON_BLACK=true
-FIX_PYTHON_ISORT=true
-FIX_PYTHON_PYINK=true
 FIX_SHELL_SHFMT=true
 FIX_YAML_PRETTIER=true

docs/README.md

@@ -37,7 +37,11 @@ ln -s ../api ./docs/static/client_java/api
 
 ## Update Geekdocs
 
-The docs use the [Geekdocs](https://geekdocs.de/) theme. The theme is checked in to Github in the `./docs/themes/hugo-geekdoc/` folder. To update [Geekdocs](https://geekdocs.de/), remove the current folder and create a new one with the latest [release](https://github.com/thegeeklab/hugo-geekdoc/releases). There are no local modifications in `./docs/themes/hugo-geekdoc/`.
+The docs use the [Geekdocs](https://geekdocs.de/) theme. The theme is checked in to Github in the
+`./docs/themes/hugo-geekdoc/` folder. To update [Geekdocs](https://geekdocs.de/), remove the current
+folder and create a new one with the
+latest [release](https://github.com/thegeeklab/hugo-geekdoc/releases). There are no local
+modifications in `./docs/themes/hugo-geekdoc/`.
 
 ## Notes
 
@@ -50,4 +54,5 @@ 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
 ```
 
-Create the initial `hugo.toml` file as described in [https://geekdocs.de/usage/getting-started/](https://geekdocs.de/usage/getting-started/).
+Create the initial `hugo.toml` file as described
+in [https://geekdocs.de/usage/getting-started/](https://geekdocs.de/usage/getting-started/).

docs/content/_index.md

@@ -8,41 +8,41 @@ The main new features of the 1.0.0 release are:
 
 - **Prometheus native histograms:** Support for the new Prometheus histogram type.
 - **OpenTelemetry Exporter:** Push metrics in OTLP format to an OpenTelemetry endpoint.
-- **Runtime configuration:** Configure metrics, exporters, and more at runtime using a properties 
+- **Runtime configuration:** Configure metrics, exporters, and more at runtime using a properties
   file or system properties.
 
 **Documentation and Examples**
 
-In addition to this documentation page we created an [examples/](https://github.com/prometheus/client_java/tree/main/examples) directory with end-to-end 
+In addition to this documentation page we created an [examples/](https://github.com/prometheus/client_java/tree/main/examples) directory with end-to-end
 scenarios (Docker compose) illustrating new features.
 
 **Performance Benchmarks**
 
-Initial performance benchmarks are looking great: All core metric types (including native 
-histograms) allow concurrent updates, so if you instrument a performance critical Web service 
-that utilizes all processor cores in parallel the metrics library will not introduce additional 
-synchronization. See Javadoc comments in 
+Initial performance benchmarks are looking great: All core metric types (including native
+histograms) allow concurrent updates, so if you instrument a performance critical Web service
+that utilizes all processor cores in parallel the metrics library will not introduce additional
+synchronization. See Javadoc comments in
 [benchmarks/](https://github.com/prometheus/client_java/tree/main/benchmarks) for benchmark results.
 
 **More Info**
 
-The Grafana Labs Blog has a post [Introducing the Prometheus Java Client 1.0.0](https://grafana.com/blog/2023/09/27/introducing-the-prometheus-java-client-1.0.0/) with a 
+The Grafana Labs Blog has a post [Introducing the Prometheus Java Client 1.0.0](https://grafana.com/blog/2023/09/27/introducing-the-prometheus-java-client-1.0.0/) with a
 good overview of the release.
 
-There will also be a presentation at the [PromCon](https://promcon.io) conference on 29 Sep 2023. 
-Tune in to the live stream on [https://promcon.io](https://promcon.io) 
+There will also be a presentation at the [PromCon](https://promcon.io) conference on 29 Sep 2023.
+Tune in to the live stream on [https://promcon.io](https://promcon.io)
 or watch the recording on YouTube.
 
 **For users of the 0.16.0 version and older**
 
-Updating to the 1.0.0 version is a breaking change. However, there's a 
-`prometheus-metrics-simpleclient-bridge` module available that allows you to use your existing 
-simpleclient 0.16.0 metrics with the new 1.0.0 `PrometheusRegistry`. 
-So you don't need to upgrade your instrumentation code, you can keep using your existing metrics. 
+Updating to the 1.0.0 version is a breaking change. However, there's a
+`prometheus-metrics-simpleclient-bridge` module available that allows you to use your existing
+simpleclient 0.16.0 metrics with the new 1.0.0 `PrometheusRegistry`.
+So you don't need to upgrade your instrumentation code, you can keep using your existing metrics.
 See the [compatibility > simpleclient](https://prometheus.github.io/client_java/migration/simpleclient/) in the menu on the left.
 
 The pre 1.0.0 code is now maintained on the [simpleclient](https://github.com/prometheus/client_java/tree/simpleclient) feature branch.
 
-Not all `simpleclient` modules from 0.16.0 are included in the initial 1.0.0 release. 
-Over the next couple of weeks we will work on porting the remaining modules, 
+Not all `simpleclient` modules from 0.16.0 are included in the initial 1.0.0 release.
+Over the next couple of weeks we will work on porting the remaining modules,
 starting with `pushgateway` and the Servlet filter.

docs/content/config/config.md

@@ -18,26 +18,26 @@ Example:
 io.prometheus.exporter.httpServer.port = 9401
 ```
 
-The property above changes the port for the 
+The property above changes the port for the
 [HTTPServer exporter]({{< relref "/exporters/httpserver.md" >}}) to _9401_.
 
 - Properties file: Add the line above to the properties file.
-- System properties: Use the command line parameter `-Dio.prometheus.exporter.httpServer.port=9401` 
+- System properties: Use the command line parameter `-Dio.prometheus.exporter.httpServer.port=9401`
 - when starting your application.
 
 ## Location of the Properties File
 
 The properties file is searched in the following locations:
 
-- `/prometheus.properties` in the classpath. This is for bundling a properties file 
+- `/prometheus.properties` in the classpath. This is for bundling a properties file
   with your application.
 - System property `-Dprometheus.config=/path/to/prometheus.properties`.
 - Environment variable `PROMETHEUS_CONFIG=/path/to/prometheus.properties`.
 
 ## Metrics Properties
 
 | Name                                                      | Javadoc                                                                                                                                                                         | Note    |
-|-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
+| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
 | io.prometheus.metrics.exemplarsEnabled                    | [Counter.Builder.withExemplars()](</client_java/api/io/prometheus/metrics/core/metrics/Counter.Builder.html#withExemplars()>)                                                   | (1) (2) |
 | io.prometheus.metrics.histogramNativeOnly                 | [Histogram.Builder.nativeOnly()](</client_java/api/io/prometheus/metrics/core/metrics/Histogram.Builder.html#nativeOnly()>)                                                     | (2)     |
 | io.prometheus.metrics.histogramClassicOnly                | [Histogram.Builder.classicOnly()](</client_java/api/io/prometheus/metrics/core/metrics/Histogram.Builder.html#classicOnly()>)                                                   | (2)     |
@@ -54,16 +54,16 @@ The properties file is searched in the following locations:
 
 **Notes**
 
-(1) _withExemplars()_ and _withoutExemplars()_ are available for all metric types, 
-    not just for counters<br>
+(1) _withExemplars()_ and _withoutExemplars()_ are available for all metric types,
+not just for counters<br>
 (2) Boolean value. Format: `property=true` or `property=false`.<br>
 (3) Comma-separated list. Example: `.005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10`.<br>
 (4) Comma-separated list. Example: `0.5, 0.95, 0.99`.<br>
-(5) Comma-separated list. If specified, the list must have the same length as 
-    `io.prometheus.metrics.summaryQuantiles`. Example: `0.01, 0.005, 0.005`.
+(5) Comma-separated list. If specified, the list must have the same length as
+`io.prometheus.metrics.summaryQuantiles`. Example: `0.01, 0.005, 0.005`.
 
-There's one special feature about metric properties: You can set a property for one specific 
-metric only by specifying the metric name. Example: 
+There's one special feature about metric properties: You can set a property for one specific
+metric only by specifying the metric name. Example:
 Let's say you have a histogram named `latency_seconds`.
 
 ```
@@ -83,15 +83,15 @@ This works for all Metrics properties.
 ## Exemplar Properties
 
 | Name                                               | Javadoc                                                                                                                                                         | Note |
-|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------|
+| -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exemplars.minRetentionPeriodSeconds  | [ExemplarsProperties.getMinRetentionPeriodSeconds()](</client_java/api/io/prometheus/metrics/config/ExemplarsProperties.html#getMinRetentionPeriodSeconds()>)   |      |
 | io.prometheus.exemplars.maxRetentionPeriodSeconds  | [ExemplarsProperties.getMaxRetentionPeriodSeconds()](</client_java/api/io/prometheus/metrics/config/ExemplarsProperties.html#getMaxRetentionPeriodSeconds()>)   |      |
 | io.prometheus.exemplars.sampleIntervalMilliseconds | [ExemplarsProperties.getSampleIntervalMilliseconds()](</client_java/api/io/prometheus/metrics/config/ExemplarsProperties.html#getSampleIntervalMilliseconds()>) |      |
 
 ## Exporter Properties
 
 | Name                                             | Javadoc                                                                                                                                                     | Note |
-|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|------|
+| ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.includeCreatedTimestamps  | [ExporterProperties.getIncludeCreatedTimestamps()](</client_java/api/io/prometheus/metrics/config/ExporterProperties.html#getIncludeCreatedTimestamps()>)   | (1)  |
 | io.prometheus.exporter.exemplarsOnAllMetricTypes | [ExporterProperties.getExemplarsOnAllMetricTypes()](</client_java/api/io/prometheus/metrics/config/ExporterProperties.html#getExemplarsOnAllMetricTypes()>) | (1)  |
 
@@ -100,7 +100,7 @@ This works for all Metrics properties.
 ## Exporter Filter Properties
 
 | Name                                                     | Javadoc                                                                                                                                                                   | Note |
-|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|
+| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.filter.metricNameMustBeEqualTo    | [ExporterFilterProperties.getAllowedMetricNames()](</client_java/api/io/prometheus/metrics/config/ExporterFilterProperties.html#getAllowedMetricNames()>)                 | (1)  |
 | io.prometheus.exporter.filter.metricNameMustNotBeEqualTo | [ExporterFilterProperties.getExcludedMetricNames()](</client_java/api/io/prometheus/metrics/config/ExporterFilterProperties.html#getExcludedMetricNames()>)               | (2)  |
 | io.prometheus.exporter.filter.metricNameMustStartWith    | [ExporterFilterProperties.getAllowedMetricNamePrefixes()](</client_java/api/io/prometheus/metrics/config/ExporterFilterProperties.html#getAllowedMetricNamePrefixes()>)   | (3)  |
@@ -114,13 +114,13 @@ This works for all Metrics properties.
 ## Exporter HTTPServer Properties
 
 | Name                                   | Javadoc                                                                                                                     | Note |
-|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|------|
+| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.httpServer.port | [HTTPServer.Builder.port()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#port(int)>) |      |
 
 ## Exporter OpenTelemetry Properties
 
 | Name                                                    | Javadoc                                                                                                                                                                                                       | Note |
-|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|
+| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.opentelemetry.protocol           | [OpenTelemetryExporter.Builder.protocol()](</client_java/api/io/prometheus/metrics/exporter/opentelemetry/OpenTelemetryExporter.Builder.html#protocol(java.lang.String)>)                                     | (1)  |
 | io.prometheus.exporter.opentelemetry.endpoint           | [OpenTelemetryExporter.Builder.endpoint()](</client_java/api/io/prometheus/metrics/exporter/opentelemetry/OpenTelemetryExporter.Builder.html#endpoint(java.lang.String)>)                                     |      |
 | io.prometheus.exporter.opentelemetry.headers            | [OpenTelemetryExporter.Builder.headers()](</client_java/api/io/prometheus/metrics/exporter/opentelemetry/OpenTelemetryExporter.Builder.html#header(java.lang.String,java.lang.String)>)                       | (2)  |
@@ -136,15 +136,15 @@ This works for all Metrics properties.
 (2) Format: `key1=value1,key2=value2`<br>
 (3) Format: `key1=value1,key2=value2`
 
-Many of these attributes can alternatively be configured via OpenTelemetry environment variables, 
-like `OTEL_EXPORTER_OTLP_ENDPOINT`. 
-The Prometheus metrics library has support for OpenTelemetry environment variables. 
+Many of these attributes can alternatively be configured via OpenTelemetry environment variables,
+like `OTEL_EXPORTER_OTLP_ENDPOINT`.
+The Prometheus metrics library has support for OpenTelemetry environment variables.
 See Javadoc for details.
 
 ## Exporter PushGateway Properties
 
 | Name                                       | Javadoc                                                                                                                                           | Note |
-|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|------|
+| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.pushgateway.address | [PushGateway.Builder.address()](</client_java/api/io/prometheus/metrics/exporter/pushgateway/PushGateway.Builder.html#address(java.lang.String)>) |      |
 | io.prometheus.exporter.pushgateway.scheme  | [PushGateway.Builder.scheme()](</client_java/api/io/prometheus/metrics/exporter/pushgateway/PushGateway.Builder.html#scheme(java.lang.String)>)   |      |
 | io.prometheus.exporter.pushgateway.job     | [PushGateway.Builder.job()](</client_java/api/io/prometheus/metrics/exporter/pushgateway/PushGateway.Builder.html#job(java.lang.String)>)         |      |

docs/content/exporters/filter.md

@@ -6,10 +6,10 @@ weight: 2
 All exporters support a `name[]` URL parameter for querying only specific metric names. Examples:
 
 - `/metrics?name[]=jvm_threads_current` will query the metric named `jvm_threads_current`.
-- `/metrics?name[]=jvm_threads_current&name[]=jvm_threads_daemon` will query two metrics, 
+- `/metrics?name[]=jvm_threads_current&name[]=jvm_threads_daemon` will query two metrics,
   `jvm_threads_current` and `jvm_threads_daemon`.
 
-Add the following to the scape job configuration in `prometheus.yml` 
+Add the following to the scape job configuration in `prometheus.yml`
 to make the Prometheus server send the `name[]` parameter:
 
 ```yaml

docs/content/exporters/httpserver.md

@@ -3,7 +3,7 @@ title: HTTPServer
 weight: 3
 ---
 
-The `HTTPServer` is a standalone server for exposing a metric endpoint. A minimal example 
+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.
 
 ```java
@@ -12,7 +12,7 @@ HTTPServer server = HTTPServer.builder()
     .buildAndStart();
 ```
 
-By default, `HTTPServer` binds to any IP address, you can change this with 
+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)>).
 
 `HTTPServer` is configured with three endpoints: