markdown

zeitlinger · zeitlinger · commit bef4f8d50141 · 2025-04-29T17:30:34.000+02:00
Signed-off-by: Gregor Zeitlinger &lt;gregor.zeitlinger@grafana.com&gt;
diff --git a/benchmarks/README.md b/benchmarks/README.md
@@ -1,14 +1,14 @@
-## Benchmarks
+# Benchmarks
 
 ## How to Run
 
-```
+```shell
 java -jar ./benchmarks/target/benchmarks.jar
 ```
 
 Run only one specific benchmark:
 
-```
+```shell
 java -jar ./benchmarks/target/benchmarks.jar CounterBenchmark
 ```
 
diff --git a/docs/content/config/config.md b/docs/content/config/config.md
@@ -14,7 +14,7 @@ Future releases will add more options, like configuration via environment variab
 
 Example:
 
-```
+```properties
 io.prometheus.exporter.httpServer.port = 9401
 ```
 
@@ -66,13 +66,13 @@ There's one special feature about metric properties: You can set a property for
 metric only by specifying the metric name. Example:
 Let's say you have a histogram named `latency_seconds`.
 
-```
+```properties
 io.prometheus.metrics.histogramClassicUpperBounds = 0.2, 0.4, 0.8, 1.0
 ```
 
 The line above sets histogram buckets for all histograms. However:
 
-```
+```properties
 io.prometheus.metrics.latency_seconds.histogramClassicUpperBounds = 0.2, 0.4, 0.8, 1.0
 ```
 
diff --git a/docs/content/exporters/pushgateway.md b/docs/content/exporters/pushgateway.md
@@ -14,7 +14,7 @@ The [PushGateway](/client_java/api/io/prometheus/metrics/exporter/pushgateway/Pu
 {{< tabs "uniqueid" >}}
 {{< tab "Gradle" >}}
 
-```
+```groovy
 implementation 'io.prometheus:prometheus-metrics-core:1.3.0'
 implementation 'io.prometheus:prometheus-metrics-exporter-pushgateway:1.3.0'
 ```
diff --git a/docs/content/getting-started/callbacks.md b/docs/content/getting-started/callbacks.md
@@ -29,7 +29,7 @@ GaugeWithCallback.builder()
 
 The resulting text format looks like this:
 
-```
+```text
 # TYPE cache_size_bytes gauge
 # UNIT cache_size_bytes bytes
 # HELP cache_size_bytes Size of the cache in Bytes.
diff --git a/docs/content/getting-started/labels.md b/docs/content/getting-started/labels.md
@@ -5,7 +5,7 @@ weight: 3
 
 The following shows an example of a Prometheus metric in text format:
 
-```
+```text
 # HELP payments_total total number of payments
 # TYPE payments_total counter
 payments_total{status="error",type="paypal"} 1.0
@@ -88,7 +88,7 @@ counter.labelValues("paypal", "error").inc();
 
 The data point
 
-```
+```text
 payments_total{status="error",type="paypal"} 1.0
 ```
 
@@ -112,7 +112,7 @@ counter.initLabelValues("paypal", "error");
 
 Now the four combinations will be visible from the start with initial value zero.
 
-```
+```text
 # HELP payments_total total number of payments
 # TYPE payments_total counter
 payments_total{status="error",type="credit card"} 0.0
diff --git a/docs/content/getting-started/metric-types.md b/docs/content/getting-started/metric-types.md
@@ -223,7 +223,7 @@ info.setLabelValues(version, vendor, runtime);
 
 The info above looks as follows in OpenMetrics text format:
 
-```
+```text
 # TYPE jvm_runtime info
 # HELP jvm_runtime JVM runtime info
 jvm_runtime_info{runtime="OpenJDK Runtime Environment",vendor="Oracle Corporation",version="1.8.0_382-b05"} 1
@@ -255,7 +255,7 @@ stateSet.labelValues("dev").setTrue("feature2");
 
 The OpenMetrics text format looks like this:
 
-```
+```text
 # TYPE feature_flags stateset
 # HELP feature_flags Feature flags
 feature_flags{env="dev",feature_flags="feature1"} 0
diff --git a/docs/content/getting-started/multi-target.md b/docs/content/getting-started/multi-target.md
@@ -90,7 +90,7 @@ public interface PrometheusScrapeRequest {
 
 Sample Prometheus scrape_config
 
-```
+```yaml
   - job_name: "multi-target"
 
     # metrics_path defaults to '/metrics'
diff --git a/docs/content/getting-started/quickstart.md b/docs/content/getting-started/quickstart.md
@@ -18,7 +18,7 @@ We use the following dependencies:
   {{< tabs "deps" >}}
   {{< tab "Gradle" >}}
 
-```
+```groovy
 implementation 'io.prometheus:prometheus-metrics-core:$version'
 implementation 'io.prometheus:prometheus-metrics-instrumentation-jvm:$version'
 implementation 'io.prometheus:prometheus-metrics-exporter-httpserver:$version'
@@ -188,7 +188,7 @@ Run the application and view [http://localhost:9400/metrics](http://localhost:94
 your browser to see the raw metrics. You should see the `my_count_total` metric as shown below plus
 the `jvm_` and `process_` metrics coming from `JvmMetrics`.
 
-```
+```text
 # HELP my_count_total example counter
 # TYPE my_count_total counter
 my_count_total{status="error"} 1.0
diff --git a/docs/content/instrumentation/caffeine.md b/docs/content/instrumentation/caffeine.md
@@ -9,7 +9,7 @@ provided by caffeine `Cache` objects into prometheus metrics.
 {{< tabs "uniqueid" >}}
 {{< tab "Gradle" >}}
 
-```
+```groovy
 implementation 'io.prometheus:prometheus-metrics-instrumentation-caffeine:1.3.2'
 ```
 
@@ -56,7 +56,7 @@ All example metrics on this page will use the `mycache` label value.
 
 For all cache instances, the following metrics will be available:
 
-```
+```text
 # TYPE caffeine_cache_hit counter
 # HELP caffeine_cache_hit Cache hit totals
 caffeine_cache_hit_total{cache="mycache"} 10.0
@@ -80,7 +80,7 @@ If the cache is an instance of `LoadingCache`, i.e. it is built with a `loader`
 managed by the cache library, then metrics for observing load time and load failures become
 available:
 
-```
+```text
 # TYPE caffeine_cache_load_failure counter
 # HELP caffeine_cache_load_failure Cache load failures
 caffeine_cache_load_failure_total{cache="mycache"} 10.0
@@ -97,7 +97,7 @@ caffeine_cache_load_duration_seconds_sum{cache="mycache"} 0.0034
 
 Two metrics exist for observability specifically of caches that define a `weigher`:
 
-```
+```text
 # TYPE caffeine_cache_eviction_weight counter
 # HELP caffeine_cache_eviction_weight Weight of evicted cache entries, doesn't include manually removed entries
 caffeine_cache_eviction_weight_total{cache="mycache"} 5.0
diff --git a/docs/content/instrumentation/guava.md b/docs/content/instrumentation/guava.md
@@ -9,7 +9,7 @@ provided by Guava `Cache` objects into prometheus metrics.
 {{< tabs "uniqueid" >}}
 {{< tab "Gradle" >}}
 
-```
+```groovy
 implementation 'io.prometheus:prometheus-metrics-instrumentation-guava:1.3.2'
 ```
 
@@ -49,7 +49,7 @@ All example metrics on this page will use the `mycache` label value.
 
 For all cache instances, the following metrics will be available:
 
-```
+```text
 # TYPE guava_cache_hit counter
 # HELP guava_cache_hit Cache hit totals
 guava_cache_hit_total{cache="mycache"} 10.0
@@ -73,7 +73,7 @@ If the cache is an instance of `LoadingCache`, i.e. it is built with a `loader`
 managed by the cache library, then metrics for observing load time and load failures become
 available:
 
-```
+```text
 # TYPE guava_cache_load_failure counter
 # HELP guava_cache_load_failure Cache load failures
 guava_cache_load_failure_total{cache="mycache"} 10.0
diff --git a/docs/content/instrumentation/jvm.md b/docs/content/instrumentation/jvm.md
@@ -9,7 +9,7 @@ it, add the following dependency:
 {{< tabs "uniqueid" >}}
 {{< tab "Gradle" >}}
 
-```
+```groovy
 implementation 'io.prometheus:prometheus-metrics-instrumentation-jvm:1.0.0'
 ```
 
@@ -49,7 +49,7 @@ class. The data is coming from
 the [BufferPoolMXBean](https://docs.oracle.com/en/java/javase/21/docs/api/java.management/java/lang/management/BufferPoolMXBean.html).
 Example metrics:
 
-```
+```text
 # HELP jvm_buffer_pool_capacity_bytes Bytes capacity of a given JVM buffer pool.
 # TYPE jvm_buffer_pool_capacity_bytes gauge
 jvm_buffer_pool_capacity_bytes{pool="direct"} 8192.0
@@ -72,7 +72,7 @@ class. The data is coming from
 the [ClassLoadingMXBean](https://docs.oracle.com/en/java/javase/21/docs/api/java.management/java/lang/management/ClassLoadingMXBean.html).
 Example metrics:
 
-```
+```text
 # HELP jvm_classes_currently_loaded The number of classes that are currently loaded in the JVM
 # TYPE jvm_classes_currently_loaded gauge
 jvm_classes_currently_loaded 1109.0
@@ -92,7 +92,7 @@ class. The data is coming from
 the [CompilationMXBean](https://docs.oracle.com/en/java/javase/21/docs/api/java.management/java/lang/management/CompilationMXBean.html).
 Example metrics:
 
-```
+```text
 # HELP jvm_compilation_time_seconds_total The total time in seconds taken for HotSpot class compilation
 # TYPE jvm_compilation_time_seconds_total counter
 jvm_compilation_time_seconds_total 0.152
@@ -106,7 +106,7 @@ class. The data is coming from
 the [GarbageCollectorMXBean](https://docs.oracle.com/en/java/javase/21/docs/api/java.management/java/lang/management/GarbageCollectorMXBean.html).
 Example metrics:
 
-```
+```text
 # HELP jvm_gc_collection_seconds Time spent in a given JVM garbage collector in seconds.
 # TYPE jvm_gc_collection_seconds summary
 jvm_gc_collection_seconds_count{gc="PS MarkSweep"} 0
@@ -125,7 +125,7 @@ and
 the [MemoryPoolMXBean](https://docs.oracle.com/en/java/javase/21/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html).
 Example metrics:
 
-```
+```text
 # HELP jvm_memory_committed_bytes Committed (bytes) of a given JVM memory area.
 # TYPE jvm_memory_committed_bytes gauge
 jvm_memory_committed_bytes{area="heap"} 4.98597888E8
@@ -209,7 +209,7 @@ to
 the [GarbageCollectorMXBean](https://docs.oracle.com/en/java/javase/21/docs/api/java.management/java/lang/management/GarbageCollectorMXBean.html).
 Example metrics:
 
-```
+```text
 # HELP jvm_memory_pool_allocated_bytes_total Total bytes allocated in a given JVM memory pool. Only updated after GC, not continuously.
 # TYPE jvm_memory_pool_allocated_bytes_total counter
 jvm_memory_pool_allocated_bytes_total{pool="Code Cache"} 4336448.0
@@ -227,7 +227,7 @@ the [JvmRuntimeInfoMetric](/client_java/api/io/prometheus/metrics/instrumentatio
 class. The data is obtained via system properties and will not change throughout the lifetime of the
 application. Example metric:
 
-```
+```text
 # TYPE jvm_runtime info
 # HELP jvm_runtime JVM runtime info
 jvm_runtime_info{runtime="OpenJDK Runtime Environment",vendor="Oracle Corporation",version="1.8.0_382-b05"} 1
@@ -241,7 +241,7 @@ class. The data is coming from
 the [ThreadMXBean](https://docs.oracle.com/en/java/javase/21/docs/api/java.management/java/lang/management/ThreadMXBean.html).
 Example metrics:
 
-```
+```text
 # HELP jvm_threads_current Current thread count of a JVM
 # TYPE jvm_threads_current gauge
 jvm_threads_current 10.0
@@ -285,7 +285,7 @@ in the
 Prometheus [writing client libraries](https://prometheus.io/docs/instrumenting/writing_clientlibs/#process-metrics)
 documentation. Example metrics:
 
-```
+```text
 # HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
 # TYPE process_cpu_seconds_total counter
 process_cpu_seconds_total 1.63
diff --git a/docs/content/migration/simpleclient.md b/docs/content/migration/simpleclient.md
@@ -26,7 +26,7 @@ To use the bridge, add the following dependency:
 {{< tabs "uniqueid" >}}
 {{< tab "Gradle" >}}
 
-```
+```groovy
 implementation 'io.prometheus:prometheus-metrics-simpleclient-bridge:1.0.0'
 ```
 
@@ -48,9 +48,7 @@ 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
@@ -62,15 +60,7 @@ If you are using custom registries, you can specify them like this:
 CollectorRegistry simpleclientRegistry = ...;
 PrometheusRegistry prometheusRegistry = ...;
 
-  SimpleclientCollector.
-
-builder()
-    .
-
-collectorRegistry(simpleclientRegistry)
-    .
-
-register(prometheusRegistry);
+SimpleclientCollector.builder().collectorRegistry(simpleclientRegistry).register(prometheusRegistry);
 ```
 
 ## Refactoring the Instrumentation Code
@@ -99,11 +89,7 @@ Counter counter = Counter.build()
   .labelNames("path")
   .register();
 
-counter.
-
-labels("/hello-world").
-
-inc();
+counter.labels("/hello-world").inc();
 ```
 
 Example of the new 1.0.0 API:
@@ -117,11 +103,7 @@ Counter counter = Counter.builder()
   .labelNames("path")
   .register();
 
-counter.
-
-labelValues("/hello-world").
-
-inc();
+counter.labelValues("/hello-world").inc();
 ```
 
 Reasons why we changed the API: Changing the package names was a necessity because the previous package names were
@@ -146,9 +128,7 @@ 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
diff --git a/docs/content/otel/otlp.md b/docs/content/otel/otlp.md
@@ -13,7 +13,7 @@ To implement this, you need to include `prometheus-metrics-exporter` as a depend
 {{< tabs "uniqueid" >}}
 {{< tab "Gradle" >}}
 
-```
+```groovy
 implementation 'io.prometheus:prometheus-metrics-exporter-opentelemetry:1.0.0'
 ```
 
diff --git a/examples/example-exemplars-tail-sampling/README.md b/examples/example-exemplars-tail-sampling/README.md
@@ -7,7 +7,7 @@ series.
 Exemplars are often used to reference trace IDs when distributed tracing is used.
 The following shows an example of a histogram in OpenMetrics text format where each non-empty bucket has an Exemplar:
 
-```
+```text
 # TYPE request_duration_seconds histogram
 # UNIT request_duration_seconds seconds
 # HELP request_duration_seconds request duration in seconds
diff --git a/examples/example-exporter-httpserver/README.md b/examples/example-exporter-httpserver/README.md
diff --git a/examples/example-exporter-multi-target/README.md b/examples/example-exporter-multi-target/README.md
diff --git a/examples/example-exporter-opentelemetry/README.md b/examples/example-exporter-opentelemetry/README.md
diff --git a/examples/example-exporter-servlet-tomcat/README.md b/examples/example-exporter-servlet-tomcat/README.md
diff --git a/examples/example-native-histogram/README.md b/examples/example-native-histogram/README.md
diff --git a/examples/example-prometheus-properties/README.md b/examples/example-prometheus-properties/README.md
diff --git a/examples/example-simpleclient-bridge/README.md b/examples/example-simpleclient-bridge/README.md
