io.quarkus.micrometer.runtime.config.MPMetricsConfigGroup Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of quarkus-micrometer Show documentation

Instrument the runtime and your application with dimensional metrics using Micrometer.

There is a newer version: 3.15.0

package io.quarkus.micrometer.runtime.config;

import java.util.Optional;

import io.quarkus.runtime.annotations.ConfigGroup;
import io.quarkus.runtime.annotations.ConfigItem;

/**
 * Build / static runtime config for the Microprofile Metrics Binder
 */
@ConfigGroup
public class MPMetricsConfigGroup implements MicrometerConfig.CapabilityEnabled {
    // @formatter:off
    /**
     * Eclipse MicroProfile Metrics support.
     *
     * Support for MicroProfile Metrics will be enabled if Micrometer
     * support is enabled and the MicroProfile Metrics dependency is present:
     *
     * [source,xml]
     * ----
     * 
     *   org.eclipse.microprofile.metrics
     *   microprofile-metrics-api
     * 
     * ----
     *
     * The Micrometer extension currently provides a compatibility layer that supports the MP Metrics API,
     * but metric names and recorded values will be different.
     * Note that the MP Metrics compatibility layer will move to a different extension in the future.
     *
     * @asciidoclet
     */
    // @formatter:on
    @ConfigItem
    public Optional enabled;

    @Override
    public Optional getEnabled() {
        return enabled;
    }

    @Override
    public String toString() {
        return this.getClass().getSimpleName()
                + "{enabled=" + enabled
                + '}';
    }
}