commit	a345e768d11a7a8c7ca415b405ef79dd62d6fc50	[log] [tgz]
author	Robert Munteanu <rombert@apache.org>	Wed Aug 06 14:20:02 2025 +0200
committer	Robert Munteanu <rombert@apache.org>	Wed Aug 06 14:20:02 2025 +0200
tree	ca3d26d8ac59d78490c229281729530d091b0833
parent	4a22d48d740d168447059354e069e4b882c041b2 [diff]

tree: ca3d26d8ac59d78490c229281729530d091b0833

README.md

Apache Sling Commons Prometheus Metrics Exporter

This module is part of the Apache Sling 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

Deployment

The bundle is compatible with 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

  "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
    }
  ]