Enable/disable metrics in a custom extension

[Sirz3chs]

I'm actually writing an extension to collect custom logs from endpoints and send them elsewhere with quarkus-rest-client-reactive. I wanted to add the possibility to enable/disable metrics on rest client but i can't figure out how exactly manage the build time.

I just have a simple build time config:

@ConfigRoot(name = "custom-logs", phase = ConfigPhase.BUILD_TIME)
public class CustomLogsBuildTimeConfig {

    @Getter
    @ConfigItem(name = "metrics.enabled", defaultValue = "true")
    protected boolean metricsEnabled;
}

I've started to write this in my processor:

@BuildStep
@Record(ExecutionTime.STATIC_INIT)
void metrics(final CustomLogsBuildTimeConfig config, final Optional<MetricsCapabilityBuildItem> metrics) {
    if (config.metricsEnabled() && metrics.isPresent()) {
        ...
    }
}

I suppose, according to the quarkus documentation, that i'm in the case:
An underlying library used by the extension is using a specific Metrics API directly (either MP Metrics, Micrometer, or some other).

How am i suppose to configure metrics only for my extension ?

[quarkus-bot[bot]]

/cc @ebullient (metrics), @jmartisk (metrics)

[gsmet]

@Sgitario is there a way to enable/disable metrics for the REST Clients (legacy or reactive)? I couldn't find an associated configuration property.

Not sure if it would be a runtime property though and if it would be possible to use RunTimeConfigurationDefaultBuildItem.

[Sgitario]

As far as I can tell, REST Client does not generate metrics that we could enable/disable either in REST Clients (legacy or reactive).

[ebullient]

Yes, there is a client configuration for metrics (reactive and not): quarkus.micrometer.binder.http-client.enabled

quarkus.micrometer.binder.http-client.enabled=false

[ebullient]

For the original poster: enabling/disabling client metrics is a little more complicated for http specifically. Metrics are already collected for REST Client (with micrometer) for Resteasy and Resteasy Reactive... if you're working against the micrometer extension, you might be better off following a pattern like this:

https://github.com/micrometer-metrics/micrometer/blob/main/micrometer-core/src/main/java/io/micrometer/core/instrument/logging/LoggingMeterRegistry.java

Your extension can then focus on enabling or disabling the construction of a custom MeterRegistry bean.

As far as testing for enabled metrics at build time, you'd want to look at a combination of config, you would want to do something akin to this:

quarkus/extensions/micrometer/deployment/src/main/java/io/quarkus/micrometer/deployment/binder/HttpBinderProcessor.java

Line 50 in e4b4aea

static class HttpClientBinderEnabled implements BooleanSupplier {

Here is an example processor that splits to do different things if micrometer is present:

quarkus/extensions/jaeger/deployment/src/main/java/io/quarkus/jaeger/deployment/JaegerProcessor.java

Line 38 in e4b4aea

if (metricsCapability.get().metricsSupported(MetricsFactory.MICROMETER)) {

[Sirz3chs]

Ok, thanks for the explanation, i'll try to implement this in my project