lint

zeitlinger · zeitlinger · commit 87db322f9a67 · 2025-04-30T11:51:00.000+02:00
Signed-off-by: Gregor Zeitlinger &lt;gregor.zeitlinger@grafana.com&gt;
diff --git a/.editorconfig b/.editorconfig
@@ -1,5 +1,9 @@
 root = true
 
+[*]
+max_line_length = 100
+indent_size = 2
+
 [version-rules.xml]
 max_line_length = 200
 
@@ -10,9 +14,6 @@ max_line_length = 200
 [pom.xml]
 indent_size = 4
 
-[docs/themes/**.*]
-max_line_length = 400
-
-[*]
-max_line_length = 150
-indent_size = 2
+[*.py]
+# checked by black
+indent_size = 4
diff --git a/.github/super-linter.env b/.github/super-linter.env
@@ -18,6 +18,7 @@ VALIDATE_JAVA=false
 VALIDATE_JAVASCRIPT_STANDARD=false
 # we have many duplicate code in our codebase for demo purposes
 VALIDATE_JSCPD=false
+VALIDATE_PYTHON_BLACK=false
 VALIDATE_PYTHON_PYLINT=false
 
 FIX_ENV=true
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -17,7 +17,7 @@ jobs:
         env:
           GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}
         run: |
-          echo "${#GPG_SIGNING_KEY}" | wc -c
+          echo "${#GPG_SIGNING_KEY}"
           echo "${GPG_SIGNING_KEY}" | gpg --batch --import-options import-show --import
       - name: Checkout Plugin Repository
         uses: actions/checkout@v4
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -1,3 +1,5 @@
+# Maintainers
+
 - Fabian Stäber <fabian@fstab.de> @fstab
 - Doug Hoard <doug.hoard@gmail.com> @dhoard
 - Tom Wilkie <tom@grafana.com> @tomwilkie
diff --git a/README.md b/README.md
@@ -2,11 +2,11 @@
 
 [![Build](https://github.com/prometheus/client_java/actions/workflows/build.yml/badge.svg)](https://github.com/prometheus/client_java/actions/workflows/build.yml) <a href="#"><img src="https://img.shields.io/badge/JDK%20compatibility-8+-blue.svg" alt="java 8+"></a> <a href="#"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="Apache 2.0"></a>
 
-# Documentation
+## Documentation
 
 [https://prometheus.github.io/client_java](https://prometheus.github.io/client_java)
 
-# Contributing and community
+## Contributing and community
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) and the [community section](http://prometheus.io/community/)
 of the Prometheus homepage.
@@ -15,11 +15,11 @@ The Prometheus Java community is present on the [CNCF Slack](https://cloud-nativ
 `#prometheus-java`, and we have a fortnightly community call in
 the [Prometheus public calendar](https://prometheus.io/community/).
 
-# Previous Releases
+## Previous Releases
 
 The source code for 0.16.0 and older is on
 the [simpleclient](https://github.com/prometheus/client_java/tree/simpleclient) branch.
 
-# License
+## License
 
 Apache License 2.0, see [LICENSE](LICENSE).
diff --git a/RELEASING.md b/RELEASING.md
@@ -1,4 +1,4 @@
-## Create a Release
+# Create a Release
 
 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".
diff --git a/benchmarks/README.md b/benchmarks/README.md
@@ -22,10 +22,16 @@ See Javadoc of the benchmark classes:
 ## What Prometheus Java client optimizes for
 
 concurrent updates of metrics in multi-threaded applications.
-If your application is single-threaded and uses only one processor core, your application isn't performance critical anyway.
-If your application is designed to use all available processor cores for maximum performance, then you want a metric library that doesn't slow your application down.
-Prometheus client Java metrics support concurrent updates and scrapes. This shows in benchmarks with multiple threads recording data in shared metrics.
+If your application is single-threaded and uses only one processor core, your application isn't
+performance critical anyway.
+If your application is designed to use all available processor cores for maximum performance, then
+you want a metric library that doesn't slow your
+application down.
+Prometheus client Java metrics support concurrent updates and scrapes. This shows in benchmarks with
+multiple threads recording data in shared
+metrics.
 
 ## Archive
 
-The `src/main/archive/` directory contains the old benchmarks from 0.16.0 and earlier. It will be removed as soon as all benchmarks are ported to the 1.0.0 release.
+The `src/main/archive/` directory contains the old benchmarks from 0.16.0 and earlier. It will be
+removed as soon as all benchmarks are ported to the 1.0.0 release.
diff --git a/docs/README.md b/docs/README.md
@@ -1,10 +1,10 @@
-## Docs
+# Docs
 
 This directory contains [hugo](https://gohugo.io) documentation to be published in GitHub pages.
 
 ## Run Locally
 
-```
+```shell
 hugo server -D
 ```
 
@@ -20,7 +20,7 @@ Javadoc are not checked-in to the GitHub repository.
 They are generated on the fly by GitHub Actions when the docs are updated.
 To view locally, run the following:
 
-```
+```shell
 # note that the 'compile' in the following command is necessary for Javadoc to detect the module structure
 ./mvnw clean compile javadoc:javadoc javadoc:aggregate
 rm -r ./docs/static/api
@@ -30,7 +30,7 @@ mv ./target/site/apidocs ./docs/static/api
 GitHub pages are in the `/client_java/` folder, so we link to `/client_java/api` rather than `/api`.
 To make JavaDoc work locally, create a link:
 
-```
+```shell
 mkdir ./docs/static/client_java
 ln -s ../api ./docs/static/client_java/api
 ```
@@ -47,7 +47,7 @@ modifications in `./docs/themes/hugo-geekdoc/`.
 
 Here's how the initial `docs/` folder was set up:
 
-```
+```shell
 hugo new site docs
 cd docs/
 mkdir -p themes/hugo-geekdoc/
diff --git a/docs/content/_index.md b/docs/content/_index.md
@@ -13,7 +13,8 @@ The main new features of the 1.0.0 release are:
 
 **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**
@@ -26,8 +27,9 @@ synchronization. See Javadoc comments in
 
 **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
-good overview of the release.
+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)
diff --git a/docs/content/exporters/spring.md b/docs/content/exporters/spring.md
@@ -26,6 +26,7 @@ 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
+[//]: editorconfig-checker-disable-next-line
 [PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html)
 to expose metrics.
 
@@ -76,6 +77,7 @@ public class DemoApplication {
 ```
 
 The important part are the last three lines: They configure the
+[//]: # editorconfig-checker-disable-next-line
 [PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html)
 to expose metrics on `/metrics`:
 
diff --git a/docs/content/getting-started/quickstart.md b/docs/content/getting-started/quickstart.md
@@ -7,7 +7,7 @@ This tutorial shows the quickest way to get started with the Prometheus Java met
 
 {{< toc >}}
 
-# Dependencies
+## Dependencies
 
 We use the following dependencies:
 
@@ -60,7 +60,7 @@ it from the dependencies.
 
 {{< /hint >}}
 
-# Dependency management
+## Dependency management
 
 A Bill of Material
 ([BOM](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms))
@@ -146,7 +146,7 @@ The following example shows how to import the Prometheus Java metrics BOMs using
 {{< /tab >}}
 {{< /tabs >}}
 
-# Example Application
+## Example Application
 
 ```java
 import io.prometheus.metrics.core.metrics.Counter;
@@ -182,7 +182,7 @@ public class App {
 }
 ```
 
-# Result
+## Result
 
 Run the application and view [http://localhost:9400/metrics](http://localhost:9400/metrics) with
 your browser to see the raw metrics. You should see the `my_count_total` metric as shown below plus
@@ -195,7 +195,7 @@ my_count_total{status="error"} 1.0
 my_count_total{status="ok"} 2.0
 ```
 
-# Prometheus Configuration
+## Prometheus Configuration
 
 To scrape the metrics with a Prometheus server, download the latest Prometheus
 server [release](https://github.com/prometheus/prometheus/releases), and configure the
diff --git a/docs/content/instrumentation/caffeine.md b/docs/content/instrumentation/caffeine.md
@@ -99,7 +99,8 @@ Two metrics exist for observability specifically of caches that define a `weighe
 
 ```text
 # TYPE caffeine_cache_eviction_weight counter
-# HELP caffeine_cache_eviction_weight Weight of evicted cache entries, doesn't include manually removed entries
+# HELP caffeine_cache_eviction_weight Weight of evicted cache entries, doesn't include manually removed entries // editorconfig-checker-disable-line
+
 caffeine_cache_eviction_weight_total{cache="mycache"} 5.0
 # TYPE caffeine_cache_weighted_size gauge
 # HELP caffeine_cache_weighted_size Approximate accumulated weight of cache entries
diff --git a/docs/content/otel/otlp.md b/docs/content/otel/otlp.md
@@ -42,8 +42,7 @@ OpenTelemetryExporter.builder()
 By default, the `OpenTelemetryExporter` will push metrics every 60 seconds to `localhost:4317` using
 `grpc` protocol. You can configure this in code using
 the [OpenTelemetryExporter.Builder](/client_java/api/io/prometheus/metrics/exporter/opentelemetry/OpenTelemetryExporter.Builder.html),
-or at runtime via [
-`io.prometheus.exporter.opentelemetry.*`](../config/config.md#exporter-opentelemetry-properties)
+or at runtime via [`io.prometheus.exporter.opentelemetry.*`](../config/config.md#exporter-opentelemetry-properties)
 properties.
 
 In addition to the Prometheus Java client configuration, the exporter also recognizes standard
diff --git a/docs/content/otel/tracing.md b/docs/content/otel/tracing.md
@@ -3,17 +3,19 @@ title: Tracing
 weight: 2
 ---
 
-OpenTelemetry’s [vision statement](https://github.com/open-telemetry/community/blob/main/mission-vision-values.md)
-says
-that [telemetry should be loosely coupled](https://github.com/open-telemetry/community/blob/main/mission-vision-values.md#telemetry-should-be-loosely-coupled),
+OpenTelemetry’s 
+[vision statement](https://github.com/open-telemetry/community/blob/main/mission-vision-values.md)
+says that
+[//]: editorconfig-checker-disable-next-line
+[telemetry should be loosely coupled](https://github.com/open-telemetry/community/blob/main/mission-vision-values.md#telemetry-should-be-loosely-coupled),
 allowing end users to pick and choose from the pieces they want without having to bring in the rest
 of the project, too. In that spirit, you might choose to instrument your Java application with the
-Prometheus Java client library for metrics, and attach
-the [OpenTelemetry Java agent](https://github.com/open-telemetry/opentelemetry-java-instrumentation/)
+Prometheus Java client library for metrics, and attach the 
+[OpenTelemetry Java agent](https://github.com/open-telemetry/opentelemetry-java-instrumentation/)
 to get distributed tracing.
 
-First, if you attach
-the [OpenTelemetry Java agent](https://github.com/open-telemetry/opentelemetry-java-instrumentation/)
+First, if you attach the
+[OpenTelemetry Java agent](https://github.com/open-telemetry/opentelemetry-java-instrumentation/)
 you might want to turn off OTel's built-in metrics, because otherwise you get metrics from both the
 Prometheus Java client library and the OpenTelemetry agent (technically it's no problem to get both
 metrics, it's just not a common use case).
@@ -51,21 +53,27 @@ Exemplar with the `exemplar="true"` Span attribute.
 
 The sampling policy in the OpenTelemetry collector can be configured to keep traces with this
 attribute. There's no risk that this results in a significant increase in trace data, because new
-Exemplars are only selected every [
-`minRetentionPeriodSeconds`](../../config/config/#exemplar-properties) seconds.
+Exemplars are only selected every
+[`minRetentionPeriodSeconds`](../../config/config/#exemplar-properties) seconds.
 
-Here's an example of how to configure OpenTelemetry'
-s [tail sampling processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/tailsamplingprocessor/)
+Here's an example of how to configure OpenTelemetry's 
+[//]: editorconfig-checker-disable-next-line
+[tail sampling processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/tailsamplingprocessor/)
 to sample all Spans marked with `exemplar="true"`, and then discard 90% of the traces:
 
 ```yaml
 policies:
   [
-    { name: keep-exemplars, type: string_attribute, string_attribute: { key: "exemplar", values: ["true"] } },
+    {
+      name: keep-exemplars,
+      type: string_attribute,
+      string_attribute: { key: "exemplar", values: ["true"] },
+    },
     { name: keep-10-percent, type: probabilistic, probabilistic: { sampling_percentage: 10 } },
   ]
 ```
 
+[//]: editorconfig-checker-disable-next-line
 The [examples/example-exemplar-tail-sampling/](https://github.com/prometheus/client_java/tree/main/examples/example-exemplars-tail-sampling)
 directory has a complete end-to-end example, with a distributed Java application with two services,
 an OpenTelemetry collector, Prometheus, Tempo as a trace database, and Grafana dashboards. Use
diff --git a/examples/example-exemplars-tail-sampling/README.md b/examples/example-exemplars-tail-sampling/README.md
@@ -1,4 +1,4 @@
-## Exemplars with OpenTelemetry's Tail Sampling
+# Exemplars with OpenTelemetry's Tail Sampling
 
 ## Background: What are Exemplars?
 
@@ -124,7 +124,11 @@ processors:
     expected_new_traces_per_sec: 10
     policies:
       [
-        { name: keep-exemplars, type: string_attribute, string_attribute: { key: "exemplar", values: ["true"] } },
+        {
+          name: keep-exemplars,
+          type: string_attribute,
+          string_attribute: { key: "exemplar", values: ["true"] },
+        },
         { name: keep-10-percent, type: probabilistic, probabilistic: { sampling_percentage: 10 } },
       ]
 ```
diff --git a/examples/example-exemplars-tail-sampling/config/otelcol-config.yaml b/examples/example-exemplars-tail-sampling/config/otelcol-config.yaml
@@ -10,7 +10,11 @@ processors:
     expected_new_traces_per_sec: 10
     policies:
       [
-        { name: keep-exemplars, type: string_attribute, string_attribute: { key: "exemplar", values: ["true"] } },
+        {
+          name: keep-exemplars,
+          type: string_attribute,
+          string_attribute: { key: "exemplar", values: ["true"] },
+        },
         { name: keep-10-percent, type: probabilistic, probabilistic: { sampling_percentage: 10 } },
       ]
 
diff --git a/examples/example-exporter-opentelemetry/oats-tests/agent/service_instance_id_check.py b/examples/example-exporter-opentelemetry/oats-tests/agent/service_instance_id_check.py
@@ -8,21 +8,21 @@
 
 URL = " http://localhost:9090/api/v1/query?query=target_info"
 with urlopen(URL) as response:
-  # read the response
-  res = response.read()
-  # decode the response
-  res = res.decode("utf-8")
+    # read the response
+    res = response.read()
+    # decode the response
+    res = res.decode("utf-8")
 
 # uncomment the following line to use the local file instead of the url - for debugging
 # with open('example_target_info.json') as f:
 #   res = json.load(f)
 
 values = list(
-  {
-    r["metric"]["instance"]
-    for r in res["data"]["result"]
-    if not r["metric"]["service_name"] == "otelcol-contrib"
-  }
+    {
+        r["metric"]["instance"]
+        for r in res["data"]["result"]
+        if not r["metric"]["service_name"] == "otelcol-contrib"
+    }
 )
 print(values)
 
@@ -33,10 +33,10 @@
 path = urllib.parse.quote_plus(path)
 URL = f"http://localhost:9090/api/v1/query?query={path}"
 with urlopen(URL) as response:
-  # read the response
-  res = response.read()
-  # decode the response
-  res = res.decode("utf-8")
+    # read the response
+    res = response.read()
+    # decode the response
+    res = res.decode("utf-8")
 
 infos = res["data"]["result"]
 print(infos)
diff --git a/prometheus-metrics-exposition-formats/generate-protobuf.sh b/prometheus-metrics-exposition-formats/generate-protobuf.sh
diff --git a/scripts/build-release.sh b/scripts/build-release.sh
diff --git a/simpleclient-archive/README.md b/simpleclient-archive/README.md

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Maintainers`
	`2`	`+`
`1`	`3`	`- Fabian Stäber <[email protected]> @fstab`
`2`	`4`	`- Doug Hoard <[email protected]> @dhoard`
`3`	`5`	`- Tom Wilkie <[email protected]> @tomwilkie`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## Create a Release`
	`1`	`+# Create a Release`
`2`	`2`
`3`	`3`	`1. Go to <https://github.com/prometheus/client_java/releases/new>`
`4`	`4`	2. Click on "Choose a tag", enter the tag name (e.g. `v0.1.0`), and click "Create a new tag".