commit	0fca5b4efedba0809ceb35df2a8675d02f60241b	[log] [tgz]
author	Roy Teeuwen <royteeuwen@apache.org>	Wed Aug 07 17:39:28 2024 +0200
committer	Roy Teeuwen <royteeuwen@apache.org>	Wed Aug 07 17:39:28 2024 +0200
tree	53029efdf4c729fbee72ee9ea11a2dc5daa0a062
parent	69838139a83745de55d902e7c25bfd08d6985c1f [diff]

tree: 53029efdf4c729fbee72ee9ea11a2dc5daa0a062

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