Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Shutdown MetricsSystem when stopping MetricsService #7958

Merged
merged 1 commit into from
Nov 28, 2024
Merged

Shutdown MetricsSystem when stopping MetricsService #7958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
package org.hyperledger.besu.metrics;

import org.hyperledger.besu.metrics.opentelemetry.MetricsOtelPushService;
import org.hyperledger.besu.metrics.opentelemetry.OpenTelemetrySystem;
import org.hyperledger.besu.metrics.prometheus.MetricsConfiguration;
import org.hyperledger.besu.metrics.prometheus.MetricsHttpService;
import org.hyperledger.besu.metrics.prometheus.MetricsPushGatewayService;
Expand Down Expand Up @@ -48,13 +49,14 @@ static Optional<MetricsService> create(
return Optional.of(
new MetricsHttpService(configuration, (PrometheusMetricsSystem) metricsSystem));
} else if (configuration.isPushEnabled()) {
return Optional.of(new MetricsPushGatewayService(configuration, metricsSystem));
return Optional.of(
new MetricsPushGatewayService(configuration, (PrometheusMetricsSystem) metricsSystem));
} else {
return Optional.empty();
}
} else if (configuration.getProtocol() == MetricsProtocol.OPENTELEMETRY) {
if (configuration.isEnabled()) {
return Optional.of(new MetricsOtelPushService());
return Optional.of(new MetricsOtelPushService((OpenTelemetrySystem) metricsSystem));
} else {
return Optional.empty();
}
Expand Down
14 changes: 11 additions & 3 deletions ...core/src/main/java/org/hyperledger/besu/metrics/opentelemetry/MetricsOtelPushService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,16 @@
public class MetricsOtelPushService implements MetricsService {

private static final Logger LOG = LoggerFactory.getLogger(MetricsOtelPushService.class);

/** Instantiates a new Metrics open telemetry push service. */
public MetricsOtelPushService() {}
private final OpenTelemetrySystem metricsSystem;

/**
* Instantiates a new Metrics open telemetry push service.
*
* @param metricsSystem The OpenTelemetry metrics system
*/
public MetricsOtelPushService(final OpenTelemetrySystem metricsSystem) {
this.metricsSystem = metricsSystem;
}

@Override
public CompletableFuture<?> start() {
Expand All @@ -39,6 +46,7 @@ public CompletableFuture<?> start() {

@Override
public CompletableFuture<?> stop() {
metricsSystem.shutdown();
return CompletableFuture.completedFuture(null);
}

Expand Down
1 change: 1 addition & 0 deletions metrics/core/src/main/java/org/hyperledger/besu/metrics/prometheus/MetricsHttpService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ private boolean hostIsInAllowlist(final String hostHeader) {

@Override
public CompletableFuture<?> stop() {
metricsSystem.shutdown();
if (httpServer == null) {
return CompletableFuture.completedFuture(null);
}
Expand Down
11 changes: 4 additions & 7 deletions ...core/src/main/java/org/hyperledger/besu/metrics/prometheus/MetricsPushGatewayService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
import static com.google.common.base.Preconditions.checkArgument;

import org.hyperledger.besu.metrics.MetricsService;
import org.hyperledger.besu.plugin.services.MetricsSystem;

import java.io.IOException;
import java.util.Optional;
Expand All @@ -37,7 +36,7 @@ public class MetricsPushGatewayService implements MetricsService {
private PushGateway pushGateway;
private ScheduledExecutorService scheduledExecutorService;
private final MetricsConfiguration config;
private final MetricsSystem metricsSystem;
private final PrometheusMetricsSystem metricsSystem;

/**
* Instantiates a new Metrics push gateway service.
Expand All @@ -46,7 +45,7 @@ public class MetricsPushGatewayService implements MetricsService {
* @param metricsSystem the metrics system
*/
public MetricsPushGatewayService(
final MetricsConfiguration configuration, final MetricsSystem metricsSystem) {
final MetricsConfiguration configuration, final PrometheusMetricsSystem metricsSystem) {
this.metricsSystem = metricsSystem;
validateConfig(configuration);
config = configuration;
Expand All @@ -59,9 +58,6 @@ private void validateConfig(final MetricsConfiguration config) {
checkArgument(
!(config.isEnabled() && config.isPushEnabled()),
"Metrics Push Gateway Service cannot run concurrent with the normal metrics.");
checkArgument(
metricsSystem instanceof PrometheusMetricsSystem,
"Push Gateway requires a Prometheus Metrics System.");
}

@Override
Expand All @@ -73,7 +69,7 @@ public CompletableFuture<?> start() {

pushGateway =
PushGateway.builder()
.registry(((PrometheusMetricsSystem) metricsSystem).getRegistry())
.registry(metricsSystem.getRegistry())
.address(config.getPushHost() + ":" + config.getPushPort())
.job(config.getPrometheusJob())
.build();
Expand All @@ -90,6 +86,7 @@ public CompletableFuture<?> start() {

@Override
public CompletableFuture<?> stop() {
metricsSystem.shutdown();
final CompletableFuture<?> resultFuture = new CompletableFuture<>();
try {
// Calling shutdown now cancels the pending push, which is desirable.
Expand Down