This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-metrics-prometheus.git
commit 6087ce22ff976ce9d614a749c8259b573fa34346
Author: Robert Munteanu <romb...@apache.org>
AuthorDate: Wed Aug 30 00:48:11 2023 +0200
metrics-prometheus: update documentation
---
README.md | 42 ++++++++++++++++++++++++++++++++++++++++--
1 file changed, 40 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 5e4e417..30deba9 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,48 @@
[](https://sling.apache.org)
-# Apache Sling Commons Metrics Prometheus
+# Apache Sling Commons Prometheus Metrics Exporter
This module is part of the [Apache Sling](https://sling.apache.org) project.
This bundle exposes the collected metrics under the `/metrics` path and
provides the following features:
- exports JVM metrics by default
-- supports multiple `MetricRegistry` instances
\ No newline at end of file
+- supports multiple `MetricRegistry` instances
+
+## Deployment
+
+The bundle is compatible with
[prometheus/client-java](https://github.com/prometheus/client_java/)
+versions up to 0.10.0. Version 0.11.0 introduced a mandatory dependency on
opentelemetry-api,
+which is not a valid OSGi bundle. This was rectified in version 0.16.0, but
unfortunately
+versions >= 0.15.0 depend on version 4.0 of Dropwizard metrics, which is not
supported by the current org.apache.sling.commons.metrics.bundle .
+
+A recommended feature model file for deploying this bundle and additional
dependencies is
+
+```json
+ "bundles": [
+ {
+ "id": "io.prometheus/simpleclient/0.10.0",
+ "start-order": 20
+ },
+ {
+ "id": "io.prometheus/simpleclient_common/0.10.0",
+ "start-order": 20
+ },
+ {
+ "id": "io.prometheus/simpleclient_servlet/0.10.0",
+ "start-order": 20
+ },
+ {
+ "id": "io.prometheus/simpleclient_dropwizard/0.10.0",
+ "start-order": 20
+ },
+ {
+ "id": "io.prometheus/simpleclient_hotspot/0.10.0",
+ "start-order": 20
+ },
+ {
+ "id":
"org.apache.sling/org.apache.sling.commons.metrics.prometheus/1.0-SNAPSHOT",
+ "start-order": 20
+ }
+ ]
+```
\ No newline at end of file
