Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

Fix broken metrics endpoint (#1818)

Rich Turner998904da5c04
diff --git a/gradle.properties b/gradle.properties
index 89c3a78b5..4ffeb1d60 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -62,7 +62,7 @@ releasesRepoUrl=https://s01.oss.sonatype.org/service/local/
activeMQVersion = 2.40.0
jbossLoggingManagerVersion=2.1.19.Final
greenmailVersion=2.1.2
-prometheusVersion=0.16.0
+prometheusVersion=1.3.6
micrometerVersion=1.14.5
jdomVersion = 2.0.6.1
jSchVersion = 0.2.24
diff --git a/manager/build.gradle b/manager/build.gradle
index 807058c9e..5f708ac08 100644
--- a/manager/build.gradle
+++ b/manager/build.gradle
@@ -51,7 +51,7 @@ dependencies {
}
implementation "org.shredzone.commons:commons-suncalc:$suncalcVersion"
- implementation "io.prometheus:simpleclient_httpserver:$prometheusVersion"
+ implementation "io.prometheus:prometheus-metrics-exporter-httpserver:$prometheusVersion"
implementation "com.github.mwiede:jsch:$jSchVersion"
}
diff --git a/manager/src/main/java/org/openremote/manager/system/HealthService.java b/manager/src/main/java/org/openremote/manager/system/HealthService.java
index f4e482049..371137bbe 100644
--- a/manager/src/main/java/org/openremote/manager/system/HealthService.java
+++ b/manager/src/main/java/org/openremote/manager/system/HealthService.java
@@ -19,8 +19,8 @@
*/
package org.openremote.manager.system;
-import io.prometheus.client.exporter.HTTPServer;
-import org.openremote.container.message.MessageBrokerService;
+import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
+import io.prometheus.metrics.exporter.httpserver.HTTPServer;
import org.openremote.container.util.MapAccess;
import org.openremote.manager.web.ManagerWebService;
import org.openremote.model.Container;
@@ -82,16 +82,20 @@ public class HealthService implements ContainerService {
if (metricsEnabled) {
- MessageBrokerService brokerService = container.getService(MessageBrokerService.class);
int metricsPort = MapAccess.getInteger(container.getConfig(), OR_METRICS_PORT, OR_METRICS_PORT_DEFAULT);
LOG.log(System.Logger.Level.INFO, "Metrics collection enabled");
- // Add additional web server for metrics (this keeps CI/CD prometheus scraper config simple with no oauth
- // this port can be exposed to the host but not to the public
- metricsServer = new HTTPServer.Builder()
- .withPort(metricsPort)
- .withExecutorService(container.getExecutor())
- .build();
+ if (container.getMeterRegistry() instanceof PrometheusMeterRegistry prometheusMeterRegistry) {
+ // Add additional web server for metrics (this keeps CI/CD prometheus scraper config simple with no oauth
+ // this port can be exposed to the host but not to the public
+ metricsServer = HTTPServer.builder()
+ .port(metricsPort)
+ .registry(prometheusMeterRegistry.getPrometheusRegistry())
+ .executorService(container.getExecutor())
+ .buildAndStart();
+ } else {
+ throw new IllegalStateException("Unknown metrics meter registry implementation: " + container.getMeterRegistry().getClass());
+ }
// Alternative servlet option to run on existing undertow but would require oauth on prometheus scraper
// DeploymentInfo prometheusServlet = Servlets.deployment()
diff --git a/test/src/test/groovy/org/openremote/test/metrics/MetricsEndpointTest.groovy b/test/src/test/groovy/org/openremote/test/metrics/MetricsEndpointTest.groovy
new file mode 100644
index 000000000..9ec60eca6
--- /dev/null
+++ b/test/src/test/groovy/org/openremote/test/metrics/MetricsEndpointTest.groovy
@@ -0,0 +1,41 @@
+package org.openremote.test.metrics
+
+
+import org.openremote.manager.system.HealthService
+import org.openremote.model.Container
+import org.openremote.test.ManagerContainerTrait
+import spock.lang.Specification
+import spock.util.concurrent.PollingConditions
+
+import static org.openremote.model.Constants.MASTER_REALM
+
+class MetricsEndpointTest extends Specification implements ManagerContainerTrait {
+
+ def "Test metrics endpoint existence and content"() {
+
+ given: "expected conditions"
+ def conditions = new PollingConditions(timeout: 10, delay: 0.2)
+
+ and: "the container is started"
+ def container = startContainer(defaultConfig() << [(Container.OR_METRICS_ENABLED): "true"], defaultServices())
+
+ and: "a resource client is created"
+ // Resteasy client has issues with @Suspended annotation so not used for now
+ //def datapointResource = getClientApiTarget(serverUri(serverPort), MASTER_REALM, accessToken).proxy(AssetDatapointResource.class)
+ def requestTarget = getClientTarget(serverUri(HealthService.OR_METRICS_PORT_DEFAULT).path("metrics"), MASTER_REALM)
+
+ when: "requesting the metrics endpoint"
+ def response = requestTarget.request().get()
+
+ then: "the response should contain metrics data"
+ response.getStatus() == 200
+ def responseStr = response.readEntity(String.class)
+ responseStr.contains("executor_pool_core_threads{name=\"ContainerExecutor\"}")
+
+ cleanup: "clean up"
+ if (response != null) {
+ response.close()
+ }
+ }
+
+}