serialized = new HashSet<>();
- registry.stream()
- .sorted(Map.Entry.comparingByKey())
- .forEach(entry -> {
- String name = entry.getKey().getName();
- if (!serialized.contains(name)) {
- toPrometheusData(builder, entry.getKey(), entry.getValue(), true);
- serialized.add(name);
- } else {
- toPrometheusData(builder, entry.getKey(), entry.getValue(), false);
- }
- });
- return builder.toString();
- }
-
- /**
- * Formats a metric in Prometheus format.
- *
- * @param metricID the {@code MetricID} for the metric to be formatted
- * @param metric the {@code Metric} containing the data to be formatted
- * @param withHelpType flag controlling serialization of HELP and TYPE
- * @return metric info in Prometheus format
- */
- public static String toPrometheusData(MetricID metricID, Metric metric, boolean withHelpType) {
- final StringBuilder sb = new StringBuilder();
- checkMetricTypeThenRun(sb, metricID, metric, withHelpType);
- return sb.toString();
- }
-
- /**
- * Formats a metric in Prometheus format.
- *
- * @param name the name of the metric
- * @param metric the {@code Metric} containing the data to be formatted
- * @param withHelpType flag controlling serialization of HELP and TYPE
- * @return metric info in Prometheus format
- */
- public static String toPrometheusData(String name, Metric metric, boolean withHelpType) {
- return toPrometheusData(new MetricID(name), metric, withHelpType);
- }
-
- /**
- * Returns the Prometheus data for the specified {@link Metric}.
- *
- * Not every {@code Metric} supports conversion to Prometheus data. This
- * method checks the metric first before performing the conversion, throwing
- * an {@code IllegalArgumentException} if the metric cannot be converted.
- *
- * @param metricID the {@code MetricID} for the metric to convert
- * @param metric the {@code Metric} to convert to Prometheus format
- * @param withHelpType flag controlling serialization of HELP and TYPE
- */
- static void toPrometheusData(StringBuilder sb, MetricID metricID, Metric metric, boolean withHelpType) {
- checkMetricTypeThenRun(sb, metricID, metric, withHelpType);
- }
-
- private static void checkMetricTypeThenRun(StringBuilder sb, MetricID metricID, Metric metric,
- boolean withHelpType) {
- Objects.requireNonNull(metric);
-
- if (!(metric instanceof HelidonMetric)) {
- throw new IllegalArgumentException(String.format(
- "Metric of type %s is expected to implement %s but does not",
- metric.getClass().getName(),
- HelidonMetric.class.getName()));
- }
-
- ((HelidonMetric) metric).prometheusData(sb, metricID, withHelpType);
- }
-
- // unit testable
- static JsonObject toJsonData(Registry... registries) {
- return toJson(MetricsSupport::toJsonData, registries);
- }
-
- static JsonObject toJsonData(Registry registry) {
- return toJson(
- (builder, entry) -> entry.getValue().jsonData(builder, entry.getKey()),
- registry);
- }
-
- static JsonObject toJsonMeta(Registry... registries) {
- return toJson(MetricsSupport::toJsonMeta, registries);
- }
-
- static JsonObject toJsonMeta(Registry registry) {
- return toJson((builder, entry) -> {
- final MetricID metricID = entry.getKey();
- final HelidonMetric metric = entry.getValue();
- final List sameNamedIDs = registry.metricIDsForName(metricID.getName());
- metric.jsonMeta(builder, sameNamedIDs);
- }, registry);
- }
-
- private static JsonObject toJson(Function fn, Registry... registries) {
- return Arrays.stream(registries)
- .filter(r -> !r.empty())
- .collect(JSON::createObjectBuilder,
- (builder, registry) -> accumulateJson(builder, registry, fn),
- JsonObjectBuilder::addAll)
- .build();
- }
-
- private static void accumulateJson(JsonObjectBuilder builder, Registry registry,
- Function fn) {
- builder.add(registry.type(), fn.apply(registry));
- }
-
- private static JsonObject toJson(
- BiConsumer> accumulator,
- Registry registry) {
-
- return registry.stream()
- .sorted(Comparator.comparing(Map.Entry::getKey))
- .collect(() -> new MergingJsonObjectBuilder(JSON.createObjectBuilder()),
- accumulator,
- JsonObjectBuilder::addAll
- )
- .build();
- }
-
- /**
- * Configure vendor metrics on the provided routing. This method is
- * exclusive to {@link #update(io.helidon.reactive.webserver.Routing.Rules)} (e.g.
- * you should not use both, as otherwise you would duplicate the metrics)
- *
- * @param routingName name of the routing (may be null)
- * @param rules routing builder or routing rules
- */
- @Override
- public void configureVendorMetrics(String routingName,
- Routing.Rules rules) {
- String metricPrefix = metricsNamePrefix(routingName);
-
- KeyPerformanceIndicatorSupport.Metrics kpiMetrics =
- KeyPerformanceIndicatorMetricsImpls.get(metricPrefix,
- metricsSettings
- .keyPerformanceIndicatorSettings());
-
- rules.any((req, res) -> {
- KeyPerformanceIndicatorSupport.Context kpiContext = kpiContext(req);
- PostRequestMetricsSupport prms = PostRequestMetricsSupport.create();
- req.context().register(prms);
-
- kpiContext.requestHandlingStarted(kpiMetrics);
- res.whenSent()
- // Perform updates which depend on completion of request *processing* (after the response is sent).
- .thenAccept(r -> postRequestProcessing(prms, req, r, null, kpiContext))
- .exceptionallyAccept(t -> postRequestProcessing(prms, req, res, t, kpiContext));
- Exception exception = null;
- try {
- req.next();
- } catch (Exception e) {
- exception = e;
- throw e;
- } finally {
- // Perform updates which depend on completion of request *handling* (after the server has begun request
- // *processing* but, in the case of async requests, possibly before processing has finished).
- kpiContext.requestHandlingCompleted(exception == null);
- }
- });
- }
-
- /**
- * Finish configuring metrics endpoint on the provided routing rules. This method
- * just adds the endpoint {@code /metrics} (or appropriate one as
- * configured). For simple routings, just register {@code MetricsSupport}
- * instance. This method is exclusive to
- * {@link #update(io.helidon.reactive.webserver.Routing.Rules)} (e.g. you should not
- * use both, as otherwise you would register the endpoint twice)
- *
- * @param defaultRules routing rules for default routing (also accepts {@link io.helidon.reactive.webserver.Routing.Builder})
- * @param serviceEndpointRoutingRules possibly different rules for the metrics endpoint routing
- */
- @Override
- protected void postConfigureEndpoint(Routing.Rules defaultRules, Routing.Rules serviceEndpointRoutingRules) {
- // If metrics are disabled, the RegistryFactory will be the no-op, not the full-featured one.
- if (rf instanceof io.helidon.metrics.RegistryFactory) {
- io.helidon.metrics.RegistryFactory fullRF = (io.helidon.metrics.RegistryFactory) rf;
- Registry app = fullRF.getARegistry(MetricRegistry.Type.APPLICATION);
-
- PeriodicExecutor.start();
-
- // register the metric registry and factory to be available to all
- MetricsContextHandler metricsContextHandler = new MetricsContextHandler(app, rf);
- defaultRules.any(metricsContextHandler);
- if (defaultRules != serviceEndpointRoutingRules) {
- serviceEndpointRoutingRules.any(metricsContextHandler);
- }
-
- configureVendorMetrics(null, defaultRules);
- }
- prepareMetricsEndpoints(context(), serviceEndpointRoutingRules);
- }
-
- @Override
- public void prepareMetricsEndpoints(String endpointContext, Routing.Rules serviceEndpointRoutingRules) {
- if (rf instanceof io.helidon.metrics.RegistryFactory) {
- setUpFullFeaturedEndpoint(serviceEndpointRoutingRules, (io.helidon.metrics.RegistryFactory) rf);
- } else {
- MinimalMetricsSupport.createEndpointForDisabledMetrics(endpointContext, serviceEndpointRoutingRules);
- }
- }
-
- private void setUpFullFeaturedEndpoint(Routing.Rules serviceEndpointRoutingRules,
- io.helidon.metrics.RegistryFactory rf) {
- Registry base = rf.getARegistry(MetricRegistry.Type.BASE);
- Registry vendor = rf.getARegistry(MetricRegistry.Type.VENDOR);
- Registry app = rf.getARegistry(MetricRegistry.Type.APPLICATION);
- // routing to root of metrics
- serviceEndpointRoutingRules.get(context(), (req, res) -> getMultiple(req, res, base, app, vendor))
- .options(context(), (req, res) -> optionsMultiple(req, res, base, app, vendor));
-
- // routing to each scope
- Stream.of(app, base, vendor)
- .forEach(registry -> {
- String type = registry.type();
-
- serviceEndpointRoutingRules.get(context() + "/" + type, (req, res) -> getAll(req, res, registry))
- .get(context() + "/" + type + "/{metric}", (req, res) -> getByName(req, res, registry))
- .options(context() + "/" + type, (req, res) -> optionsAll(req, res, registry))
- .options(context() + "/" + type + "/{metric}", (req, res) -> optionsOne(req, res, registry));
- });
- }
-
- /**
- * Method invoked by the web server to update routing rules. Register this
- * instance with webserver through
- * {@link io.helidon.reactive.webserver.Routing.Builder#register(io.helidon.reactive.webserver.Service...)}
- * rather than calling this method directly. If multiple sockets (and
- * routings) should be supported, you can use the
- * {@link #configureEndpoint(io.helidon.reactive.webserver.Routing.Rules, io.helidon.reactive.webserver.Routing.Rules)}, and
- * {@link #configureVendorMetrics(String, io.helidon.reactive.webserver.Routing.Rules)}
- * methods.
- *
- * @param rules a routing rules to update
- */
- @Override
- public void update(Routing.Rules rules) {
- configureEndpoint(rules, rules);
- }
-
- @Override
- protected void onShutdown() {
- PeriodicExecutor.stop();
- }
-
- private static KeyPerformanceIndicatorSupport.Context kpiContext(ServerRequest request) {
- return request.context()
- .get(KeyPerformanceIndicatorSupport.Context.class)
- .orElseGet(KeyPerformanceIndicatorSupport.Context::create);
- }
-
- private void postRequestProcessing(PostRequestMetricsSupport prms,
- ServerRequest request,
- ServerResponse response,
- Throwable throwable,
- KeyPerformanceIndicatorSupport.Context kpiContext) {
- kpiContext.requestProcessingCompleted(throwable == null && response.status().code() < 500);
- prms.runTasks(request, response, throwable);
- }
-
- private void getByName(ServerRequest req, ServerResponse res, Registry registry) {
- String metricName = req.path().param("metric");
-
- res.cachingStrategy(ServerResponse.CachingStrategy.NO_CACHING);
- registry.getOptionalMetricEntry(metricName)
- .ifPresentOrElse(entry -> {
- MediaType mediaType = findBestAccepted(req.headers());
- if (mediaType == MediaTypes.APPLICATION_JSON) {
- sendJson(res, jsonDataByName(registry, metricName));
- } else if (mediaType == MediaTypes.TEXT_PLAIN) {
- res.send(prometheusDataByName(registry, metricName));
- } else {
- res.status(Http.Status.NOT_ACCEPTABLE_406);
- res.send();
- }
- }, () -> {
- res.status(Http.Status.NOT_FOUND_404);
- res.send();
- });
- }
-
- static JsonObject jsonDataByName(Registry registry, String metricName) {
- JsonObjectBuilder builder = new MetricsSupport.MergingJsonObjectBuilder(JSON.createObjectBuilder());
- for (Map.Entry metricEntry : registry.getMetricsByName(metricName)) {
- HelidonMetric metric = metricEntry.getValue();
- if (registry.isMetricEnabled(metricName)) {
- metric.jsonData(builder, metricEntry.getKey());
- }
- }
- return builder.build();
- }
-
- static String prometheusDataByName(Registry registry, String metricName) {
- final StringBuilder sb = new StringBuilder();
- boolean isFirst = true;
- for (Map.Entry metricEntry : registry.getMetricsByName(metricName)) {
- HelidonMetric metric = metricEntry.getValue();
- if (registry.isMetricEnabled(metricName)) {
- metric.prometheusData(sb, metricEntry.getKey(), isFirst);
- }
- isFirst = false;
- }
- return sb.toString();
- }
-
- private static void sendJson(ServerResponse res, JsonObject object) {
- res.send(JSONP_WRITER.marshall(object));
- }
-
- private void getMultiple(ServerRequest req, ServerResponse res, Registry... registries) {
- MediaType mediaType = findBestAccepted(req.headers());
- res.cachingStrategy(ServerResponse.CachingStrategy.NO_CACHING);
- if (mediaType == MediaTypes.APPLICATION_JSON) {
- sendJson(res, toJsonData(registries));
- } else if (mediaType == MediaTypes.TEXT_PLAIN) {
- res.send(toPrometheusData(registries));
- } else {
- res.status(Http.Status.NOT_ACCEPTABLE_406);
- res.send();
- }
- }
-
- private void optionsMultiple(ServerRequest req, ServerResponse res, Registry... registries) {
- // Options returns metadata only, so do not discourage caching.
- if (req.headers().isAccepted(MediaTypes.APPLICATION_JSON)) {
- sendJson(res, toJsonMeta(registries));
- } else {
- res.status(Http.Status.NOT_ACCEPTABLE_406);
- res.send();
- }
- }
-
- private void optionsOne(ServerRequest req, ServerResponse res, Registry registry) {
- String metricName = req.path().param("metric");
-
- Optional.ofNullable(registry.metadataWithIDs(metricName))
- .ifPresentOrElse(entry -> {
- // Options returns only metadata, so do not discourage caching.
- if (req.headers().isAccepted(MediaTypes.APPLICATION_JSON)) {
- JsonObjectBuilder builder = JSON.createObjectBuilder();
- // The returned list of metric IDs is guaranteed to have at least one element at this point.
- // Use the first to find a metric which will know how to create the metadata output.
- HelidonMetric.class.cast(registry.getMetric(entry.getValue().get(0))).jsonMeta(builder, entry.getValue());
- sendJson(res, builder.build());
- } else {
- res.status(Http.Status.NOT_ACCEPTABLE_406);
- res.send();
- }
- }, () -> {
- res.status(Http.Status.NO_CONTENT_204);
- res.send();
- });
- }
-
- /**
- * A fluent API builder to build instances of {@link MetricsSupport}.
- */
- public static class Builder extends HelidonRestServiceSupport.Builder
- implements io.helidon.metrics.serviceapi.MetricsSupport.Builder {
-
- private Supplier registryFactory;
- private MetricsSettings.Builder metricsSettingsBuilder = MetricsSettings.builder();
-
- /**
- * Creates a new builder instance.
- */
- protected Builder() {
- super(MetricsSettings.Builder.DEFAULT_CONTEXT);
- }
-
- @Override
- protected Config webContextConfig(Config config) {
- // align with health checks
- return DeprecatedConfig.get(config, "web-context", "context");
- }
-
- @Override
- public MetricsSupport build() {
- return build(MetricsSupport::new);
- }
-
- /**
- * Creates a new {@code MetricsSupport} instance from the provided factory.
- *
- * @param factory the factory which maps the builder to a {@code MetricsSupport} instance
- * @return the created {@code MetricsSupport} instance
- */
- protected MetricsSupport build(Function factory) {
- if (null == registryFactory) {
- registryFactory = () -> RegistryFactory.getInstance(MetricsSettings.create(config()));
- }
- MetricsSupport result = factory.apply(this);
- if (!result.metricsSettings.baseMetricsSettings().isEnabled()) {
- LOGGER.finest("Metrics support for base metrics is disabled in settings");
- }
-
- return result;
- }
-
- /**
- * Override default configuration.
- *
- * @param config configuration instance
- * @return updated builder instance
- * @see KeyPerformanceIndicatorMetricsSettings.Builder Details about key
- * performance metrics configuration
- * @deprecated Use {@link #metricsSettings(MetricsSettings.Builder)} instead
- */
- @Deprecated(since = "2.4.0", forRemoval = true)
- public Builder config(Config config) {
- super.config(config);
- metricsSettingsBuilder.config(config);
- return this;
- }
-
- @Override
- public Builder metricsSettings(MetricsSettings.Builder metricsSettingsBuilder) {
- this.metricsSettingsBuilder = metricsSettingsBuilder;
- return this;
- }
-
- /**
- * If you want to have multiple registry factories with different
- * endpoints, you may create them using
- * {@link RegistryFactory#create(MetricsSettings)} or
- * {@link RegistryFactory#create()} and create multiple
- * {@link io.helidon.metrics.MetricsSupport} instances with different
- * {@link #webContext(String)} contexts}.
- *
- * If this method is not called,
- * {@link io.helidon.metrics.MetricsSupport} would use the shared
- * instance as provided by
- * {@link io.helidon.metrics.RegistryFactory#getInstance(io.helidon.config.Config)}
- *
- * @param factory factory to use in this metric support
- * @return updated builder instance
- */
- public Builder registryFactory(RegistryFactory factory) {
- registryFactory = () -> factory;
- return this;
- }
-
- /**
- * Sets the builder for KPI metrics settings, overriding any previously-assigned settings.
- *
- * @param builder for the KPI metrics settings
- * @return updated builder instance
- * @deprecated Use {@link #metricsSettings(MetricsSettings.Builder)} with
- * {@link MetricsSettings.Builder#keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder)}
- * instead.
- */
- @Deprecated(since = "2.4.0", forRemoval = true)
- public Builder keyPerformanceIndicatorsMetricsSettings(KeyPerformanceIndicatorMetricsSettings.Builder builder) {
- this.metricsSettingsBuilder.keyPerformanceIndicatorSettings(builder);
- return this;
- }
-
- /**
- * Updates the KPI metrics config using the extended KPI metrics config node provided.
- *
- * @param kpiConfig Config node containing extended KPI metrics config
- * @return updated builder instance
- * @deprecated Use {@link #metricsSettings(MetricsSettings.Builder)} with
- * {@link MetricsSettings.Builder#keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder)}
- * instead.
- */
- @Deprecated(since = "2.4.0", forRemoval = true)
- public Builder keyPerformanceIndicatorsMetricsConfig(Config kpiConfig) {
- return keyPerformanceIndicatorsMetricsSettings(
- KeyPerformanceIndicatorMetricsSettings.builder().config(kpiConfig));
- }
- }
-
- // this class is created for cleaner tracing of web server handlers
- private static final class MetricsContextHandler implements Handler {
-
- private final Registry appRegistry;
- private final RegistryFactory registryFactory;
-
- private MetricsContextHandler(Registry appRegistry, RegistryFactory registryFactory) {
- this.appRegistry = appRegistry;
- this.registryFactory = registryFactory;
- }
-
- @Override
- public void accept(ServerRequest req, ServerResponse res) {
- req.context().register(appRegistry);
- req.context().register(registryFactory);
- req.next();
- }
- }
-
- /**
- * A {@code JsonObjectBuilder} that aggregates, rather than overwrites, when
- * the caller adds objects or arrays with the same name.
- *
- * This builder is tuned to the needs of reporting metrics metadata. Metrics
- * which share the same name but have different tags and have multiple
- * values (called samples) need to appear in the data output as one
- * object with the common name. The name of each sample in the output is
- * decorated with the tags for the sample's parent metric. For example:
- *
- *
- * "carsMeter": {
- * "count;colour=red" : 0,
- * "meanRate;colour=red" : 0,
- * "oneMinRate;colour=red" : 0,
- * "fiveMinRate;colour=red" : 0,
- * "fifteenMinRate;colour=red" : 0,
- * "count;colour=blue" : 0,
- * "meanRate;colour=blue" : 0,
- * "oneMinRate;colour=blue" : 0,
- * "fiveMinRate;colour=blue" : 0,
- * "fifteenMinRate;colour=blue" : 0
- * }
- *
- *
- * The metadata output (as opposed to the data output) must collect tag
- * information from actual instances of the metric under the overall metadata
- * object. This example reflects two instances of the {@code barVal} gauge
- * which have tags of "store" and "component."
- *
- * "barVal": {
- * "unit": "megabytes",
- * "type": "gauge",
- * "tags": [
- * [
- * "store=webshop",
- * "component=backend"
- * ],
- * [
- * "store=webshop",
- * "component=frontend"
- * ]
- * ]
- * }
- *
- */
- static final class MergingJsonObjectBuilder implements JsonObjectBuilder {
-
- private final JsonObjectBuilder delegate;
-
- private final Map> subValuesMap = new HashMap<>();
- private final Map> subArraysMap = new HashMap<>();
-
- MergingJsonObjectBuilder(JsonObjectBuilder delegate) {
- this.delegate = delegate;
- }
-
- @Override
- public JsonObjectBuilder add(String name, JsonObjectBuilder subBuilder) {
- final JsonObject ob = subBuilder.build();
- delegate.add(name, JSON.createObjectBuilder(ob));
- List subValues;
- if (subValuesMap.containsKey(name)) {
- subValues = subValuesMap.get(name);
- } else {
- subValues = new ArrayList<>();
- subValuesMap.put(name, subValues);
- }
- subValues.add(ob);
- return this;
- }
-
- @Override
- public JsonObjectBuilder add(String name, JsonArrayBuilder arrayBuilder) {
- final JsonArray array = arrayBuilder.build();
- delegate.add(name, JSON.createArrayBuilder(array));
- List subArrays;
- if (subArraysMap.containsKey(name)) {
- subArrays = subArraysMap.get(name);
- } else {
- subArrays = new ArrayList<>();
- subArraysMap.put(name, subArrays);
- }
- subArrays.add(array);
- return this;
- }
-
- @Override
- public JsonObjectBuilder add(String arg0, JsonValue arg1) {
- delegate.add(arg0, arg1);
- return this;
- }
-
- @Override
- public JsonObjectBuilder add(String arg0, String arg1) {
- delegate.add(arg0, arg1);
- return this;
- }
-
- @Override
- public JsonObjectBuilder add(String arg0, BigInteger arg1) {
- delegate.add(arg0, arg1);
- return this;
- }
-
- @Override
- public JsonObjectBuilder add(String arg0, BigDecimal arg1) {
- delegate.add(arg0, arg1);
- return this;
- }
-
- @Override
- public JsonObjectBuilder add(String arg0, int arg1) {
- delegate.add(arg0, arg1);
- return this;
- }
-
- @Override
- public JsonObjectBuilder add(String arg0, long arg1) {
- delegate.add(arg0, arg1);
- return this;
- }
-
- @Override
- public JsonObjectBuilder add(String arg0, double arg1) {
- if (Double.isNaN(arg1)) {
- delegate.add(arg0, String.valueOf(Double.NaN));
- } else {
- delegate.add(arg0, arg1);
- }
- return this;
- }
-
- @Override
- public JsonObjectBuilder add(String arg0, boolean arg1) {
- delegate.add(arg0, arg1);
- return this;
- }
-
- @Override
- public JsonObjectBuilder addNull(String arg0) {
- delegate.addNull(arg0);
- return this;
- }
-
- @Override
- public JsonObjectBuilder addAll(JsonObjectBuilder builder) {
- delegate.addAll(builder);
- return this;
- }
-
- @Override
- public JsonObjectBuilder remove(String name) {
- delegate.remove(name);
- return this;
- }
-
- @Override
- public JsonObject build() {
- final JsonObject beforeMerging = delegate.build();
- if (subValuesMap.isEmpty() && subArraysMap.isEmpty()) {
- return beforeMerging;
- }
- final JsonObjectBuilder mainBuilder = JSON.createObjectBuilder(beforeMerging);
- subValuesMap.entrySet().stream()
- .forEach(entry -> {
- final JsonObjectBuilder metricBuilder = JSON.createObjectBuilder();
- for (JsonObject subObject : entry.getValue()) {
- final JsonObjectBuilder subBuilder = JSON.createObjectBuilder(subObject);
- metricBuilder.addAll(subBuilder);
- }
- mainBuilder.add(entry.getKey(), metricBuilder);
- });
-
- subArraysMap.entrySet().stream()
- .forEach(entry -> {
- final JsonArrayBuilder arrayBuilder = JSON.createArrayBuilder();
- for (JsonArray subArray : entry.getValue()) {
- final JsonArrayBuilder subArrayBuilder = JSON.createArrayBuilder(subArray);
- arrayBuilder.add(subArrayBuilder);
- }
- mainBuilder.add(entry.getKey(), arrayBuilder);
- });
-
- return mainBuilder.build();
- }
-
- @Override
- public String toString() {
- return delegate.toString();
- }
- }
-}
diff --git a/metrics/metrics/src/main/java/io/helidon/metrics/MetricsSupportProviderImpl.java b/metrics/metrics/src/main/java/io/helidon/metrics/MetricsSupportProviderImpl.java
deleted file mode 100644
index 28a5d4ee90e..00000000000
--- a/metrics/metrics/src/main/java/io/helidon/metrics/MetricsSupportProviderImpl.java
+++ /dev/null
@@ -1,37 +0,0 @@
-/*
- * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import io.helidon.metrics.api.MetricsSettings;
-import io.helidon.metrics.serviceapi.spi.MetricsSupportProvider;
-import io.helidon.servicecommon.rest.RestServiceSettings;
-
-/**
- * Provider which furnishes a builder for {@link MetricsSupport} instances.
- */
-public class MetricsSupportProviderImpl implements MetricsSupportProvider {
-
- @Override
- public MetricsSupport.Builder builder() {
- return MetricsSupport.builder();
- }
-
- @Override
- public MetricsSupport create(MetricsSettings metricsSettings, RestServiceSettings restServiceSettings) {
- // Don't use create because that delegates to the API MetricsSupport class which would delegate right back here.
- return new MetricsSupport(metricsSettings, restServiceSettings);
- }
-}
diff --git a/metrics/metrics/src/main/java/io/helidon/metrics/PrometheusName.java b/metrics/metrics/src/main/java/io/helidon/metrics/PrometheusName.java
deleted file mode 100644
index 823a775ea21..00000000000
--- a/metrics/metrics/src/main/java/io/helidon/metrics/PrometheusName.java
+++ /dev/null
@@ -1,110 +0,0 @@
-/*
- * Copyright (c) 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import io.helidon.metrics.MetricImpl.Units;
-
-import org.eclipse.microprofile.metrics.MetricID;
-
-/**
- * Abstraction for a Prometheus metric name, offering various formats of output as required by the Prometheus format.
- */
-class PrometheusName {
-
- private final String prometheusTags;
-
- private final MetricImpl metricImpl;
- private final MetricID metricID;
- private final String prometheusNameWithUnits;
- private final String prometheusName;
- private final String prometheusUnit;
- private final Units units;
-
- static PrometheusName create(MetricImpl metricImpl, MetricID metricID) {
- return new PrometheusName(metricImpl, metricID, metricImpl.getUnits());
- }
-
- static PrometheusName create(MetricImpl metricImpl, MetricID metricID, Units units) {
- return new PrometheusName(metricImpl, metricID, units);
- }
-
- private PrometheusName(MetricImpl metricImpl, MetricID metricID, Units units) {
- this.metricImpl = metricImpl;
- this.metricID = metricID;
- this.units = units;
- prometheusName = MetricImpl.prometheusClean(metricID.getName(), metricImpl.registryType() + "_");
- this.prometheusTags = metricImpl.prometheusTags(metricID.getTags());
- prometheusNameWithUnits = nameUnits(units);
-
- prometheusUnit = units
- .getPrometheusUnit()
- .orElse("");
- }
-
- Units units() {
- return units;
- }
-
- /**
- * Returns the Prometheus metric name (registry type + metric name) + units.
- *
- * @return name with units
- */
- String nameUnits() {
- return prometheusNameWithUnits;
- }
-
- String nameUnits(Units units) {
- return metricImpl.prometheusNameWithUnits(metricID.getName(), units.getPrometheusUnit());
- }
-
- /**
- * Returns the Prometheus metric name (registry type + metric name) + statistic type + units.
- *
- * @param statName the statistics name (e.g., "mean") to include in the name expression
- * @return name with stat name with units
- */
- String nameStatUnits(String statName) {
- return nameStat(statName) + (prometheusUnit.isBlank() ? "" : "_" + prometheusUnit);
- }
-
- String nameStat(String statName) {
- return prometheusName + "_" + statName;
- }
-
- String nameStatTags(String statName) {
- return nameStat(statName) + prometheusTags;
- }
-
- /**
- * Returns the Prometheus metric name (registry type + metric name) + units + suffix (e.g., "count") + tags.
- *
- * @param nameSuffix suffix to add to the name (after the units)
- * @return name with units with suffix with tags
- */
- String nameUnitsSuffixTags(String nameSuffix) {
- return prometheusNameWithUnits + "_" + nameSuffix + prometheusTags;
- }
-
- /**
- * Returns the Prometheus format for the tags.
- *
- * @return tags in Prometheus format "{tag=value,tag=value,...}"
- */
- String prometheusTags() {
- return prometheusTags;
- }
-}
diff --git a/metrics/metrics/src/main/java/io/helidon/metrics/Registry.java b/metrics/metrics/src/main/java/io/helidon/metrics/Registry.java
index a3ac7a5b47a..1b85d9569af 100644
--- a/metrics/metrics/src/main/java/io/helidon/metrics/Registry.java
+++ b/metrics/metrics/src/main/java/io/helidon/metrics/Registry.java
@@ -17,7 +17,6 @@
import java.util.List;
import java.util.Map;
-import java.util.Optional;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.BiFunction;
import java.util.function.Function;
@@ -25,6 +24,7 @@
import java.util.stream.Stream;
import io.helidon.metrics.api.AbstractRegistry;
+import io.helidon.metrics.api.MetricInstance;
import io.helidon.metrics.api.RegistrySettings;
import org.eclipse.microprofile.metrics.ConcurrentGauge;
@@ -42,7 +42,7 @@
/**
* Metrics registry.
*/
-public class Registry extends AbstractRegistry {
+public class Registry extends AbstractRegistry {
private final AtomicReference registrySettings = new AtomicReference<>();
@@ -64,12 +64,12 @@ public void update(RegistrySettings registrySettings) {
}
@Override
- protected boolean isMetricEnabled(String metricName) {
+ public boolean enabled(String metricName) {
return registrySettings.get().isMetricEnabled(metricName);
}
@Override
- protected HelidonMetric toImpl(Metadata metadata, T metric) {
+ protected HelidonMetric toImpl(Metadata metadata, Metric metric) {
MetricType metricType = deriveType(metadata.getTypeRaw(), metric);
switch (metricType) {
@@ -101,12 +101,12 @@ protected HelidonMetric toImpl(Metadata metadata, T metric) {
* @param registrySettings registry settings to influence the created registry
*/
protected Registry(Type type, RegistrySettings registrySettings) {
- super(type, HelidonMetric.class, registrySettings);
+ super(type, registrySettings);
this.registrySettings.set(registrySettings);
}
@Override
- protected Map, MetricType> prepareMetricToTypeMap() {
+ protected Map, MetricType> prepareMetricToTypeMap() {
return Map.of(
HelidonConcurrentGauge.class, MetricType.CONCURRENT_GAUGE,
HelidonCounter.class, MetricType.COUNTER,
@@ -123,7 +123,7 @@ protected Gauge createGauge(Metadata metadata, Supplier
}
@Override
- protected Map> prepareMetricFactories() {
+ protected Map> prepareMetricFactories() {
// Omit gauge because creating a gauge requires an existing delegate instance.
// These factory methods do not use delegates.
return Map.of(MetricType.COUNTER, HelidonCounter::create,
@@ -141,19 +141,13 @@ protected Gauge createGauge(Metadata metadata,
return HelidonGauge.create(type(), metadata, object, func);
}
- // -- declarations which let us keep the methods in the superclass protected; we do not want them public.
@Override
- protected Optional> getOptionalMetricEntry(String metricName) {
- return super.getOptionalMetricEntry(metricName);
- }
-
- @Override
- protected Map> metricFactories() {
+ protected Map> metricFactories() {
return super.metricFactories();
}
@Override
- protected Stream> stream() {
+ public Stream stream() {
return super.stream();
}
@@ -162,8 +156,4 @@ protected List metricIDsForName(String metricName) {
return super.metricIDsForName(metricName);
}
- @Override
- protected List> getMetricsByName(String metricName) {
- return super.getMetricsByName(metricName);
- }
}
diff --git a/metrics/metrics/src/main/java/io/helidon/metrics/RegistryFactory.java b/metrics/metrics/src/main/java/io/helidon/metrics/RegistryFactory.java
index 144d827cf9d..0aeb7ddda0b 100644
--- a/metrics/metrics/src/main/java/io/helidon/metrics/RegistryFactory.java
+++ b/metrics/metrics/src/main/java/io/helidon/metrics/RegistryFactory.java
@@ -23,7 +23,6 @@
import io.helidon.config.Config;
import io.helidon.metrics.api.MetricsSettings;
-import org.eclipse.microprofile.metrics.MetricRegistry;
import org.eclipse.microprofile.metrics.MetricRegistry.Type;
/**
@@ -149,7 +148,7 @@ Registry getARegistry(Type type) {
* @return MetricRegistry for the type defined.
*/
@Override
- public MetricRegistry getRegistry(Type type) {
+ public Registry getRegistry(Type type) {
if (type == Type.BASE) {
ensureBase();
}
@@ -164,6 +163,21 @@ public void update(MetricsSettings metricsSettings) {
});
}
+ @Override
+ public boolean enabled() {
+ return true;
+ }
+
+ @Override
+ public void start() {
+ PeriodicExecutor.start();
+ }
+
+ @Override
+ public void stop() {
+ PeriodicExecutor.stop();
+ }
+
private void ensureBase() {
if (null == registries.get(Type.BASE)) {
accessMetricsSettings(() -> {
diff --git a/metrics/metrics/src/main/java/io/helidon/metrics/Sample.java b/metrics/metrics/src/main/java/io/helidon/metrics/Sample.java
deleted file mode 100644
index 65d1eeda2d1..00000000000
--- a/metrics/metrics/src/main/java/io/helidon/metrics/Sample.java
+++ /dev/null
@@ -1,130 +0,0 @@
-/*
- * Copyright (c) 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-/**
- * Common behavior to all types of samples.
- */
-interface Sample {
-
- boolean IS_EXEMPLAR_HANDLING_ACTIVE = ExemplarServiceManager.isActive();
-
- static Derived derived(double value, Sample.Labeled reference) {
- return new Derived.Impl(value, reference);
- }
-
- static Derived derived(double value) {
- return new Derived.Impl(value, null);
- }
-
- static Labeled labeled(long value) {
- return IS_EXEMPLAR_HANDLING_ACTIVE
- ? new Labeled.Impl(value, ExemplarServiceManager.exemplarLabel(), System.currentTimeMillis())
- : new Labeled.Impl(value, ExemplarServiceManager.INACTIVE_LABEL, 0);
- }
-
- /**
- * Returns the value as a double.
- *
- * For actual samples this serves as a conversion from long to double so all sample types can be treated somewhat
- * uniformly.
- *
- * @return value of the sample as a double
- */
- double doubleValue();
-
- /**
- * Sample that does not exist as an actual observation but is derived from actual observations. E.g., mean.
- * Most derived sample instances have a reference to an actual sample that is an exemplar for the derived sample. Because
- * derived samples are typically computed from actual samples, the value is a double (rather than a long as with the actual
- * samples).
- */
- interface Derived extends Sample {
-
- Derived ZERO = new Derived.Impl(0.0, null);
-
- double value();
- Labeled sample();
-
- class Impl implements Derived {
-
- private final double value;
- private final Labeled sample;
-
- Impl(double value, Labeled reference) {
- this.value = value;
- this.sample = reference;
- }
-
- @Override
- public double value() {
- return value;
- }
-
- @Override
- public Labeled sample() {
- return sample;
- }
-
- @Override
- public double doubleValue() {
- return value;
- }
- }
- }
-
- /**
- * A sample with a label and a timestamp, typically representing actual observations (rather than derived values).
- */
- interface Labeled extends Sample {
-
- long value();
- String label();
- long timestamp();
-
- class Impl implements Labeled {
- private final long value;
- private final String label;
- private final long timestamp;
-
- Impl(long value, String label, long timestamp) {
- this.value = value;
- this.label = label;
- this.timestamp = timestamp;
- }
-
- @Override
- public long value() {
- return value;
- }
-
- @Override
- public String label() {
- return label;
- }
-
- @Override
- public long timestamp() {
- return timestamp;
- }
-
- @Override
- public double doubleValue() {
- return value;
- }
- }
- }
-}
diff --git a/metrics/metrics/src/main/java/io/helidon/metrics/WeightedSnapshot.java b/metrics/metrics/src/main/java/io/helidon/metrics/WeightedSnapshot.java
index dac16230852..dd6025dd6f3 100644
--- a/metrics/metrics/src/main/java/io/helidon/metrics/WeightedSnapshot.java
+++ b/metrics/metrics/src/main/java/io/helidon/metrics/WeightedSnapshot.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2018, 2021 Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -24,12 +24,14 @@
import java.util.Collection;
import java.util.Comparator;
-import io.helidon.metrics.Sample.Derived;
-import io.helidon.metrics.Sample.Labeled;
+import io.helidon.metrics.api.LabeledSample;
+import io.helidon.metrics.api.LabeledSnapshot;
+import io.helidon.metrics.api.Sample;
+import io.helidon.metrics.api.Sample.Derived;
import org.eclipse.microprofile.metrics.Snapshot;
-import static io.helidon.metrics.Sample.derived;
+import static io.helidon.metrics.api.Sample.derived;
/*
* This class is heavily inspired by:
@@ -43,7 +45,7 @@
/**
* A statistical snapshot of a {@link WeightedSnapshot}.
*/
-class WeightedSnapshot extends Snapshot implements DisplayableLabeledSnapshot {
+class WeightedSnapshot extends Snapshot implements LabeledSnapshot {
private static final Charset UTF_8 = Charset.forName("UTF-8");
private final WeightedSample[] copy;
@@ -325,7 +327,7 @@ public void dump(OutputStream output) {
* If the label is empty, then this sample will never be an exemplar so we do not need to default the timestamp to the
* current time.
*/
- static class WeightedSample extends Labeled.Impl {
+ static class WeightedSample extends LabeledSample {
static final WeightedSample ZERO = new WeightedSample(0, 1.0, "");
diff --git a/metrics/metrics/src/main/java/io/helidon/metrics/WrappedSnapshot.java b/metrics/metrics/src/main/java/io/helidon/metrics/WrappedSnapshot.java
index 4e771e585dc..912b02b124f 100644
--- a/metrics/metrics/src/main/java/io/helidon/metrics/WrappedSnapshot.java
+++ b/metrics/metrics/src/main/java/io/helidon/metrics/WrappedSnapshot.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2021 Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,15 +15,16 @@
*/
package io.helidon.metrics;
-import io.helidon.metrics.Sample.Derived;
-import io.helidon.metrics.Sample.Labeled;
+import io.helidon.metrics.api.LabeledSnapshot;
+import io.helidon.metrics.api.Sample.Derived;
+import io.helidon.metrics.api.Sample.Labeled;
import org.eclipse.microprofile.metrics.Snapshot;
-import static io.helidon.metrics.Sample.derived;
-import static io.helidon.metrics.Sample.labeled;
+import static io.helidon.metrics.api.Sample.derived;
+import static io.helidon.metrics.api.Sample.labeled;
-class WrappedSnapshot implements DisplayableLabeledSnapshot {
+class WrappedSnapshot implements LabeledSnapshot {
private final Snapshot delegate;
diff --git a/metrics/metrics/src/main/java/module-info.java b/metrics/metrics/src/main/java/module-info.java
index 498883d6050..61ed67840be 100644
--- a/metrics/metrics/src/main/java/module-info.java
+++ b/metrics/metrics/src/main/java/module-info.java
@@ -13,6 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Helidon Metrics implementation.
*/
@@ -20,24 +21,19 @@
requires java.logging;
requires io.helidon.common;
- requires io.helidon.reactive.webserver.cors;
requires transitive io.helidon.metrics.api;
requires transitive io.helidon.metrics.serviceapi;
requires transitive microprofile.metrics.api;
requires java.management;
- requires transitive io.helidon.reactive.webserver; // webserver/webserver/Context is a public return value
- requires io.helidon.reactive.media.jsonp;
requires jakarta.json;
- requires io.helidon.servicecommon.rest;
+ requires io.helidon.common.configurable;
exports io.helidon.metrics;
+ uses io.helidon.metrics.api.spi.ExemplarService;
+
provides io.helidon.metrics.api.spi.RegistryFactoryProvider with io.helidon.metrics.RegistryFactoryProviderImpl;
- provides io.helidon.metrics.serviceapi.spi.MetricsSupportProvider with io.helidon.metrics.MetricsSupportProviderImpl;
provides io.helidon.common.configurable.spi.ExecutorServiceSupplierObserver
with io.helidon.metrics.ExecutorServiceMetricsObserver;
-
- uses io.helidon.metrics.ExemplarService;
- uses io.helidon.metrics.serviceapi.spi.MetricsSupportProvider;
}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/GreetService.java b/metrics/metrics/src/test/java/io/helidon/metrics/GreetService.java
deleted file mode 100644
index 74bd932b134..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/GreetService.java
+++ /dev/null
@@ -1,79 +0,0 @@
-/*
- * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import java.util.ArrayList;
-import java.util.List;
-import java.util.concurrent.CountDownLatch;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.TimeoutException;
-import java.util.concurrent.atomic.AtomicInteger;
-
-import io.helidon.common.configurable.ThreadPoolSupplier;
-import io.helidon.common.http.Http;
-import io.helidon.config.Config;
-import io.helidon.reactive.webserver.Routing;
-import io.helidon.reactive.webserver.ServerRequest;
-import io.helidon.reactive.webserver.ServerResponse;
-import io.helidon.reactive.webserver.Service;
-
-class GreetService implements Service {
-
- static final int SLOW_DELAY_SECS = 1;
-
- static final String GREETING_RESPONSE = "Hello World!";
-
- static CountDownLatch slowRequestInProgress = null;
-
- static void initSlowRequest() {
- slowRequestInProgress = new CountDownLatch(1);
- }
-
- static void awaitSlowRequestStarted() throws InterruptedException {
- slowRequestInProgress.await();
- }
-
- private final ExecutorService executorService;
-
- GreetService() {
- Config config = Config.create();
- executorService = ThreadPoolSupplier.builder()
- .config(config.get("application-thread-pool"))
- .build()
- .get();
- }
-
- @Override
- public void update(Routing.Rules rules) {
- rules.get("/greet/slow", this::greetSlow);
- }
-
- private void greetSlow(ServerRequest request, ServerResponse response) {
- executorService.submit(() -> {
- if (slowRequestInProgress != null) {
- slowRequestInProgress.countDown();
- }
- try {
- TimeUnit.SECONDS.sleep(SLOW_DELAY_SECS);
- } catch (InterruptedException e) {
- //absorb silently
- }
- response.send(GREETING_RESPONSE);
- });
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonConcurrentGaugeTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonConcurrentGaugeTest.java
index f2264dc37b8..c83c16fec87 100644
--- a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonConcurrentGaugeTest.java
+++ b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonConcurrentGaugeTest.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2019, 2021 Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2022 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -23,14 +23,12 @@
import java.util.stream.IntStream;
import org.eclipse.microprofile.metrics.Metadata;
-import org.eclipse.microprofile.metrics.MetricID;
import org.eclipse.microprofile.metrics.MetricType;
import org.eclipse.microprofile.metrics.MetricUnits;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.is;
/**
@@ -77,21 +75,6 @@ static void initClass() {
+ ", so SECONDS_THRESHOLD is " + SECONDS_THRESHOLD);
}
- @Test
- void testInitialState() {
- HelidonConcurrentGauge gauge = HelidonConcurrentGauge.create("base", meta);
- assertThat(gauge.getCount(), is(0L));
- assertThat(gauge.getMax(), is(0L));
- assertThat(gauge.getMin(), is(0L));
-
- // Make sure the concurrent gauge formatting conforms to Prometheus rules.
- StringBuilder sb = new StringBuilder();
- MetricID metricID = new MetricID(meta.getName());
- gauge.prometheusData(sb, metricID, true);
- assertThat("Prometheus format for ConcurrentGauge", sb.toString(), containsString(
- "# TYPE base_" + metricID.getName() + "_current gauge"));
- }
-
@Test
void testMaxAndMinConcurrent() throws InterruptedException {
preStart = new Date();
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonCounterTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonCounterTest.java
index c878d3e0443..2c568ff95af 100644
--- a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonCounterTest.java
+++ b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonCounterTest.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2018, 2021 Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -16,11 +16,6 @@
package io.helidon.metrics;
-import java.io.StringReader;
-
-import jakarta.json.Json;
-import jakarta.json.JsonObject;
-import jakarta.json.JsonObjectBuilder;
import org.eclipse.microprofile.metrics.Counter;
import org.eclipse.microprofile.metrics.Metadata;
import org.eclipse.microprofile.metrics.MetricID;
@@ -100,43 +95,6 @@ void testIncWithParam() {
testValues(49);
}
- @Test
- void testPrometheusData() {
- StringBuilder sb = new StringBuilder();
- counter.inc(17);
- wrappingCounter.inc(17);
-
- String expected = "# TYPE base_theName_total counter\n"
- + "# HELP base_theName_total theDescription\n"
- + "base_theName_total{a=\"b\",c=\"d\"} 17\n";
-
- counter.prometheusData(sb, counterID, true);
- assertThat(sb.toString(), is(expected));
-
- expected = "# TYPE base_theName_total counter\n"
- + "# HELP base_theName_total theDescription\n"
- + "base_theName_total 49\n";
- sb = new StringBuilder();
- wrappingCounter.prometheusData(sb, wrappingCounterID, true);
- assertThat(sb.toString(), is(expected));
- }
-
- @Test
- void testJsonData() {
- counter.inc(47);
- wrappingCounter.inc(47);
-
- JsonObject expected = Json.createReader(new StringReader("{\"theName;a=b;c=d\": 47}")).readObject();
- JsonObjectBuilder builder = Json.createObjectBuilder();
- counter.jsonData(builder, counterID);
- assertThat(builder.build(), is(expected));
-
- expected = Json.createReader(new StringReader("{\"theName\": 49}")).readObject();
- builder = Json.createObjectBuilder();
- wrappingCounter.jsonData(builder, wrappingCounterID);
- assertThat(builder.build(), is(expected));
- }
-
private void testValues(long counterValue) {
assertThat(counter.getCount(), is(counterValue));
assertThat(wrappingCounter.getCount(), is(49L));
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonGaugeTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonGaugeTest.java
deleted file mode 100644
index ab6a3d207fd..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonGaugeTest.java
+++ /dev/null
@@ -1,105 +0,0 @@
-/*
- * Copyright (c) 2019, 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import java.util.Collections;
-import java.util.regex.Pattern;
-
-import jakarta.json.Json;
-import jakarta.json.JsonBuilderFactory;
-import jakarta.json.JsonObject;
-import jakarta.json.JsonObjectBuilder;
-import org.eclipse.microprofile.metrics.Gauge;
-import org.eclipse.microprofile.metrics.Metadata;
-import org.eclipse.microprofile.metrics.MetricID;
-import org.eclipse.microprofile.metrics.MetricType;
-import org.eclipse.microprofile.metrics.MetricUnits;
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Test;
-
-import static org.hamcrest.MatcherAssert.assertThat;
-
-
-public class HelidonGaugeTest {
-
- private static final int EXPECTED_VALUE = 1;
- private static final Pattern JSON_RESULT_PATTERN = Pattern.compile("\\{\"myValue[^\"]*\":1.0\\}");
-
- private static final JsonBuilderFactory FACTORY = Json.createBuilderFactory(Collections.emptyMap());
-
- private static Metadata meta;
-
- @BeforeAll
- static void initClass() {
- meta = Metadata.builder()
- .withName("aGauge")
- .withDisplayName("aGauge")
- .withDescription("aGauge")
- .withType(MetricType.GAUGE)
- .withUnit(MetricUnits.NONE)
- .build();
- }
-
- @Test
- void testJson() {
- MyValue myValue = new MyValue(EXPECTED_VALUE);
- Gauge myGauge = new Gauge() {
-
- @Override
- public MyValue getValue() {
- return myValue;
- }
- };
-
- HelidonGauge gauge = HelidonGauge.create("base", meta, myGauge);
- JsonObjectBuilder builder = FACTORY.createObjectBuilder();
- gauge.jsonData(builder, new MetricID("myValue"));
- JsonObject json = builder.build();
-
- String s = json.toString();
- assertThat("JSON string " + s + " does not match pattern " + JSON_RESULT_PATTERN.toString(),
- JSON_RESULT_PATTERN.matcher(s).matches());
- }
-
- public static class MyValue extends Number {
-
- private final Double value;
-
- public MyValue(double value) {
- this.value = Double.valueOf(value);
- }
-
- @Override
- public int intValue() {
- return value.intValue();
- }
-
- @Override
- public long longValue() {
- return value.longValue();
- }
-
- @Override
- public float floatValue() {
- return value.floatValue();
- }
-
- @Override
- public double doubleValue() {
- return value.doubleValue();
- }
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonHistogramTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonHistogramTest.java
index 28394189576..b19109270a3 100644
--- a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonHistogramTest.java
+++ b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonHistogramTest.java
@@ -15,29 +15,17 @@
*/
package io.helidon.metrics;
-import java.io.IOException;
-import java.io.LineNumberReader;
-import java.io.StringReader;
import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.text.ParseException;
import java.util.AbstractMap;
-import java.util.ArrayList;
import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
-import java.util.function.Predicate;
-import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;
-import jakarta.json.Json;
-import jakarta.json.JsonObject;
-import jakarta.json.JsonObjectBuilder;
-import jakarta.json.JsonValue;
import org.eclipse.microprofile.metrics.Histogram;
import org.eclipse.microprofile.metrics.Metadata;
import org.eclipse.microprofile.metrics.MetricID;
@@ -52,9 +40,7 @@
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.is;
-import static org.hamcrest.Matchers.isEmptyOrNullString;
import static org.hamcrest.Matchers.not;
-import static org.hamcrest.Matchers.notNullValue;
import static org.junit.jupiter.api.Assertions.assertAll;
import static org.junit.jupiter.api.Assertions.fail;
@@ -217,106 +203,6 @@ void testDataSet() {
}
- @Test
- void testJson() {
- JsonObjectBuilder builder = Json.createObjectBuilder();
- histoInt.jsonData(builder, new MetricID("file_sizes"));
-
- JsonObject result = builder.build();
-
- JsonObject metricData = result.getJsonObject("file_sizes");
- assertThat(metricData, notNullValue());
- assertThat(metricData.getJsonNumber("count").longValue(), is(200L));
- assertThat(metricData.getJsonNumber("min").longValue(), is(0L));
- assertThat(metricData.getJsonNumber("max").longValue(), is(99L));
- assertThat("mean", metricData.getJsonNumber("mean").doubleValue(), is(withinTolerance(50.6349)));
- assertThat("stddev", metricData.getJsonNumber("stddev").doubleValue(), is(withinTolerance(29.4389)));
- assertThat("p50", metricData.getJsonNumber("p50").intValue(), is(withinTolerance(48)));
- assertThat("p75", metricData.getJsonNumber("p75").intValue(), is(withinTolerance(75)));
- assertThat("p95", metricData.getJsonNumber("p95").intValue(), is(withinTolerance(96)));
- assertThat("p98", metricData.getJsonNumber("p98").intValue(), is(withinTolerance(98)));
- assertThat("p99", metricData.getJsonNumber("p99").intValue(), is(withinTolerance(98)));
- assertThat("p999", metricData.getJsonNumber("p999").intValue(), is(withinTolerance(99)));
- }
-
- @Test
- void testJsonWithTags() {
- JsonObjectBuilder builder = Json.createObjectBuilder();
- histoInt.jsonData(builder, new MetricID("file_sizes", HISTO_INT_TAGS));
-
- JsonObject result = builder.build();
-
- JsonObject metricData = result.getJsonObject("file_sizes");
- assertThat(metricData, notNullValue());
-
- checkJsonTreeForTags("file_sizes", metricData, HISTO_INT_TAGS_AS_MAP);
- }
-
- private static void checkJsonTreeForTags(String key, JsonValue jsonValue, Map expectedTags) {
- if (jsonValue.getValueType() == JsonValue.ValueType.OBJECT) {
- jsonValue.asJsonObject()
- .forEach((childKey, childValue) -> checkJsonTreeForTags(key + "." + childKey, childValue, expectedTags));
- } else {
- assertThat("Leaf JSON node with key " + key,
- tagsFromJsonKey(key),
- MetricsCustomMatchers.MapContains.all(HISTO_INT_TAGS_AS_MAP));
- }
- }
-
- private static Map tagsFromJsonKey(String jsonKey) {
- return jsonKey.contains(";")
- ? tagsFromDelimitedString(jsonKey.substring(jsonKey.indexOf(';') + 1), ";")
- : Collections.emptyMap();
- }
-
- @Test
- void testPrometheus() throws IOException, ParseException {
- final StringBuilder sb = new StringBuilder();
- histoInt.prometheusData(sb, histoIntID, true);
- parsePrometheusText(new LineNumberReader(new StringReader(sb.toString())).lines())
- .forEach(entry -> assertThat("Unexpected value checking " + entry.getKey(),
- EXPECTED_PROMETHEUS_RESULTS.get(entry.getKey()),
- is(withinTolerance(entry.getValue()))));
- }
-
- @Test
- void testPrometheusWithTags() {
- final StringBuilder sb = new StringBuilder();
- histoInt.prometheusData(sb, histoIntIDWithTags, true);
-
- parsePrometheusText(new LineNumberReader(new StringReader(sb.toString())).lines())
- .forEach(entry -> assertThat("Missing tag labels for " + entry.getKey(),
- tagsFromPrometheusKey(entry.getKey()),
- MetricsCustomMatchers.MapContains.all(HISTO_INT_TAGS_AS_MAP_PROM)));
- }
-
- private static Map tagsFromPrometheusKey(String promKey) {
- // Actual tags will exclude any possible "quantile" settings.
- List result = new ArrayList<>();
- Matcher m = PROMETHEUS_KEY_PATTERN.matcher(promKey);
- if (!m.matches()) {
- fail("Could not parse Prometheus key for tags: " + promKey);
- }
- if (m.groupCount() <= 1) {
- return Collections.emptyMap();
- }
-
- String tagExprs = m.group(2);
- assertThat("Tag expressions from Prometheus key " + promKey, tagExprs, not(isEmptyOrNullString()));
-
- return tagsFromDelimitedString(m.group(2), ",");
- }
-
- private static Map tagsFromDelimitedString(String delimitedString, String delimiter) {
- return Arrays.stream(delimitedString.split(delimiter))
- .filter(Predicate.not(tagExpr -> tagExpr.startsWith("quantile")))
- .map(tagExpr -> tagExpr.split("="))
- .peek(arr -> {
- assertThat("Tag expression is name=value giving two segments", arr.length, is(2));
- })
- .collect(Collectors.toMap(arr -> arr[0], arr -> arr[1]));
- }
-
@Test
void testStatisticalValues() {
testSnapshot(1, "integers", histoInt.getSnapshot(), 50.6, 29.4389);
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonMeterTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonMeterTest.java
index 1d4f46b6c80..ec7259c159b 100644
--- a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonMeterTest.java
+++ b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonMeterTest.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2018, 2021 Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2022 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,9 +19,6 @@
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.LongAdder;
-import jakarta.json.Json;
-import jakarta.json.JsonObject;
-import jakarta.json.JsonObjectBuilder;
import org.eclipse.microprofile.metrics.Metadata;
import org.eclipse.microprofile.metrics.MetricID;
import org.eclipse.microprofile.metrics.MetricType;
@@ -31,27 +28,18 @@
import org.junit.jupiter.api.Test;
import static io.helidon.metrics.HelidonMetricsMatcher.withinTolerance;
-import static org.hamcrest.CoreMatchers.containsString;
-import static org.hamcrest.CoreMatchers.startsWith;
import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.closeTo;
import static org.hamcrest.Matchers.is;
-import static org.hamcrest.Matchers.notNullValue;
/**
* Unit test for {@link HelidonMeter}.
*/
class HelidonMeterTest {
- private static final String EXPECTED_PROMETHEUS_START = "# TYPE application_requests_total counter\n"
- + "# HELP application_requests_total Tracks the number of requests to the server\n"
- + "application_requests_total 1000\n"
- + "# TYPE application_requests_rate_per_second gauge\n"
- + "application_requests_rate_per_second ";
private static HelidonMeter meter;
private static MetricID meterID;
@BeforeAll
- static void initClass() throws InterruptedException {
+ static void initClass() {
Metadata meta = Metadata.builder()
.withName("requests")
.withDisplayName("Requests")
@@ -113,39 +101,4 @@ void testFiveMinuteRate() {
void testFifteenMinuteRate() {
assertThat("fifteen minute rate", meter.getFifteenMinuteRate(), is(withinTolerance(100)));
}
-
- @Test
- void testJson() {
- JsonObjectBuilder builder = Json.createObjectBuilder();
- meter.jsonData(builder, new MetricID("requests"));
-
- JsonObject result = builder.build();
-
- JsonObject metricData = result.getJsonObject("requests");
- assertThat(metricData, notNullValue());
- assertThat(metricData.getInt("count"), is(1000));
- assertThat(metricData.getJsonNumber("meanRate").doubleValue(), closeTo(100, 0.1));
- assertThat(metricData.getJsonNumber("oneMinRate").doubleValue(), closeTo(100, 0.1));
- assertThat(metricData.getJsonNumber("fiveMinRate").doubleValue(), closeTo(100, 0.1));
- assertThat(metricData.getJsonNumber("fifteenMinRate").doubleValue(), closeTo(100, 0.1));
-
- }
-
- @Test
- void testPrometheus() {
- final StringBuilder sb = new StringBuilder();
- meter.prometheusData(sb, meterID, true);
- String data = sb.toString();
-
- assertThat(data, startsWith(EXPECTED_PROMETHEUS_START));
- assertThat(data, containsString("# TYPE application_requests_one_min_rate_per_second gauge\n"
- + "application_requests_one_min_rate_per_second "));
-
- assertThat(data, containsString("# TYPE application_requests_five_min_rate_per_second gauge\n"
- + "application_requests_five_min_rate_per_second "));
-
- assertThat(data, containsString("# TYPE application_requests_fifteen_min_rate_per_second gauge\n"
- + "application_requests_fifteen_min_rate_per_second "));
-
- }
}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonSimpleTimerTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonSimpleTimerTest.java
index 9191b2e3107..a0cedac6b1c 100644
--- a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonSimpleTimerTest.java
+++ b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonSimpleTimerTest.java
@@ -16,16 +16,8 @@
package io.helidon.metrics;
import java.time.Duration;
-import java.time.temporal.ChronoUnit;
-import java.util.Map;
import java.util.concurrent.TimeUnit;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-import jakarta.json.Json;
-import jakarta.json.JsonObject;
-import jakarta.json.JsonObjectBuilder;
-import jakarta.json.JsonValue;
import org.eclipse.microprofile.metrics.Metadata;
import org.eclipse.microprofile.metrics.MetricID;
import org.eclipse.microprofile.metrics.MetricType;
@@ -33,14 +25,9 @@
import org.eclipse.microprofile.metrics.SimpleTimer;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.ValueSource;
-import org.junit.platform.commons.JUnitException;
-import static io.helidon.metrics.HelidonMetricsMatcher.withinTolerance;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
-import static org.hamcrest.Matchers.notNullValue;
import static org.hamcrest.Matchers.nullValue;
class HelidonSimpleTimerTest {
@@ -159,146 +146,6 @@ void testRunnableTiming() {
checkMinAndMaxDurations(timer, toSeconds, toSeconds);
}
- @Test
- void testJson() {
- JsonObjectBuilder builder = Json.createObjectBuilder();
- ensureDataSetTimerClockAdvanced();
- dataSetTimer.jsonData(builder, dataSetTimerID);
-
- JsonObject json = builder.build();
- JsonObject metricData = json.getJsonObject("response_time");
-
- assertThat(metricData, notNullValue());
- assertThat("count", metricData.getJsonNumber("count").longValue(), is(200L));
- assertThat("elapsedTime", metricData.getJsonNumber("elapsedTime"), notNullValue());
- assertThat("maxTimeDuration", metricData.getJsonNumber("maxTimeDuration").longValue(), is(0L));
- assertThat("minTimeDuration", metricData.getJsonNumber("minTimeDuration").longValue(), is(0L));
-
- // Because the batch of test data does not give a non-zero min or max, do a separate test to check the min and max.
- TestClock clock = TestClock.create();
- HelidonSimpleTimer simpleTimer = HelidonSimpleTimer.create("application", meta, clock);
-
- simpleTimer.update(Duration.ofSeconds(4));
- simpleTimer.update(Duration.ofSeconds(3));
-
- clock.add(1, TimeUnit.MINUTES);
- builder = Json.createObjectBuilder();
- simpleTimer.jsonData(builder, dataSetTimerID);
-
- json = builder.build();
- metricData = json.getJsonObject("response_time");
-
- assertThat(metricData, notNullValue());
- assertThat("count", metricData.getJsonNumber("count").longValue(), is(2L));
- assertThat("elapsedTime", metricData.getJsonNumber("elapsedTime").doubleValue(), is(7.0D));
- assertThat("maxTimeDuration", metricData.getJsonNumber("maxTimeDuration").longValue(), is(4L));
- assertThat("minTimeDuration", metricData.getJsonNumber("minTimeDuration").longValue(), is(3L));
-
-
- }
-
- @ParameterizedTest
- @ValueSource(strings = {MetricUnits.SECONDS, MetricUnits.NANOSECONDS, MetricUnits.MILLISECONDS, MetricUnits.MICROSECONDS})
- void testJsonNonDefaultUnits(String metricUnits) {
- Metadata metadataWithUnits = Metadata.builder(meta)
- .withUnit(metricUnits)
- .build();
- TestClock clock = TestClock.create();
- HelidonSimpleTimer simpleTimer = HelidonSimpleTimer.create("application", metadataWithUnits, clock);
-
- Duration longInterval = Duration.ofSeconds(4);
- Duration shortInterval = Duration.ofSeconds(3);
- Duration overallInterval = Duration.of(longInterval.toNanos() + shortInterval.toNanos(), ChronoUnit.NANOS);
-
- simpleTimer.update(longInterval);
- simpleTimer.update(shortInterval);
- clock.add(1, TimeUnit.MINUTES);
- JsonObjectBuilder builder = Json.createObjectBuilder();
- simpleTimer.jsonData(builder, new MetricID("simpleTimerWithExplicitUnits"));
- JsonObject json = builder.build();
-
- JsonObject metricData = json.getJsonObject("simpleTimerWithExplicitUnits");
- assertThat(metricData, notNullValue());
- assertThat("elapsedTime",
- metricData.getJsonNumber("elapsedTime").longValue(),
- is(TestUtils.secondsToMetricUnits(metricUnits, overallInterval)));
- assertThat("maxTimeDuration",
- metricData.getJsonNumber("maxTimeDuration").longValue(),
- is(TestUtils.secondsToMetricUnits(metricUnits, longInterval)));
- assertThat("maxTimeDuration",
- metricData.getJsonNumber("minTimeDuration").longValue(),
- is(TestUtils.secondsToMetricUnits(metricUnits, shortInterval)));
- }
-
- @Test
- void testPrometheus() {
- Pattern responseTimePattern =
- Pattern.compile("""
- # TYPE application_response_time_total counter
- # HELP application_response_time_total Server response time for /index.html
- application_response_time_total (\\S*)
- # TYPE application_response_time_elapsedTime_seconds gauge
- application_response_time_elapsedTime_seconds (\\S*)
- # TYPE application_response_time_maxTimeDuration_seconds gauge
- application_response_time_maxTimeDuration_seconds (\\S*)
- # TYPE application_response_time_minTimeDuration_seconds gauge
- application_response_time_minTimeDuration_seconds (\\S*)
- """, Pattern.MULTILINE);
- StringBuilder sb = new StringBuilder();
- ensureDataSetTimerClockAdvanced();
- dataSetTimer.prometheusData(sb, dataSetTimerID, true);
- String prometheusData = sb.toString();
- Matcher m = responseTimePattern.matcher(prometheusData);
- if (!m.find()) {
- throw new JUnitException("Could not match Prometheus output " + prometheusData
- + " to expected pattern " + responseTimePattern);
- }
- assertThat("total", Integer.parseInt(m.group(1)), is(200));
- assertThat("elapsedTime", Double.parseDouble(m.group(2)), is(withinTolerance(1.0127E-4, 1.2E-6)));
- assertThat("max", Double.parseDouble(m.group(3)), is(withinTolerance(9.9E-7, 1.2E-9)));
- assertThat("min", Double.parseDouble(m.group(4)), is(withinTolerance(0.0, 0.012)));
-
- // Because the batch of test data does not give non-zero min and max, do a separate test to check those.
- TestClock clock = TestClock.create();
- HelidonSimpleTimer simpleTimer = HelidonSimpleTimer.create("application", meta, clock);
-
- simpleTimer.update(Duration.ofSeconds(4));
- simpleTimer.update(Duration.ofSeconds(3));
-
- clock.add(1, TimeUnit.MINUTES);
- sb = new StringBuilder();
- simpleTimer.prometheusData(sb, dataSetTimerID, true);
- prometheusData = sb.toString();
-
- m = responseTimePattern.matcher(prometheusData);
- if (!m.find()) {
- throw new JUnitException("Could not match Prometheus output " + prometheusData
- + " to expected pattern" + responseTimePattern);
- }
- assertThat("total", Integer.parseInt(m.group(1)), is(2));
- assertThat("elapsedTime", Double.parseDouble(m.group(2)), is(withinTolerance(7.0D, 0.012)));
- assertThat("max", Double.parseDouble(m.group(3)), is(withinTolerance(4.0D, 0.012)));
- assertThat("min", Double.parseDouble(m.group(4)), is(withinTolerance(3.0D, 0.012)));
- }
-
- @Test
- void testNoUpdatesJson() {
- TestClock clock = TestClock.create();
- HelidonSimpleTimer simpleTimer = HelidonSimpleTimer.create("application", meta, clock);
-
- JsonObjectBuilder builder = Json.createObjectBuilder();
- simpleTimer.jsonData(builder, dataSetTimerID);
-
- JsonObject json = builder.build();
- JsonObject metricData = json.getJsonObject("response_time");
-
- assertThat(metricData, notNullValue());
- assertThat("count", metricData.getJsonNumber("count").longValue(), is(0L));
- assertThat("elapsedTime", metricData.getJsonNumber("elapsedTime").doubleValue(), is(0.0D));
- assertThat("maxTimeDuration", metricData.get("maxTimeDuration").getValueType(), is(JsonValue.ValueType.NULL));
- assertThat("minTimeDuration", metricData.get("minTimeDuration").getValueType(), is(JsonValue.ValueType.NULL));
- }
-
@Test
void testDataSetTimerDurations() {
ensureDataSetTimerClockAdvanced();
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonTimerTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonTimerTest.java
index bafc286d59a..2587f9da35f 100644
--- a/metrics/metrics/src/test/java/io/helidon/metrics/HelidonTimerTest.java
+++ b/metrics/metrics/src/test/java/io/helidon/metrics/HelidonTimerTest.java
@@ -19,15 +19,9 @@
import java.time.Duration;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;
-import java.util.stream.Stream;
-import jakarta.json.Json;
-import jakarta.json.JsonNumber;
-import jakarta.json.JsonObject;
-import jakarta.json.JsonObjectBuilder;
import org.eclipse.microprofile.metrics.Metadata;
import org.eclipse.microprofile.metrics.MetricID;
-import org.eclipse.microprofile.metrics.MetricRegistry;
import org.eclipse.microprofile.metrics.MetricType;
import org.eclipse.microprofile.metrics.MetricUnits;
import org.eclipse.microprofile.metrics.Snapshot;
@@ -37,17 +31,12 @@
import org.junit.jupiter.api.Test;
import static io.helidon.metrics.HelidonMetricsMatcher.withinTolerance;
-import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.CoreMatchers.is;
-import static org.hamcrest.CoreMatchers.startsWith;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.closeTo;
import static org.hamcrest.Matchers.equalTo;
-import static org.hamcrest.Matchers.greaterThan;
import static org.hamcrest.Matchers.lessThan;
-import static org.hamcrest.Matchers.notNullValue;
import static org.junit.jupiter.api.Assertions.assertAll;
-import static org.junit.jupiter.api.Assertions.fail;
/**
* Unit test for {@link HelidonTimer}.
@@ -180,108 +169,4 @@ void testSnapshot() {
() -> assertThat("size", snapshot.size(), Matchers.is(200))
);
}
-
- @Test
- void testJson() {
- dataSetTimerClock.addNanos(1, TimeUnit.SECONDS);
- dataSetTimerClock.setMillis(System.currentTimeMillis());
-
- JsonObjectBuilder builder = Json.createObjectBuilder();
- dataSetTimer.jsonData(builder, dataSetTimerID);
-
- JsonObject json = builder.build();
- JsonObject metricData = json.getJsonObject("response_time");
-
- assertThat(metricData, notNullValue());
- assertThat("count", metricData.getJsonNumber("count").longValue(), is(withinTolerance(200L)));
- assertThat("elapsedTime", metricData.getJsonNumber("elapsedTime").longValue(), is(greaterThan(0L))); // less than a second
- assertThat("min", metricData.getJsonNumber("min").longValue(), is(withinTolerance(0L)));
- assertThat("max", metricData.getJsonNumber("max").longValue(), is(withinTolerance(990L)));
- assertThat("mean", metricData.getJsonNumber("mean").doubleValue(), is(withinTolerance(506.349)));
- assertThat("stddev", metricData.getJsonNumber("stddev").doubleValue(), is(withinTolerance(294.389)));
- assertThat(metricData.getJsonNumber("p50").intValue(), is(withinTolerance(480)));
- assertThat(metricData.getJsonNumber("p75").intValue(), is(withinTolerance(750)));
- assertThat(metricData.getJsonNumber("p95").intValue(), is(withinTolerance(960)));
- assertThat(metricData.getJsonNumber("p98").intValue(), is(withinTolerance(980)));
- assertThat(metricData.getJsonNumber("p99").intValue(), is(withinTolerance(980)));
- assertThat(metricData.getJsonNumber("p999").intValue(), is(withinTolerance(990)));
- assertThat(metricData.getJsonNumber("meanRate").intValue(), is(withinTolerance(200)));
- assertThat(metricData.getJsonNumber("oneMinRate").intValue(), is(0));
- assertThat(metricData.getJsonNumber("fiveMinRate").intValue(), is(0));
- assertThat(metricData.getJsonNumber("fifteenMinRate").intValue(), is(0));
- }
-
- @Test
- void testPrometheus() {
- final StringBuilder sb = new StringBuilder();
- dataSetTimer.prometheusData(sb, dataSetTimerID, true);
- final String prometheusData = sb.toString();
- assertThat(prometheusData, startsWith("# TYPE application_response_time_rate_per_second gauge\n"
- + "application_response_time_rate_per_second 200.0\n"
- + "# TYPE application_response_time_one_min_rate_per_second gauge\n"
- + "application_response_time_one_min_rate_per_second 0.0\n"
- + "# TYPE application_response_time_five_min_rate_per_second gauge\n"
- + "application_response_time_five_min_rate_per_second 0.0\n"
- + "# TYPE application_response_time_fifteen_min_rate_per_second gauge\n"
- + "application_response_time_fifteen_min_rate_per_second 0.0\n"
- + "# TYPE application_response_time_mean_seconds gauge\n"
- + "application_response_time_mean_seconds "));
- assertThat(prometheusData, containsString("# TYPE application_response_time_max_seconds gauge\n"
- + "application_response_time_max_seconds "));
-
- assertThat(prometheusData, containsString("# TYPE application_response_time_seconds summary\n"
- + "# HELP application_response_time_seconds Server response time for "
- + "/index.html\n"
- + "application_response_time_seconds_count 200\n"
- + "application_response_time_seconds_sum 0"));
- }
-
- @Test
- void testNaNAvoidance() {
- TestClock testClock = TestClock.create();
- HelidonTimer helidonTimer = HelidonTimer.create("application", meta, testClock);
- MetricID metricID = new MetricID("idleTimer");
-
- JsonObjectBuilder builder = MetricImpl.JSON.createObjectBuilder();
- helidonTimer.update(Duration.ofMillis(1L));
-
- for (int i = 1; i < 48; i++) {
- testClock.add(1L, TimeUnit.HOURS);
- try {
- helidonTimer.jsonData(builder, metricID);
- } catch (Throwable t) {
- fail("Failed after simulating " + i + " hours");
- }
- }
- }
-
- @Test
- void testUnitsOnHistogram() {
- TestClock testClock = TestClock.create();
- String timerName = "jsonDataUnitsTimer";
- Metadata metadata = Metadata.builder()
- .withName(timerName)
- .withDisplayName("Response time test")
- .withDescription("Server response time for checking histo units")
- .withType(MetricType.TIMER)
- .withUnit(MetricUnits.MILLISECONDS)
- .build();
-
- HelidonTimer helidonTimer = HelidonTimer.create(MetricRegistry.Type.APPLICATION.getName(), metadata, testClock);
-
- Stream.of(24L, 28L, 32L, 36L)
- .forEach(value -> {
- testClock.addNanos(450, TimeUnit.MILLISECONDS);
- helidonTimer.update(Duration.ofMillis(value));
- });
- MetricID timerID = new MetricID(timerName);
- JsonObjectBuilder builder = Json.createObjectBuilder();
- helidonTimer.jsonData(builder, timerID);
- JsonObject jsonObject = builder.build();
- JsonObject metricObject = jsonObject.getJsonObject(timerName);
- assertThat("Metric JSON object", metricObject, is(notNullValue()));
- JsonNumber jsonNumber = metricObject.getJsonNumber("min");
- assertThat("Min JSON value", jsonNumber, is(notNullValue()));
- assertThat("Min histo value", jsonNumber.longValue(), is(24L));
- }
}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/MetricImplTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/MetricImplTest.java
deleted file mode 100644
index 4d0699e1f34..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/MetricImplTest.java
+++ /dev/null
@@ -1,194 +0,0 @@
-/*
- * Copyright (c) 2018, 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.helidon.metrics;
-
-import java.io.StringReader;
-import java.util.List;
-import java.util.Optional;
-
-import jakarta.json.Json;
-import jakarta.json.JsonObject;
-import jakarta.json.JsonObjectBuilder;
-import org.eclipse.microprofile.metrics.Metadata;
-import org.eclipse.microprofile.metrics.MetricID;
-import org.eclipse.microprofile.metrics.MetricType;
-import org.eclipse.microprofile.metrics.MetricUnits;
-import org.eclipse.microprofile.metrics.Tag;
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Test;
-
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.core.Is.is;
-import static org.junit.jupiter.api.Assertions.assertAll;
-
-/**
- * Unit test for {@link MetricImpl}.
- */
-class MetricImplTest {
- private static final String JSON_META_MOST = "\"theName\":"
- + "{"
- + "\"unit\":\"none\","
- + "\"type\":\"counter\","
- + "\"description\":\"theDescription\","
- + "\"displayName\":\"theDisplayName\"";
-
- private static final String JSON_META = "{" + JSON_META_MOST + "}}";
- private static final String JSON_META_WITH_TAGS = "{" + JSON_META_MOST
- + ","
- + "\"tags\": ["
- + " [\"a=b\","
- + " \"c=d\" ],"
- + " [\"e=f\","
- + " \"g=h\" ]"
- + "]"
- + "}}";
-
- private static final List METRIC_IDS = List.of(
- new MetricID("name1", new Tag("a", "b"), new Tag("c", "d")),
- new MetricID("name2", new Tag("e", "f"), new Tag("g", "h")));
-
- private static MetricImpl impl;
- private static MetricID implID;
- private static MetricImpl implWithoutDescription;
- private static MetricID implWithoutDescriptionID;
-
- @BeforeAll
- public static void initClass() {
- Metadata meta = Metadata.builder()
- .withName("theName")
- .withDisplayName("theDisplayName")
- .withDescription("theDescription")
- .withType(MetricType.COUNTER)
- .withUnit(MetricUnits.NONE)
- .build();
-
- impl = new MetricImpl("base", meta) {
- @Override
- public String prometheusValue() {
- return "45";
- }
-
- @Override
- public void jsonData(JsonObjectBuilder builder, MetricID metricID) {
- builder.add(metricID.getName(), 45);
- }
- };
- implID = new MetricID(meta.getName());
-
- meta = Metadata.builder()
- .withName("counterWithoutDescription")
- .withType(MetricType.COUNTER)
- .build();
-
- implWithoutDescription = new MetricImpl("base", meta) {
- @Override
- public String prometheusValue() {
- return "45";
- }
-
- @Override
- public void jsonData(JsonObjectBuilder builder, MetricID metricID) {
- builder.add(metricID.getName(), 45);
- }
- };
- implWithoutDescriptionID = new MetricID(meta.getName());
- }
-
- @Test
- void testPrometheusName() {
- assertAll("Various name transformations based on the 3.2.1 section of the spec",
- () -> assertThat(impl.prometheusName("theName"), is("base_theName")),
- () -> assertThat(impl.prometheusName("a.b.c.d"), is("base_a_b_c_d")),
- () -> assertThat(impl.prometheusName("a b c d"), is("base_a_b_c_d")),
- () -> assertThat(impl.prometheusName("a-b-c-d"), is("base_a_b_c_d")),
- () -> assertThat(impl.prometheusName("a2.b.cC.d"), is("base_a2_b_cC_d")),
- () -> assertThat(impl.prometheusName("a:b.c.d"), is("base_a_b_c_d")),
- () -> assertThat(impl.prometheusName("a .b..c_.d"), is("base_a_b_c_d")),
- () -> assertThat(impl.prometheusName("_aB..c_.d"), is("base_aB_c_d")));
- }
-
- @Test
- void testUtilMethods() {
- assertThat(impl.camelToSnake("ahojJakSeMate"), is("ahoj_jak_se_mate"));
- assertThat(impl.prometheusNameWithUnits("the_name", Optional.empty()), is("base_the_name"));
- assertThat(impl.prometheusNameWithUnits("the_name", Optional.of("seconds")), is("base_the_name_seconds"));
- }
-
- @Test
- void testPrometheus() {
- String expected = "# TYPE base_theName counter\n"
- + "# HELP base_theName theDescription\n"
- + "base_theName 45\n";
- final StringBuilder sb = new StringBuilder();
- impl.prometheusData(sb, implID, true);
- assertThat(sb.toString(), is(expected));
- }
-
- @Test
- void testPrometheusWithoutDescription() {
- String expected = "# TYPE base_counterWithoutDescription counter\n"
- + "# HELP base_counterWithoutDescription \n"
- + "base_counterWithoutDescription 45\n";
- final StringBuilder sb = new StringBuilder();
- implWithoutDescription.prometheusData(sb, implWithoutDescriptionID, true);
- assertThat(sb.toString(), is(expected));
- }
-
- @Test
- void testPrometheusWithoutTypeAndHelp() {
- String expected = "base_counterWithoutDescription 45\n";
- final StringBuilder sb = new StringBuilder();
- implWithoutDescription.prometheusData(sb, implWithoutDescriptionID, false);
- assertThat(sb.toString(), is(expected));
- }
-
- @Test
- void testJsonData() {
- JsonObjectBuilder builder = Json.createObjectBuilder();
- builder.add("theName", 45);
- JsonObject expected = builder.build();
-
- builder = Json.createObjectBuilder();
- impl.jsonData(builder, new MetricID("theName"));
- assertThat(builder.build(), is(expected));
- }
-
- @Test
- void testJsonMeta() {
- JsonObject expected = Json.createReader(new StringReader(JSON_META)).readObject();
-
- JsonObjectBuilder builder = Json.createObjectBuilder();
- impl.jsonMeta(builder, null);
- assertThat(builder.build(), is(expected));
- }
-
- @Test
- void testJsonMetaWithTags() {
- JsonObject expected = Json.createReader(new StringReader(JSON_META_WITH_TAGS)).readObject();
-
- JsonObjectBuilder builder = Json.createObjectBuilder();
- impl.jsonMeta(builder, METRIC_IDS);
- assertThat(builder.build(), is(expected));
- }
-
- @Test
- void testJsonEscaping() {
- assertThat(MetricImpl.jsonEscape("plain"), is("plain"));
- assertThat(MetricImpl.jsonEscape("not\bplain\tby\"a\nlong\\shot"),
- is("not\\bplain\\tby\\\"a\\nlong\\\\shot"));
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/MetricsSupportTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/MetricsSupportTest.java
deleted file mode 100644
index ddad8734a29..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/MetricsSupportTest.java
+++ /dev/null
@@ -1,213 +0,0 @@
-/*
- * Copyright (c) 2018, 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.helidon.metrics;
-
-import java.io.BufferedReader;
-import java.io.StringReader;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
-
-import io.helidon.config.Config;
-import io.helidon.config.ConfigSources;
-
-import jakarta.json.Json;
-import jakarta.json.JsonArray;
-import jakarta.json.JsonBuilderFactory;
-import jakarta.json.JsonNumber;
-import jakarta.json.JsonObject;
-import jakarta.json.JsonObjectBuilder;
-import org.eclipse.microprofile.metrics.ConcurrentGauge;
-import org.eclipse.microprofile.metrics.Counter;
-import org.eclipse.microprofile.metrics.MetricID;
-import org.eclipse.microprofile.metrics.MetricRegistry;
-import org.eclipse.microprofile.metrics.Tag;
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Test;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertNotNull;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
-/**
- * Unit test for {@link MetricsSupport}.
- */
-class MetricsSupportTest {
-
- private static Registry base;
- private static Registry vendor;
- private static Registry app;
-
- private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Collections.emptyMap());
-
- private static final MetricID METRIC_USED_HEAP = new MetricID("memory.usedHeap");
-
- private static final String CONCURRENT_GAUGE_NAME = "appConcurrentGauge";
- private static final int RED_CONCURRENT_GAUGE_COUNT = 1;
- private static final int BLUE_CONCURRENT_GAUGE_COUNT = 2;
-
- private static String globalTagsJsonSuffix;
-
- @BeforeAll
- static void initClass() {
- RegistryFactory rf = (RegistryFactory) io.helidon.metrics.api.RegistryFactory.getInstance();
- base = rf.getARegistry(MetricRegistry.Type.BASE);
- vendor = rf.getARegistry(MetricRegistry.Type.VENDOR);
- app = rf.getARegistry(MetricRegistry.Type.APPLICATION);
-
- Counter counter = app.counter("appCounter",
- new Tag("color", "blue"), new Tag("brightness", "dim"));
- counter.inc();
-
- ConcurrentGauge concurrentGauge = app.concurrentGauge(CONCURRENT_GAUGE_NAME, new Tag("color", "blue"));
- for (int i = 0; i < BLUE_CONCURRENT_GAUGE_COUNT; i++) {
- concurrentGauge.inc();
- }
-
- concurrentGauge = app.concurrentGauge(CONCURRENT_GAUGE_NAME, new Tag("color", "red"));
- for (int i = 0; i < RED_CONCURRENT_GAUGE_COUNT; i++) {
- concurrentGauge.inc();
- }
-
- String globalTags = System.getenv("MP_METRICS_TAGS");
- if (globalTags == null) {
- globalTagsJsonSuffix = "";
- } else {
- globalTagsJsonSuffix = ";" + globalTags.replaceAll(",", ";");
- }
- }
-
- @Test
- void testPrometheusDataAll() {
- String data = MetricsSupport.toPrometheusData(app);
- System.out.println(data);
- }
-
- @Test
- void testPrometheusDataMultiple() {
- String data = MetricsSupport.toPrometheusData(app, base);
- System.out.println(data);
- }
-
- @Test
- void testJsonDataAll() {
- JsonObject jsonObject = MetricsSupport.toJsonData(app);
- System.out.println("jsonObject = " + jsonObject);
- }
-
- @Test
- void testJsonDataMultiple() {
- JsonObject jsonObject = MetricsSupport.toJsonData(app, base);
- System.out.println("jsonObject = " + jsonObject);
- }
-
- @Test
- void testJsonMetaAll() {
- JsonObject jsonObject = MetricsSupport.toJsonMeta(app);
- System.out.println("jsonObject = " + jsonObject);
- }
-
- @Test
- void testJsonMetaMultiple() {
- JsonObject jsonObject = MetricsSupport.toJsonMeta(app, base);
- System.out.println("jsonObject = " + jsonObject);
- }
-
- @Test
- void testJsonDataWithTags() {
- JsonObject jsonObject = MetricsSupport.toJsonData(app);
- // Check for presence of tags and correct ordering.
- assertTrue(jsonObject.containsKey("appCounter;brightness=dim;color=blue"));
- }
-
- @Test
- void testMergingJsonObjectBuilder() {
- JsonObjectBuilder builder = MetricsSupport.createMergingJsonObjectBuilder(JSON.createObjectBuilder());
- builder.add("commonObj", JSON.createObjectBuilder()
- .add("intA", 4)
- .add("longB", 6l))
- .add("commonArray", JSON.createArrayBuilder()
- .add("integration")
- .add(6))
- .add("otherStuff", "this really is other stuff")
- .add("commonArray", JSON.createArrayBuilder()
- .add("demo")
- .add(7))
- .add("commonObj", JSON.createObjectBuilder()
- .add("doubleA", 8d)
- .add("differentStuff", "this is even more different"));
- JsonObject jo = builder.build();
-
- JsonObject commonObj = jo.getJsonObject("commonObj");
- assertEquals(4, commonObj.getInt("intA"));
- assertEquals(8d, commonObj.getJsonNumber("doubleA").doubleValue());
-
- assertEquals("this really is other stuff", jo.getString("otherStuff"));
-
- JsonArray commonArray = jo.getJsonArray("commonArray");
- assertEquals("integration", commonArray.getJsonArray(0).getString(0));
- assertEquals(6, commonArray.getJsonArray(0).getInt(1));
- assertEquals("demo", commonArray.getJsonArray(1).getString(0));
- assertEquals(7, commonArray.getJsonArray(1).getInt(1));
- }
-
- @Test
- void testBaseMetricsDisabled() {
- Config config = Config.builder()
- .sources(ConfigSources.create(Map.of(
- "base.enabled", "false")))
- .build();
- RegistryFactory myRF = (RegistryFactory) io.helidon.metrics.api.RegistryFactory.create(config);
- Registry myBase = myRF.getARegistry(MetricRegistry.Type.BASE);
- assertFalse(myBase.getGauges().containsKey(METRIC_USED_HEAP), "Base registry incorrectly contains "
- + METRIC_USED_HEAP + " when base was configured as disabled");
- }
-
- @Test
- void testPrometheusDataNoTypeDups() throws Exception {
- Set found = new HashSet<>();
- String data = MetricsSupport.toPrometheusData(app, base);
- try (BufferedReader reader = new BufferedReader(new StringReader(data))) {
- String line;
- while ((line = reader.readLine()) != null) {
- String[] tokens = line.split(" ");
- if (tokens.length > 3 && tokens[1].equals("TYPE")) {
- String metric = tokens[2];
- assertFalse(found.contains(metric));
- found.add(metric);
- }
- }
- }
- }
-
- @Test
- void testJsonDataMultipleMetricsSameName() {
- // Make sure the JSON format for all metrics matching a name lists the name once with tagged instances as children.
- JsonObject multiple = MetricsSupport.jsonDataByName(app, CONCURRENT_GAUGE_NAME);
- assertNotNull(multiple);
- JsonObject top = multiple.getJsonObject(CONCURRENT_GAUGE_NAME);
- assertNotNull(top);
- JsonNumber blueNumber = top.getJsonNumber("current;color=blue" + globalTagsJsonSuffix);
- assertNotNull(blueNumber);
- assertEquals(BLUE_CONCURRENT_GAUGE_COUNT, blueNumber.longValue());
- JsonNumber redNumber = top.getJsonNumber("current;color=red" + globalTagsJsonSuffix);
- assertNotNull(redNumber);
- assertEquals(RED_CONCURRENT_GAUGE_COUNT, redNumber.longValue());
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/OutputUnitConversionTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/OutputUnitConversionTest.java
deleted file mode 100644
index 2b6097c19a4..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/OutputUnitConversionTest.java
+++ /dev/null
@@ -1,166 +0,0 @@
-/*
- * Copyright (c) 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import java.time.Duration;
-import java.time.temporal.ChronoUnit;
-import java.util.concurrent.TimeUnit;
-
-import jakarta.json.Json;
-import jakarta.json.JsonNumber;
-import jakarta.json.JsonObject;
-import jakarta.json.JsonObjectBuilder;
-
-import org.eclipse.microprofile.metrics.Metadata;
-import org.eclipse.microprofile.metrics.MetricID;
-import org.eclipse.microprofile.metrics.MetricType;
-import org.eclipse.microprofile.metrics.MetricUnits;
-import org.junit.jupiter.api.Test;
-
-import static io.helidon.metrics.HelidonMetricsMatcher.withinTolerance;
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.is;
-import static org.hamcrest.Matchers.notNullValue;
-
-public class OutputUnitConversionTest {
-
- private static final String TIMER_NAME = "myTimer";
- private static MetricID TIMER_METRIC_ID;
-
- private static final String SIMPLE_TIMER_NAME = "mySimpleTimer";
- private static MetricID SIMPLE_TIMER_METRIC_ID;
-
- private static final int TIMER_UPDATE_INCREMENT_MICRO_SECONDS = 120; // microseconds
-
- private HelidonTimer prepTimer() {
- TIMER_METRIC_ID = new MetricID(TIMER_NAME);
- TestClock clock = TestClock.create();
- HelidonTimer result = HelidonTimer.create("application", Metadata.builder()
- .withName(TIMER_NAME)
- .withUnit(MetricUnits.MILLISECONDS)
- .withType(MetricType.TIMER)
- .build(),
- clock);
- clock.add(1, TimeUnit.MICROSECONDS);
- result.update(Duration.of(TIMER_UPDATE_INCREMENT_MICRO_SECONDS, ChronoUnit.MICROS));
-
- // Advance the clock so most-recent-whole-minute stats have meaning.
- clock.add(1, TimeUnit.MINUTES);
- return result;
- }
-
- private HelidonSimpleTimer prepSimpleTimer() {
- SIMPLE_TIMER_METRIC_ID = new MetricID(SIMPLE_TIMER_NAME);
- TestClock clock = TestClock.create();
- HelidonSimpleTimer result = HelidonSimpleTimer.create("application", Metadata.builder()
- .withName(SIMPLE_TIMER_NAME)
- .withUnit(MetricUnits.MILLISECONDS)
- .withType(MetricType.SIMPLE_TIMER)
- .build(),
- clock);
- clock.add(1, TimeUnit.MICROSECONDS);
- result.update(Duration.of(TIMER_UPDATE_INCREMENT_MICRO_SECONDS, ChronoUnit.MICROS));
-
- // Advance the clock.
- clock.add(1, TimeUnit.MINUTES);
- return result;
- }
-
- @Test
- void testPrometheusTimerConversion() {
-
- StringBuilder prometheusSB = new StringBuilder();
- HelidonTimer hTimer = prepTimer();
- hTimer.prometheusData(prometheusSB, TIMER_METRIC_ID, false);
- double expectedValue = 0.000120D;
- // The Prometheus exposition format always represents time in seconds.
- for (String suffix : new String[] {"_mean_seconds",
- "_seconds{quantile=\"0.5\"}",
- "_seconds{quantile=\"0.75\"}",
- "_seconds{quantile=\"0.95\"}",
- "_seconds{quantile=\"0.98\"}",
- "_seconds{quantile=\"0.99\"}",
- "_seconds{quantile=\"0.999\"}"
- }) {
- String label = "application_" + TIMER_NAME + suffix;
- double v = TestUtils.valueAfterLabel(prometheusSB.toString(), label, Double::parseDouble);
- assertThat("Prometheus data for " + label, v, is(expectedValue));
- }
- }
-
- @Test
- void testPrometheusSimpleTimerConversion() {
- StringBuilder prometheusSB = new StringBuilder();
- HelidonSimpleTimer hSimpleTimer = prepSimpleTimer();
- hSimpleTimer.prometheusData(prometheusSB, SIMPLE_TIMER_METRIC_ID, false);
- // We updated the simple timer by 120 microseconds. Although the simple timer units were set to ms, Prometheus output
- // always is in seconds (for times).
- Duration expectedElapsedTime = Duration.of(TIMER_UPDATE_INCREMENT_MICRO_SECONDS, ChronoUnit.MICROS);
- double expectedElapsedTimeInSeconds = expectedElapsedTime.toNanos() / 1000.0 / 1000.0 / 1000.0;
- for (String label : new String[] {"elapsedTime", "maxTimeDuration", "minTimeDuration"}) {
- String name = "application_" + SIMPLE_TIMER_NAME + "_" + label + "_seconds";
- double v = TestUtils.valueAfterLabel(prometheusSB.toString(), name, Double::parseDouble);
- assertThat("SimpleTimer Prometheths elapsed time",
- v,
- is(withinTolerance(expectedElapsedTimeInSeconds, 1.2E-10)));
- }
- }
-
- @Test
- void testTimerJsonOutput() {
-
- HelidonTimer hTimer = prepTimer();
- JsonObjectBuilder builder = Json.createObjectBuilder();
- hTimer.jsonData(builder, TIMER_METRIC_ID);
-
- JsonObject json = builder.build()
- .getJsonObject(TIMER_NAME);
- assertThat("Metric JSON object", json, notNullValue());
-
- // We updated timer by 120 microseconds. The timer units are ms, so the reported values should be 0.120 because
- // JSON output honors the units in the metric's metadata.
- double expectedValue = TIMER_UPDATE_INCREMENT_MICRO_SECONDS / 1000.0;
- for (String suffix : new String[] {"mean", "p50", "p75", "p95", "p98", "p99", "p999"}) {
- JsonNumber number = json.getJsonNumber(suffix);
- assertThat("JsonNumber for data item " + suffix, number, notNullValue());
- assertThat("JSON value for " + suffix, number.doubleValue(), is(expectedValue));
- }
- }
-
- @Test
- void testSimpleTimerJsonOutput() {
- HelidonSimpleTimer hSimpleTimer = prepSimpleTimer();
- JsonObjectBuilder builder = Json.createObjectBuilder();
- hSimpleTimer.jsonData(builder, SIMPLE_TIMER_METRIC_ID);
-
- JsonObject json = builder.build()
- .getJsonObject(SIMPLE_TIMER_NAME);
- assertThat("Metric JSON object", json, notNullValue());
-
- // We updated the simple timer by 120 microseconds. The simple timer units were set to ms, so the reported value should
- // be 0.120 because JSON output honors the units in the metric's metadata.
- Duration expectedElapsedTime = Duration.of(TIMER_UPDATE_INCREMENT_MICRO_SECONDS, ChronoUnit.MICROS);
- double expectedElapsedTimeInMillis = expectedElapsedTime.toNanos() / 1000.0 / 1000.0;
- assertThat("SimpleTimer elapsed time", hSimpleTimer.getElapsedTime(), is(expectedElapsedTime));
- for (String label : new String[] {"elapsedTime", "maxTimeDuration", "minTimeDuration"}) {
- JsonNumber number = json.getJsonNumber(label);
- assertThat("JsonNumber for " + label, number, notNullValue());
- assertThat("JSON value for " + label,
- number.doubleValue(),
- is(withinTolerance(expectedElapsedTimeInMillis, 1.2E-7)));
- }
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/TestNearestValueSearch.java b/metrics/metrics/src/test/java/io/helidon/metrics/TestNearestValueSearch.java
index ba4493d8a24..b77537513c4 100644
--- a/metrics/metrics/src/test/java/io/helidon/metrics/TestNearestValueSearch.java
+++ b/metrics/metrics/src/test/java/io/helidon/metrics/TestNearestValueSearch.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2021 Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@
import org.junit.jupiter.api.Test;
-import static io.helidon.metrics.Sample.derived;
+import static io.helidon.metrics.api.Sample.derived;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/TestPrometheusOutputWithTags.java b/metrics/metrics/src/test/java/io/helidon/metrics/TestPrometheusOutputWithTags.java
deleted file mode 100644
index 7a377641416..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/TestPrometheusOutputWithTags.java
+++ /dev/null
@@ -1,97 +0,0 @@
-/*
- * Copyright (c) 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import java.io.IOException;
-import java.io.LineNumberReader;
-import java.io.StringReader;
-import java.util.concurrent.TimeUnit;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-
-import io.helidon.metrics.api.RegistryFactory;
-
-import org.eclipse.microprofile.metrics.Histogram;
-import org.eclipse.microprofile.metrics.MetricID;
-import org.eclipse.microprofile.metrics.MetricRegistry;
-import org.eclipse.microprofile.metrics.Tag;
-import org.eclipse.microprofile.metrics.Timer;
-import org.junit.jupiter.api.Test;
-
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.allOf;
-import static org.hamcrest.Matchers.containsString;
-
-class TestPrometheusOutputWithTags {
-
- @Test
- void testTimerOutputWithTags() throws InterruptedException, IOException {
-
- MetricRegistry registry = RegistryFactory.create().getRegistry(MetricRegistry.Type.APPLICATION);
- Tag[] tags = new Tag[] {new Tag("class", getClass().getName()),
- new Tag("method", "anyMethod")};
- MetricID metricID = new MetricID("mytimer", tags);
- Timer timer = registry.timer("myTimer", tags);
- Timer.Context timerContext = timer.time();
-
- TimeUnit.SECONDS.sleep(1);
- timerContext.stop();
-
- HelidonTimer hTimer = (HelidonTimer) timer;
- StringBuilder sb = new StringBuilder();
- hTimer.prometheusData(sb, metricID, false);
-
- LineNumberReader reader = new LineNumberReader(new StringReader(sb.toString()));
-
- String line;
- while ((line = reader.readLine()) != null) {
- for (String time : new String[] {"one", "five", "fifteen"}) {
- if (line.startsWith("application_mytimer_" + time + "_min_rate_per_second")) {
- assertThat("Tag portions of OpenMetrics output", line, allOf(
- containsString("class=\"" + getClass().getName() + "\""),
- containsString("method=\"anyMethod\"")));
- }
- }
- }
- }
-
- @Test
- void testHistogramOutputWithTags() throws IOException {
- MetricRegistry registry = RegistryFactory.create().getRegistry(MetricRegistry.Type.APPLICATION);
- Tag[] tags = new Tag[] {new Tag("class", getClass().getName()),
- new Tag("method", "anyMethod")};
- MetricID metricID = new MetricID("myhisto", tags);
- Histogram histogram = registry.histogram("myhisto", tags);
-
- Stream.of(1,4,9)
- .forEach(histogram::update);
-
- HelidonHistogram hHistogram = (HelidonHistogram) histogram;
- StringBuilder sb = new StringBuilder();
- hHistogram.prometheusData(sb, metricID, false);
-
- LineNumberReader reader = new LineNumberReader(new StringReader(sb.toString()));
-
- String line;
- while ((line = reader.readLine()) != null) {
- if (line.startsWith("application_myhisto_")) {
- assertThat("Tag portions of OpenMetrics output", line, allOf(
- containsString("class=\"" + getClass().getName() + "\""),
- containsString("method=\"anyMethod\"")));
- }
- }
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/TestServer.java b/metrics/metrics/src/test/java/io/helidon/metrics/TestServer.java
deleted file mode 100644
index ea96e03330e..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/TestServer.java
+++ /dev/null
@@ -1,212 +0,0 @@
-/*
- * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import java.time.Duration;
-import java.util.Optional;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-import io.helidon.common.http.Http;
-import io.helidon.common.media.type.MediaTypes;
-import io.helidon.reactive.media.jsonp.JsonpSupport;
-import io.helidon.reactive.webclient.WebClient;
-import io.helidon.reactive.webclient.WebClientRequestBuilder;
-import io.helidon.reactive.webclient.WebClientResponse;
-import io.helidon.reactive.webserver.Routing;
-import io.helidon.reactive.webserver.Service;
-import io.helidon.reactive.webserver.WebServer;
-
-import jakarta.json.JsonObject;
-import org.eclipse.microprofile.metrics.ConcurrentGauge;
-import org.eclipse.microprofile.metrics.MetricRegistry;
-import org.junit.jupiter.api.AfterAll;
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Test;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.ValueSource;
-
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.containsInAnyOrder;
-import static org.hamcrest.Matchers.greaterThan;
-import static org.hamcrest.Matchers.hasKey;
-import static org.hamcrest.Matchers.is;
-import static org.hamcrest.Matchers.not;
-
-public class TestServer {
-
- private static final Logger LOGGER = Logger.getLogger(TestServer.class.getName());
- private static final Duration CLIENT_TIMEOUT = Duration.ofSeconds(Integer.getInteger("io.helidon.test.clientTimeoutSec", 10));
- private static final String[] EXPECTED_NO_CACHE_HEADER_SETTINGS = {"no-cache", "no-store", "must-revalidate", "no-transform"};
-
- private static WebServer webServer;
-
- private static final MetricsSupport.Builder NORMAL_BUILDER = MetricsSupport.builder();
-
- private static MetricsSupport metricsSupport;
- private static WebClient.Builder webClientBuilder;
-
- @BeforeAll
- public static void startup() {
- metricsSupport = NORMAL_BUILDER.build();
- webServer = startServer(metricsSupport, new GreetService());
- webClientBuilder = WebClient.builder()
- .baseUri("http://localhost:" + webServer.port() + "/")
- .addMediaSupport(JsonpSupport.create());
- }
-
- @AfterAll
- public static void shutdown() {
- shutdownServer(webServer);
- }
-
- static WebServer startServer(Service... services) {
- WebServer server = WebServer.builder(
- Routing.builder()
- .register(services)
- .build())
- .port(0)
- .build()
- .start()
- .await(Duration.ofSeconds(20));
- LOGGER.log(Level.INFO, "Started server at: https://localhost:{0}", server.port());
- return server;
- }
-
- static void shutdownServer(WebServer server) {
- server.shutdown();
- }
-
- @Test
- public void checkNormalURL() {
- WebClientResponse response = webClientBuilder
- .build()
- .get()
- .accept(MediaTypes.APPLICATION_JSON)
- .path("metrics")
- .submit()
- .await(CLIENT_TIMEOUT);
-
- assertThat("Normal metrics URL HTTP response", response.status().code(), is(200));
-
- JsonObject metrics = response.content().as(JsonObject.class).await(CLIENT_TIMEOUT);
- assertThat("Vendor metrics in returned entity", metrics.containsKey("vendor"), is(true));
- }
-
- @Test
- public void checkVendorURL() {
- WebClientResponse response = webClientBuilder
- .build()
- .get()
- .accept(MediaTypes.APPLICATION_JSON)
- .path("metrics/vendor")
- .submit()
- .await(CLIENT_TIMEOUT);
-
- assertThat("Normal metrics/vendor URL HTTP response", response.status().code(), is(200));
-
- JsonObject metrics = response.content().as(JsonObject.class).await(CLIENT_TIMEOUT);
- if (System.getenv("MP_METRICS_TAGS") == null) {
- // MP_METRICS_TAGS causes metrics to add tags to metric IDs. Just do this check in the simple case, without tags.
- assertThat("Vendor metrics requests.count in returned entity", metrics.containsKey("requests.count"), is(true));
- assertThat("Vendor metrics requests.meter in returned entity", metrics.containsKey("requests.meter"), is(true));
-
- // Even accesses to the /metrics endpoint should affect the metrics. Make sure.
- int count = metrics.getInt("requests.count");
- assertThat("requests.count", count, is(greaterThan(0)));
-
- JsonObject meter = metrics.getJsonObject("requests.meter");
- int meterCount = meter.getInt("count");
- assertThat("requests.meter count", meterCount, is(greaterThan(0)));
-
- double meterRate = meter.getJsonNumber("meanRate").doubleValue();
- assertThat("requests.meter meanRate", meterRate, is(greaterThan(0.0)));
- }
- }
-
- @Test
- void checkKPIDisabledByDefault() {
- boolean isKPIEnabled = metricsSupport.keyPerformanceIndicatorMetricsConfig().isExtended();
-
- MetricRegistry vendorRegistry = io.helidon.metrics.api.RegistryFactory.getInstance()
- .getRegistry(MetricRegistry.Type.VENDOR);
-
- Optional inflightRequests =
- vendorRegistry.getConcurrentGauges((metricID, metric) -> metricID.getName().endsWith(
- KeyPerformanceIndicatorMetricsImpls.INFLIGHT_REQUESTS_NAME))
- .values().stream()
- .findAny();
- assertThat("In-flight concurrent gauge metric exists", inflightRequests.isPresent(), is(isKPIEnabled));
- }
-
- @Test
- void checkMetricsForExecutorService() throws InterruptedException {
-
- // Because ThreadPoolExecutor methods are documented as reporting approximations of task counts, etc., we should
- // not depend on the values changing in a reasonable time period...or at all. So this test simply makes sure that
- // an expected metric is present.
- String jsonKeyForCompleteTaskCountInThreadPool =
- "executor-service.completed-task-count;poolIndex=0;supplierCategory=my-thread-thread-pool-1;supplierIndex=0";
-
- WebClientRequestBuilder metricsRequestBuilder = webClientBuilder
- .build()
- .get()
- .accept(MediaTypes.APPLICATION_JSON)
- .path("metrics/vendor");
-
- WebClientResponse response = metricsRequestBuilder
- .submit()
- .await(CLIENT_TIMEOUT);
-
- assertThat("Normal metrics/vendor URL HTTP response", response.status().code(), is(200));
-
- JsonObject metrics = response.content().as(JsonObject.class).await(CLIENT_TIMEOUT);
-
- assertThat("JSON metrics results before accessing slow endpoint",
- metrics,
- hasKey(jsonKeyForCompleteTaskCountInThreadPool));
- }
-
- @ParameterizedTest
- @ValueSource(strings = {"", "/base", "/vendor", "/application"})
- void testCacheSuppression(String pathSuffix) {
- String requestPath = "/metrics" + pathSuffix;
-
- WebClientResponse response = webClientBuilder
- .build()
- .get()
- .accept(MediaTypes.APPLICATION_JSON)
- .path(requestPath)
- .submit()
- .await(CLIENT_TIMEOUT);
-
- assertThat("Headers suppressing caching",
- response.headers().values(Http.Header.CACHE_CONTROL),
- containsInAnyOrder(EXPECTED_NO_CACHE_HEADER_SETTINGS));
-
- response = webClientBuilder
- .build()
- .options()
- .accept(MediaTypes.APPLICATION_JSON)
- .path(requestPath)
- .submit()
- .await(CLIENT_TIMEOUT);
-
- assertThat ("Headers suppressing caching in OPTIONS request",
- response.headers().values(Http.Header.CACHE_CONTROL),
- not(containsInAnyOrder(EXPECTED_NO_CACHE_HEADER_SETTINGS)));
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/TestServerWithKeyPerformanceIndicatorMetrics.java b/metrics/metrics/src/test/java/io/helidon/metrics/TestServerWithKeyPerformanceIndicatorMetrics.java
deleted file mode 100644
index cc3f0a6327b..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/TestServerWithKeyPerformanceIndicatorMetrics.java
+++ /dev/null
@@ -1,103 +0,0 @@
-/*
- * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import java.util.Optional;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.TimeoutException;
-
-import io.helidon.common.http.HttpMediaType;
-import io.helidon.common.reactive.Single;
-import io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings;
-import io.helidon.reactive.media.jsonp.JsonpSupport;
-import io.helidon.reactive.webclient.WebClient;
-import io.helidon.reactive.webserver.WebServer;
-
-import org.eclipse.microprofile.metrics.ConcurrentGauge;
-import org.eclipse.microprofile.metrics.MetricRegistry;
-import org.junit.jupiter.api.AfterAll;
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
-
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.is;
-
-class TestServerWithKeyPerformanceIndicatorMetrics {
-
- private static WebServer webServer;
-
- private static final MetricsSupport.Builder KPI_ENABLED_BUILDER = MetricsSupport.builder()
- .keyPerformanceIndicatorsMetricsSettings(KeyPerformanceIndicatorMetricsSettings.builder()
- .extended(true));
-
- private static MetricsSupport metricsSupport;
-
- private WebClient.Builder webClientBuilder;
-
- @BeforeAll
- public static void startup() throws InterruptedException, ExecutionException, TimeoutException {
- metricsSupport = KPI_ENABLED_BUILDER.build();
- webServer = TestServer.startServer(metricsSupport, new GreetService());
- }
-
- @BeforeEach
- public void prepareWebClientBuilder() {
- webClientBuilder = WebClient.builder()
- .baseUri("http://localhost:" + webServer.port() + "/")
- .addMediaSupport(JsonpSupport.create());
- }
-
- @AfterAll
- public static void shutdown() {
- TestServer.shutdownServer(webServer);
- }
-
- @Test
- void checkInflightRequests() throws InterruptedException, ExecutionException {
-
- boolean isKPIEnabled = metricsSupport.keyPerformanceIndicatorMetricsConfig().isExtended();
-
- MetricRegistry vendorRegistry = io.helidon.metrics.api.RegistryFactory.getInstance()
- .getRegistry(MetricRegistry.Type.VENDOR);
-
- Optional inflightRequests =
- vendorRegistry.getConcurrentGauges((metricID, metric) -> metricID.getName().endsWith(
- KeyPerformanceIndicatorMetricsImpls.INFLIGHT_REQUESTS_NAME))
- .values().stream()
- .findAny();
- assertThat("In-flight concurrent gauge metric exists", inflightRequests.isPresent(), is(isKPIEnabled));
-
- long inflightBefore = inflightRequests.get().getCount();
-
- GreetService.initSlowRequest();
- Single response = webClientBuilder
- .build()
- .get()
- .accept(HttpMediaType.APPLICATION_JSON)
- .path("greet/slow")
- .request(String.class);
- GreetService.awaitSlowRequestStarted();
- long inflightDuring = inflightRequests.get().getCount();
-
- String result = response.get();
-
- assertThat("Returned result", result, is(GreetService.GREETING_RESPONSE));
- assertThat("Change in inflight requests during invocation", inflightDuring - inflightBefore, is(1L));
- assertThat("Net change in inflight requests after invocation", inflightRequests.get().getCount(), is(inflightBefore));
-
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/TestStorageUnitsScaling.java b/metrics/metrics/src/test/java/io/helidon/metrics/TestStorageUnitsScaling.java
deleted file mode 100644
index 332b41cfe54..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/TestStorageUnitsScaling.java
+++ /dev/null
@@ -1,89 +0,0 @@
-/*
- * Copyright (c) 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
-import org.eclipse.microprofile.metrics.Gauge;
-import org.eclipse.microprofile.metrics.Metadata;
-import org.eclipse.microprofile.metrics.MetricID;
-import org.eclipse.microprofile.metrics.MetricType;
-import org.eclipse.microprofile.metrics.MetricUnits;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.Arguments;
-import org.junit.jupiter.params.provider.MethodSource;
-import org.junit.platform.commons.JUnitException;
-
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.is;
-
-/**
- * Prometheus output should always express storage quantities in bytes. This test makes sure that the output is correct and
- * has the correctly-scaled value for each of the units in the storage family.
- */
-public class TestStorageUnitsScaling {
-
- private static final int EXPECTED_VALUE = 656;
-
- @ParameterizedTest
- @MethodSource("scalingValues")
- void checkGaugeScaling(String units, long expectedValue) {
- Metadata gaugeMetadata = Metadata.builder()
- .withName("myGauge")
- .withType(MetricType.GAUGE)
- .withUnit(units)
- .build();
-
- Gauge myGauge = () -> EXPECTED_VALUE;
-
- HelidonGauge hGauge = HelidonGauge.create("application", gaugeMetadata, myGauge);
- MetricID gaugeMetricID = new MetricID(gaugeMetadata.getName());
-
- StringBuilder sb = new StringBuilder();
- hGauge.prometheusData(sb, gaugeMetricID, true);
-
- Pattern pattern = Pattern.compile("# TYPE application_myGauge_bytes gauge\n"
- + "# HELP application_myGauge_bytes \n"
- + "application_myGauge_bytes (\\S*)");
-
- Matcher matcher = pattern.matcher(sb.toString());
-
- if (!matcher.find()) {
- throw new JUnitException("Unable to match Prometheus output " + sb + " to expected pattern " + pattern);
- }
- assertThat("Scaled " + EXPECTED_VALUE + " " + units, Long.parseLong(matcher.group(1)), is(expectedValue));
- }
-
- private static Arguments[] scalingValues() {
- long expected = EXPECTED_VALUE;
- return new Arguments[] {
- Arguments.arguments(MetricUnits.BYTES, expected),
- Arguments.arguments(MetricUnits.KILOBYTES, expected * 1000),
- Arguments.arguments(MetricUnits.MEGABYTES, expected * 1000 * 1000),
- Arguments.arguments(MetricUnits.GIGABYTES, expected * 1000 * 1000 * 1000),
-
- Arguments.arguments(MetricUnits.BITS, expected / 8),
- Arguments.arguments(MetricUnits.KILOBITS, expected / 8 * 1000),
- Arguments.arguments(MetricUnits.MEGABITS, expected / 8 * 1000 * 1000),
- Arguments.arguments(MetricUnits.GIGABITS, expected / 8 * 1000 * 1000 * 1000),
-
- Arguments.arguments(MetricUnits.KIBIBITS, expected / 8 * 1024),
- Arguments.arguments(MetricUnits.MEBIBITS, expected / 8 * 1024 * 1024),
- Arguments.arguments(MetricUnits.GIBIBITS, expected / 8 * 1024 * 1024 * 1024)
- };
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/TestUtils.java b/metrics/metrics/src/test/java/io/helidon/metrics/TestUtils.java
deleted file mode 100644
index e2ff1a47d6f..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/TestUtils.java
+++ /dev/null
@@ -1,53 +0,0 @@
-/*
- * Copyright (c) 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics;
-
-import java.time.Duration;
-import java.util.function.Function;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
-import org.eclipse.microprofile.metrics.MetricUnits;
-import org.junit.platform.commons.JUnitException;
-
-class TestUtils {
- static long secondsToMetricUnits(String metricUnits, Duration duration) {
- return switch (metricUnits) {
- case MetricUnits.SECONDS -> duration.toSeconds();
- case MetricUnits.NANOSECONDS -> duration.toNanos();
- case MetricUnits.MICROSECONDS -> duration.toNanos() / 1000;
- case MetricUnits.MILLISECONDS -> duration.toMillis();
- default -> throw new IllegalArgumentException("Unrecognized metric units value " + metricUnits);
- };
- }
-
- /**
- * Locates and extracts a numeric value preceded on the same line by the specified label within a larger string.
- *
- * @param wholeString the entire String to be searched
- * @param label the identifying label preceding the value to be parsed
- * @return the double of the matched value
- */
- static T valueAfterLabel(String wholeString, String label, Function parser) {
- Pattern pattern = Pattern.compile("^" + Pattern.quote(label) + "\\s*(\\S*)$", Pattern.MULTILINE);
- Matcher matcher = pattern.matcher(wholeString);
- if (!matcher.find()) {
- throw new JUnitException("Unable to find value with label " + label + " in string " + wholeString);
- }
- String valueText = matcher.group(1);
- return parser.apply(valueText);
- }
-}
diff --git a/metrics/metrics/src/test/java/io/helidon/metrics/TimeUnitsTest.java b/metrics/metrics/src/test/java/io/helidon/metrics/TimeUnitsTest.java
deleted file mode 100644
index af846744315..00000000000
--- a/metrics/metrics/src/test/java/io/helidon/metrics/TimeUnitsTest.java
+++ /dev/null
@@ -1,58 +0,0 @@
-/*
- * Copyright (c) 2019, 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.helidon.metrics;
-
-import java.util.concurrent.TimeUnit;
-
-import org.junit.jupiter.api.Test;
-
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.is;
-
-/**
- * Class TimeUnitsTest.
- */
-public class TimeUnitsTest {
-
- @Test
- public void testBigDecimalNaNConversion() {
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.NANOSECONDS).apply(Double.NaN),
- is(String.valueOf(Double.NaN)));
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.MICROSECONDS).apply(Double.NaN),
- is(String.valueOf(Double.NaN)));
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.MILLISECONDS).apply(Double.NaN),
- is(String.valueOf(Double.NaN)));
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.SECONDS).apply(Double.NaN),
- is(String.valueOf(Double.NaN)));
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.MINUTES).apply(Double.NaN),
- is(String.valueOf(Double.NaN)));
- }
-
- @Test
- public void testBigDecimalConversion() {
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.NANOSECONDS).apply(1000000000L),
- is(String.valueOf(1.0d)));
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.MICROSECONDS).apply(1000000),
- is(String.valueOf(1.0d)));
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.MILLISECONDS).apply(1000),
- is(String.valueOf(1.0d)));
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.SECONDS).apply(1),
- is(String.valueOf(1)));
- assertThat(MetricImpl.TimeUnits.timeConverter(TimeUnit.MINUTES).apply(1),
- is(String.valueOf(60)));
- }
-}
diff --git a/metrics/service-api/etc/spotbugs/exclude.xml b/metrics/service-api/etc/spotbugs/exclude.xml
new file mode 100644
index 00000000000..e06e1ebbddd
--- /dev/null
+++ b/metrics/service-api/etc/spotbugs/exclude.xml
@@ -0,0 +1,35 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/metrics/service-api/pom.xml b/metrics/service-api/pom.xml
index ccc6b74b9a2..17b618a059d 100644
--- a/metrics/service-api/pom.xml
+++ b/metrics/service-api/pom.xml
@@ -19,7 +19,7 @@
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
4.0.0
io.helidon.metrics
@@ -30,9 +30,13 @@
Helidon Metrics Web Support API
- Metrics service endpoint API and minimal implementation
+ Tools for metrics endpoints
+
+ etc/spotbugs/exclude.xml
+
+
io.helidon.common
@@ -43,12 +47,13 @@
helidon-metrics-api
- io.helidon.reactive.webserver
- helidon-reactive-webserver
+ org.eclipse.parsson
+ parsson
+ runtime
- io.helidon.service-common
- helidon-service-common-rest
+ jakarta.json
+ jakarta.json-api
io.helidon.config
@@ -78,8 +83,8 @@
test
- io.helidon.reactive.webclient
- helidon-reactive-webclient
+ org.mockito
+ mockito-core
test
diff --git a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/JsonFormat.java b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/JsonFormat.java
new file mode 100644
index 00000000000..a2dad8f3de6
--- /dev/null
+++ b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/JsonFormat.java
@@ -0,0 +1,616 @@
+/*
+ * Copyright (c) 2022 Oracle and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.helidon.metrics.serviceapi;
+
+import java.math.BigDecimal;
+import java.math.BigInteger;
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.StringJoiner;
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.concurrent.atomic.AtomicLong;
+import java.util.concurrent.atomic.DoubleAccumulator;
+import java.util.concurrent.atomic.DoubleAdder;
+import java.util.concurrent.atomic.LongAccumulator;
+import java.util.concurrent.atomic.LongAdder;
+import java.util.function.BiConsumer;
+import java.util.function.Function;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+import io.helidon.metrics.api.HelidonMetric;
+import io.helidon.metrics.api.MetricInstance;
+import io.helidon.metrics.api.Registry;
+import io.helidon.metrics.api.SystemTagsManager;
+
+import jakarta.json.Json;
+import jakarta.json.JsonArray;
+import jakarta.json.JsonArrayBuilder;
+import jakarta.json.JsonBuilderFactory;
+import jakarta.json.JsonObject;
+import jakarta.json.JsonObjectBuilder;
+import jakarta.json.JsonValue;
+import org.eclipse.microprofile.metrics.ConcurrentGauge;
+import org.eclipse.microprofile.metrics.Counter;
+import org.eclipse.microprofile.metrics.Gauge;
+import org.eclipse.microprofile.metrics.Histogram;
+import org.eclipse.microprofile.metrics.Metadata;
+import org.eclipse.microprofile.metrics.Meter;
+import org.eclipse.microprofile.metrics.MetricID;
+import org.eclipse.microprofile.metrics.MetricUnits;
+import org.eclipse.microprofile.metrics.SimpleTimer;
+import org.eclipse.microprofile.metrics.Snapshot;
+import org.eclipse.microprofile.metrics.Timer;
+
+/**
+ * Support for creating MicroProfile JSON responses for metrics endpoints.
+ */
+public final class JsonFormat {
+ private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Map.of());
+ private static final Map JSON_ESCAPED_CHARS_MAP = initEscapedCharsMap();
+
+ private static final Pattern JSON_ESCAPED_CHARS_REGEX = Pattern
+ .compile(JSON_ESCAPED_CHARS_MAP
+ .keySet()
+ .stream()
+ .map(Pattern::quote)
+ .collect(Collectors.joining("", "[", "]")));
+
+ private JsonFormat() {
+ }
+
+ /**
+ * Create JSON metric response for specified registries.
+ *
+ * @param registries registries to use
+ * @return JSON with data of metrics
+ */
+ public static JsonObject jsonData(Registry... registries) {
+ return toJson(JsonFormat::toJsonData, registries);
+ }
+
+ /**
+ * JSON for a single registry.
+ *
+ * @param registry registry
+ * @return JSON with data of a single registry
+ */
+ public static JsonObject jsonData(Registry registry) {
+ return toJson((builder, entry) -> jsonData(builder, entry.id(), entry.metric()),
+ registry);
+ }
+
+ /**
+ * Create JSON metric response for specified metric in a specified registry.
+ *
+ * @param registry registry
+ * @param metricName metric name
+ * @return JSON with data of the metric
+ */
+ public static JsonObject jsonDataByName(Registry registry, String metricName) {
+ JsonObjectBuilder builder = new MergingJsonObjectBuilder(JSON.createObjectBuilder());
+ for (MetricInstance metricEntry : registry.list(metricName)) {
+ HelidonMetric metric = metricEntry.metric();
+ if (registry.enabled(metricName)) {
+ jsonData(builder, metricEntry.id(), metric);
+ }
+ }
+ return builder.build();
+ }
+
+ /**
+ * Update JSON metric metadata response for specified metric and its ids.
+ *
+ * @param builder JSON builder to update
+ * @param helidonMetric metric instance
+ * @param metricIds metric IDs
+ */
+ public static void jsonMeta(JsonObjectBuilder builder, HelidonMetric helidonMetric, List metricIds) {
+ JsonObjectBuilder metaBuilder =
+ new MergingJsonObjectBuilder(JSON.createObjectBuilder());
+
+ Metadata metadata = helidonMetric.metadata();
+ addNonEmpty(metaBuilder, "unit", metadata.getUnit());
+ addNonEmpty(metaBuilder, "type", metadata.getType());
+ addNonEmpty(metaBuilder, "description", metadata.getDescription());
+ addNonEmpty(metaBuilder, "displayName", metadata.getDisplayName());
+ if (metricIds != null) {
+ for (MetricID metricID : metricIds) {
+ boolean tagAdded = false;
+ JsonArrayBuilder ab = JSON.createArrayBuilder();
+ for (Map.Entry tag : SystemTagsManager.instance().allTags(metricID)) {
+ tagAdded = true;
+ ab.add(tagForJsonKey(tag));
+ }
+ if (tagAdded) {
+ metaBuilder.add("tags", ab);
+ }
+ }
+ }
+ builder.add(metadata.getName(), metaBuilder);
+ }
+
+ /**
+ * Create JSON metric metadata response for specified registries.
+ *
+ * @param registries registries to use
+ * @return JSON with all metadata
+ */
+ public static JsonObject jsonMeta(Registry... registries) {
+ return toJson(JsonFormat::jsonMeta, registries);
+ }
+
+ private static JsonObject jsonMeta(Registry registry) {
+ return toJson((builder, entry) -> {
+ MetricID metricID = entry.id();
+ HelidonMetric metric = entry.metric();
+ List sameNamedIDs = registry.metricIdsByName(metricID.getName());
+ jsonMeta(builder, metric, sameNamedIDs);
+ }, registry);
+ }
+
+ @SuppressWarnings("unchecked")
+ private static void jsonData(JsonObjectBuilder builder, MetricID key, HelidonMetric value) {
+ switch (value.metadata().getTypeRaw()) {
+ case CONCURRENT_GAUGE -> concurrentGauge(builder, key, (ConcurrentGauge) value);
+ case COUNTER -> counter(builder, key, (Counter) value);
+ case GAUGE -> gauge(builder, key, (Gauge) value);
+ case METERED -> meter(builder, key, (Meter) value);
+ case HISTOGRAM -> histogram(builder, key, (Histogram) value);
+ case TIMER -> timer(builder, key, value, (Timer) value);
+ case SIMPLE_TIMER -> simpleTimer(builder, key, value, (SimpleTimer) value);
+ case INVALID -> throw new IllegalArgumentException("Invalid metric encountered: " + key);
+ default -> throw new IllegalArgumentException("Invalid metric type encountered: " + value.metadata().getTypeRaw()
+ + ", key" + key);
+ }
+ }
+
+ private static String jsonFullKey(MetricID metricID) {
+ return jsonFullKey(metricID.getName(), metricID);
+ }
+
+ private static long conversionFactor(HelidonMetric helidonMetric) {
+ String unit = helidonMetric.metadata().getUnit();
+ if (unit == null || unit.isEmpty() || MetricUnits.NONE.equals(unit)) {
+ return 1;
+ }
+ return switch (unit) {
+ case MetricUnits.MICROSECONDS -> 1000L;
+ case MetricUnits.MILLISECONDS -> 1000L * 1000;
+ case MetricUnits.SECONDS -> 1000L * 1000 * 1000;
+ case MetricUnits.MINUTES -> 1000L * 1000 * 1000 * 60;
+ case MetricUnits.HOURS -> 1000L * 1000 * 1000 * 60 * 60;
+ case MetricUnits.DAYS -> 1000L * 1000 * 1000 * 60 * 60 * 24;
+ default -> 1;
+ };
+ }
+
+ private static JsonObject toJsonData(Registry registry) {
+ return toJson(
+ (builder, entry) -> jsonData(builder, entry.id(), entry.metric()),
+ registry);
+ }
+
+ private static void simpleTimer(JsonObjectBuilder builder,
+ MetricID metricID,
+ HelidonMetric helidonMetric,
+ SimpleTimer value) {
+ long divisor = conversionFactor(helidonMetric);
+ JsonObjectBuilder myBuilder = JSON.createObjectBuilder()
+ .add(jsonFullKey("count", metricID), value.getCount())
+ .add(jsonFullKey("elapsedTime", metricID), jsonDuration(value.getElapsedTime(), divisor))
+ .add(jsonFullKey("maxTimeDuration", metricID), jsonDuration(value.getMaxTimeDuration(), divisor))
+ .add(jsonFullKey("minTimeDuration", metricID), jsonDuration(value.getMinTimeDuration(), divisor));
+ builder.add(metricID.getName(), myBuilder);
+ }
+
+ private static JsonValue jsonDuration(Duration duration, long conversionFactor) {
+ if (duration == null) {
+ return JsonObject.NULL;
+ }
+ double result = ((double) duration.toNanos()) / conversionFactor;
+ return Json.createValue(result);
+ }
+
+ private static void timer(JsonObjectBuilder builder, MetricID metricID, HelidonMetric helidonMetric, Timer value) {
+ Snapshot snapshot = value.getSnapshot();
+ // Convert snapshot output according to units.
+ long divisor = conversionFactor(helidonMetric);
+ JsonObjectBuilder myBuilder = JSON.createObjectBuilder()
+ .add(jsonFullKey("count", metricID), value.getCount())
+ .add(jsonFullKey("elapsedTime", metricID), jsonDuration(value.getElapsedTime(), divisor))
+ .add(jsonFullKey("meanRate", metricID), value.getMeanRate())
+ .add(jsonFullKey("oneMinRate", metricID), value.getOneMinuteRate())
+ .add(jsonFullKey("fiveMinRate", metricID), value.getFiveMinuteRate())
+ .add(jsonFullKey("fifteenMinRate", metricID), value.getFifteenMinuteRate())
+ .add(jsonFullKey("min", metricID), snapshot.getMin() / divisor)
+ .add(jsonFullKey("max", metricID), snapshot.getMax() / divisor)
+ .add(jsonFullKey("mean", metricID), snapshot.getMean() / divisor)
+ .add(jsonFullKey("stddev", metricID), snapshot.getStdDev() / divisor)
+ .add(jsonFullKey("p50", metricID), snapshot.getMedian() / divisor)
+ .add(jsonFullKey("p75", metricID), snapshot.get75thPercentile() / divisor)
+ .add(jsonFullKey("p95", metricID), snapshot.get95thPercentile() / divisor)
+ .add(jsonFullKey("p98", metricID), snapshot.get98thPercentile() / divisor)
+ .add(jsonFullKey("p99", metricID), snapshot.get99thPercentile() / divisor)
+ .add(jsonFullKey("p999", metricID), snapshot.get999thPercentile() / divisor);
+
+ builder.add(metricID.getName(), myBuilder);
+ }
+
+ private static void histogram(JsonObjectBuilder builder, MetricID metricId, Histogram value) {
+ JsonObjectBuilder myBuilder = JSON.createObjectBuilder()
+ .add(jsonFullKey("count", metricId), value.getCount())
+ .add(jsonFullKey("sum", metricId), value.getSum());
+ Snapshot snapshot = value.getSnapshot();
+ myBuilder = myBuilder.add(jsonFullKey("min", metricId), snapshot.getMin())
+ .add(jsonFullKey("max", metricId), snapshot.getMax())
+ .add(jsonFullKey("mean", metricId), snapshot.getMean())
+ .add(jsonFullKey("stddev", metricId), snapshot.getStdDev())
+ .add(jsonFullKey("p50", metricId), snapshot.getMedian())
+ .add(jsonFullKey("p75", metricId), snapshot.get75thPercentile())
+ .add(jsonFullKey("p95", metricId), snapshot.get95thPercentile())
+ .add(jsonFullKey("p98", metricId), snapshot.get98thPercentile())
+ .add(jsonFullKey("p99", metricId), snapshot.get99thPercentile())
+ .add(jsonFullKey("p999", metricId), snapshot.get999thPercentile());
+
+ builder.add(metricId.getName(), myBuilder);
+ }
+
+ private static void meter(JsonObjectBuilder builder, MetricID metricId, Meter value) {
+ /*
+ From spec:
+ {
+ "requests": {
+ "count": 29382,
+ "meanRate": 12.223,
+ "oneMinRate": 12.563,
+ "fiveMinRate": 12.364,
+ "fifteenMinRate": 12.126,
+ }
+ }
+ */
+ JsonObjectBuilder myBuilder = JSON.createObjectBuilder()
+ .add(jsonFullKey("count", metricId), value.getCount())
+ .add(jsonFullKey("meanRate", metricId), value.getMeanRate())
+ .add(jsonFullKey("oneMinRate", metricId), value.getOneMinuteRate())
+ .add(jsonFullKey("fiveMinRate", metricId), value.getFiveMinuteRate())
+ .add(jsonFullKey("fifteenMinRate", metricId), value.getFifteenMinuteRate());
+
+ builder.add(metricId.getName(), myBuilder);
+ }
+
+ private static void gauge(JsonObjectBuilder builder, MetricID metricId, Gauge gauge) {
+ Number value = gauge.getValue();
+ String nameWithTags = jsonFullKey(metricId);
+
+ if (value instanceof AtomicInteger it) {
+ builder.add(nameWithTags, it.longValue());
+ } else if (value instanceof AtomicLong it) {
+ builder.add(nameWithTags, it.longValue());
+ } else if (value instanceof BigDecimal it) {
+ builder.add(nameWithTags, it);
+ } else if (value instanceof BigInteger it) {
+ builder.add(nameWithTags, it);
+ } else if (value instanceof Byte it) {
+ builder.add(nameWithTags, it.intValue());
+ } else if (value instanceof Double it) {
+ builder.add(nameWithTags, it);
+ } else if (value instanceof DoubleAccumulator it) {
+ builder.add(nameWithTags, it.doubleValue());
+ } else if (value instanceof DoubleAdder it) {
+ builder.add(nameWithTags, it.doubleValue());
+ } else if (value instanceof Float it) {
+ builder.add(nameWithTags, it);
+ } else if (value instanceof Integer it) {
+ builder.add(nameWithTags, it);
+ } else if (value instanceof Long it) {
+ builder.add(nameWithTags, it);
+ } else if (value instanceof LongAccumulator it) {
+ builder.add(nameWithTags, it.longValue());
+ } else if (value instanceof LongAdder it) {
+ builder.add(nameWithTags, it.longValue());
+ } else if (value instanceof Short it) {
+ builder.add(nameWithTags, it.intValue());
+ } else {
+ // Might be a developer-provided class which extends Number.
+ builder.add(nameWithTags, value.doubleValue());
+ }
+ }
+
+ private static void counter(JsonObjectBuilder builder, MetricID metricId, Counter value) {
+ builder.add(jsonFullKey(metricId), value.getCount());
+ }
+
+ private static void concurrentGauge(JsonObjectBuilder builder, MetricID metricId, ConcurrentGauge value) {
+ JsonObjectBuilder myBuilder = JSON.createObjectBuilder()
+ .add(jsonFullKey("current", metricId), value.getCount())
+ .add(jsonFullKey("max", metricId), value.getMax())
+ .add(jsonFullKey("min", metricId), value.getMin());
+ builder.add(metricId.getName(), myBuilder);
+ }
+
+ private static String jsonEscape(String s) {
+ final Matcher m = JSON_ESCAPED_CHARS_REGEX.matcher(s);
+ final StringBuilder sb = new StringBuilder();
+ while (m.find()) {
+ m.appendReplacement(sb, JSON_ESCAPED_CHARS_MAP.get(m.group()));
+ }
+ m.appendTail(sb);
+ return sb.toString();
+ }
+
+ private static Map initEscapedCharsMap() {
+ final Map result = new HashMap<>();
+ result.put("\b", bsls("b"));
+ result.put("\f", bsls("f"));
+ result.put("\n", bsls("n"));
+ result.put("\r", bsls("r"));
+ result.put("\t", bsls("t"));
+ result.put("\"", bsls("\""));
+ result.put("\\", bsls("\\\\"));
+ result.put(";", "_");
+ return result;
+ }
+
+ private static String bsls(String s) {
+ return "\\\\" + s;
+ }
+
+ private static String jsonFullKey(String baseName, MetricID metricID) {
+ return baseName + tagsToJsonFormat(SystemTagsManager.instance().allTags(metricID));
+ }
+
+ private static String tagsToJsonFormat(Iterable> it) {
+ StringJoiner sj = new StringJoiner(";", ";", "").setEmptyValue("");
+ it.forEach(entry -> sj.add(tagForJsonKey(entry)));
+ return sj.toString();
+ }
+
+ private static String tagForJsonKey(Map.Entry tagEntry) {
+ return String.format("%s=%s", jsonEscape(tagEntry.getKey()), jsonEscape(tagEntry.getValue()));
+ }
+
+ private static void addNonEmpty(JsonObjectBuilder builder, String name, String value) {
+ if ((null != value) && !value.isEmpty()) {
+ builder.add(name, value);
+ }
+ }
+
+ private static JsonObject toJson(
+ BiConsumer accumulator,
+ Registry registry) {
+
+ return registry.stream()
+ .sorted(Comparator.comparing(MetricInstance::id))
+ .collect(() -> new MergingJsonObjectBuilder(JSON.createObjectBuilder()),
+ accumulator,
+ JsonObjectBuilder::addAll
+ )
+ .build();
+ }
+
+ private static JsonObject toJson(Function fn, Registry... registries) {
+ return Arrays.stream(registries)
+ .filter(r -> !r.empty())
+ .collect(JSON::createObjectBuilder,
+ (builder, registry) -> accumulateJson(builder, registry, fn),
+ JsonObjectBuilder::addAll)
+ .build();
+ }
+
+ private static void accumulateJson(JsonObjectBuilder builder, Registry registry,
+ Function fn) {
+ builder.add(registry.type(), fn.apply(registry));
+ }
+
+ /**
+ * A {@code JsonObjectBuilder} that aggregates, rather than overwrites, when
+ * the caller adds objects or arrays with the same name.
+ *
+ * This builder is tuned to the needs of reporting metrics metadata. Metrics
+ * which share the same name but have different tags and have multiple
+ * values (called samples) need to appear in the data output as one
+ * object with the common name. The name of each sample in the output is
+ * decorated with the tags for the sample's parent metric. For example:
+ *
+ *
+ * "carsMeter": {
+ * "count;colour=red" : 0,
+ * "meanRate;colour=red" : 0,
+ * "oneMinRate;colour=red" : 0,
+ * "fiveMinRate;colour=red" : 0,
+ * "fifteenMinRate;colour=red" : 0,
+ * "count;colour=blue" : 0,
+ * "meanRate;colour=blue" : 0,
+ * "oneMinRate;colour=blue" : 0,
+ * "fiveMinRate;colour=blue" : 0,
+ * "fifteenMinRate;colour=blue" : 0
+ * }
+ *
+ *
+ * The metadata output (as opposed to the data output) must collect tag
+ * information from actual instances of the metric under the overall metadata
+ * object. This example reflects two instances of the {@code barVal} gauge
+ * which have tags of "store" and "component."
+ *
+ * "barVal": {
+ * "unit": "megabytes",
+ * "type": "gauge",
+ * "tags": [
+ * [
+ * "store=webshop",
+ * "component=backend"
+ * ],
+ * [
+ * "store=webshop",
+ * "component=frontend"
+ * ]
+ * ]
+ * }
+ *
+ */
+ static final class MergingJsonObjectBuilder implements JsonObjectBuilder {
+
+ private final JsonObjectBuilder delegate;
+
+ private final Map> subValuesMap = new HashMap<>();
+ private final Map> subArraysMap = new HashMap<>();
+
+ MergingJsonObjectBuilder(JsonObjectBuilder delegate) {
+ this.delegate = delegate;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String arg0, JsonValue arg1) {
+ delegate.add(arg0, arg1);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String arg0, String arg1) {
+ delegate.add(arg0, arg1);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String arg0, BigInteger arg1) {
+ delegate.add(arg0, arg1);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String arg0, BigDecimal arg1) {
+ delegate.add(arg0, arg1);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String arg0, int arg1) {
+ delegate.add(arg0, arg1);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String arg0, long arg1) {
+ delegate.add(arg0, arg1);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String arg0, double arg1) {
+ if (Double.isNaN(arg1)) {
+ delegate.add(arg0, String.valueOf(Double.NaN));
+ } else {
+ delegate.add(arg0, arg1);
+ }
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String arg0, boolean arg1) {
+ delegate.add(arg0, arg1);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder addNull(String arg0) {
+ delegate.addNull(arg0);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String name, JsonObjectBuilder subBuilder) {
+ JsonObject ob = subBuilder.build();
+ delegate.add(name, JSON.createObjectBuilder(ob));
+ List subValues;
+ if (subValuesMap.containsKey(name)) {
+ subValues = subValuesMap.get(name);
+ } else {
+ subValues = new ArrayList<>();
+ subValuesMap.put(name, subValues);
+ }
+ subValues.add(ob);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder add(String name, JsonArrayBuilder arrayBuilder) {
+ JsonArray array = arrayBuilder.build();
+ delegate.add(name, JSON.createArrayBuilder(array));
+ List subArrays;
+ if (subArraysMap.containsKey(name)) {
+ subArrays = subArraysMap.get(name);
+ } else {
+ subArrays = new ArrayList<>();
+ subArraysMap.put(name, subArrays);
+ }
+ subArrays.add(array);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder addAll(JsonObjectBuilder builder) {
+ delegate.addAll(builder);
+ return this;
+ }
+
+ @Override
+ public JsonObjectBuilder remove(String name) {
+ delegate.remove(name);
+ return this;
+ }
+
+ @Override
+ public JsonObject build() {
+ JsonObject beforeMerging = delegate.build();
+ if (subValuesMap.isEmpty() && subArraysMap.isEmpty()) {
+ return beforeMerging;
+ }
+ JsonObjectBuilder mainBuilder = JSON.createObjectBuilder(beforeMerging);
+ subValuesMap.forEach((key, value) -> {
+ JsonObjectBuilder metricBuilder = JSON.createObjectBuilder();
+ for (JsonObject subObject : value) {
+ JsonObjectBuilder subBuilder = JSON.createObjectBuilder(subObject);
+ metricBuilder.addAll(subBuilder);
+ }
+ mainBuilder.add(key, metricBuilder);
+ });
+
+ subArraysMap.forEach((key, value) -> {
+ JsonArrayBuilder arrayBuilder = JSON.createArrayBuilder();
+ for (JsonArray subArray : value) {
+ JsonArrayBuilder subArrayBuilder = JSON.createArrayBuilder(subArray);
+ arrayBuilder.add(subArrayBuilder);
+ }
+ mainBuilder.add(key, arrayBuilder);
+ });
+
+ return mainBuilder.build();
+ }
+
+ @Override
+ public String toString() {
+ return delegate.toString();
+ }
+ }
+}
diff --git a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MetricsSupport.java b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MetricsSupport.java
deleted file mode 100644
index a94e70bc872..00000000000
--- a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MetricsSupport.java
+++ /dev/null
@@ -1,186 +0,0 @@
-/*
- * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics.serviceapi;
-
-import io.helidon.config.Config;
-import io.helidon.config.metadata.Configured;
-import io.helidon.config.metadata.ConfiguredOption;
-import io.helidon.metrics.api.MetricsSettings;
-import io.helidon.reactive.webserver.Routing;
-import io.helidon.reactive.webserver.Service;
-import io.helidon.servicecommon.rest.RestServiceSettings;
-import io.helidon.servicecommon.rest.RestServiceSupport;
-
-/**
- * Behavior for supporting metrics for the Helidon Web Server.
- *
- *
- * By default, {@code MetricsSupport} creates the {@code /metrics} endpoint with three sub-paths: {@code application},
- * {@code vendor}, and {@code base}.
- *
- * To register these endpoints with the web server:
- *
{@code
- * Routing.builder()
- * .register(MetricsSupport.create())
- * }
- *
- * This class supports finer-grained settings using {@link io.helidon.metrics.api.MetricsSettings} and
- * {@link io.helidon.servicecommon.rest.RestServiceSettings} and Helidon Config via
- * {@link #create(io.helidon.metrics.api.MetricsSettings, io.helidon.servicecommon.rest.RestServiceSettings)}.
- *
- * During request handling the application metrics registry is then available as follows:
- *
{@code
- * req.context().get(MetricRegistry.class).ifPresent(reg -> reg.counter("myCounter").inc());
- * }
- */
-public interface MetricsSupport extends RestServiceSupport, Service {
-
- /**
- * Creates a new {@code MetricsSupport} instance using default metrics settings.
- *
- * @return new metrics support using default metrics settings
- */
- static MetricsSupport create() {
- return MetricsSupportManager.create();
- }
-
- /**
- * Creates a new {@code MetricsSupport} instance using the specified metrics settings and REST service settings.
- *
- * @param metricsSettings metrics settings to use in initializing the metrics support
- * @param restServiceSettings REST service settings for the metrics endpoint
- *
- * @return new metrics support using specified metrics settings and REST service settings
- */
- static MetricsSupport create(MetricsSettings metricsSettings, RestServiceSettings restServiceSettings) {
- return MetricsSupportManager.create(metricsSettings, restServiceSettings);
- }
-
- /**
- * Creates a new {@code MetricsSupport} instance using the specified metrics settings and defaulted REST service settings.
- *
- * @param metricsSettings metrics settings to use in initializing the metrics support
- * @return new metrics support using the specified metrics settings
- */
- static MetricsSupport create(MetricsSettings metricsSettings) {
- return create(metricsSettings, defaultedMetricsRestServiceSettingsBuilder().build());
- }
-
- /**
- * Creates a new {@code MetricsSupport} instance using the specified configuration.
- *
- * @param config configuration to use
- * @return new metrics support instance using the provided configuration
- */
- static MetricsSupport create(Config config) {
- return MetricsSupportManager.create(MetricsSettings.create(config),
- defaultedMetricsRestServiceSettingsBuilder()
- .config(config)
- .build());
- }
-
- /**
- * Returns a builder for the highest-priority {@code MetricsSupport} implementation.
- *
- * @return builder for {@code MetricsSupport}
- */
- static MetricsSupport.Builder builder() {
- return MetricsSupportManager.builder();
- }
-
- /**
- * Prepares a {@link io.helidon.servicecommon.rest.RestServiceSettings.Builder} instance for metrics with the default
- * settings.
- *
- * @return the prepared builder
- */
- static RestServiceSettings.Builder defaultedMetricsRestServiceSettingsBuilder() {
- return RestServiceSettings.builder()
- .webContext(MetricsSettings.Builder.DEFAULT_CONTEXT);
- }
-
- /**
- * Prepares the family of {@code /metrics} endpoints.
- *
- * By default, requests to the metrics endpoints trigger a 404 response with an explanatory message that metrics are
- * disabled. Implementations of this interface can provide more informative endpoints.
- *
- *
- * @param endpointContext context (typically /metrics)
- * @param serviceEndpointRoutingRules routing rules to update with the disabled metrics endpoints
- */
- void prepareMetricsEndpoints(String endpointContext, Routing.Rules serviceEndpointRoutingRules);
-
- /**
- * Prepares the endpoint which the service exposes.
- *
- * @param defaultRoutingRules routing rules for the default routing
- * @param serviceEndpointRoutingRules routing rules (if different from default) for the service endpoint
- */
- void configureEndpoint(Routing.Rules defaultRoutingRules, Routing.Rules serviceEndpointRoutingRules);
-
- /**
- * Sets up vendor metrics routing using the specified routing name and routing builder.
- *
- * @param routingName routing name to use in setting up the vendor metrics
- * @param routingRules routing rules to modify
- */
- void configureVendorMetrics(String routingName, Routing.Rules routingRules);
-
- @Override
- void update(Routing.Rules rules);
-
- /**
- * Builder for {@code MetricsSupport}.
- *
- * Callers can influence how {@code MetricsSupport} behaves by assigning {@link io.helidon.metrics.api.MetricsSettings}.
- *
- *
- * @param builder type
- * @param specific implementation type of {@code MetricsSupport}
- */
-
- @Configured
- interface Builder, T extends MetricsSupport> extends io.helidon.common.Builder {
-
- /**
- * Returns the new {@code MetricsSupport} instance according to the builder's settings.
- *
- * @return the new metrics support
- */
- T build();
-
- /**
- * Assigns {@code MetricsSettings} which will be used in creating the {@code MetricsSupport} instance at build-time.
- *
- * @param metricsSettingsBuilder the metrics settings to assign for use in building the {@code MetricsSupport} instance
- * @return updated builder
- */
- @ConfiguredOption(mergeWithParent = true,
- type = MetricsSettings.class)
- B metricsSettings(MetricsSettings.Builder metricsSettingsBuilder);
-
- /**
- * Set the REST service settings.
- *
- * @param restServiceSettingsBuilder REST service settings to use
- * @return updated builder
- */
- @ConfiguredOption(mergeWithParent = true,
- type = RestServiceSettings.class)
- B restServiceSettings(RestServiceSettings.Builder restServiceSettingsBuilder);
- }
-}
diff --git a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MetricsSupportManager.java b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MetricsSupportManager.java
deleted file mode 100644
index 1d898ad664a..00000000000
--- a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MetricsSupportManager.java
+++ /dev/null
@@ -1,73 +0,0 @@
-/*
- * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics.serviceapi;
-
-import java.util.ServiceLoader;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-import io.helidon.common.HelidonServiceLoader;
-import io.helidon.common.LazyValue;
-import io.helidon.metrics.api.MetricsSettings;
-import io.helidon.metrics.serviceapi.spi.MetricsSupportProvider;
-import io.helidon.servicecommon.rest.RestServiceSettings;
-
-/**
- * Loads the highest-priority implementation of {@link MetricsSupportProvider} via service loading or, if none is found, uses a
- * provider for a no-op {@link MetricsSupport}, then uses the selected provider to create instances of {@code MetricsSupport}.
- *
- * The {@code MetricsSupport} static factory methods delegate to the package private static methods in this class so we can
- * hide the provider instance we use.
- *
- */
-class MetricsSupportManager {
-
- private static final Logger LOGGER = Logger.getLogger(MetricsSupportManager.class.getName());
-
- @SuppressWarnings("unchecked")
- private static final LazyValue> LAZY_PROVIDER =
- LazyValue.create(MetricsSupportManager::loadMetricsSupportProvider);
-
- private MetricsSupportManager() {
- }
-
- private static MetricsSupportProvider loadMetricsSupportProvider() {
- MetricsSupportProvider provider = HelidonServiceLoader.builder(ServiceLoader.load(MetricsSupportProvider.class))
- .addService(new MinimalMetricsSupportProviderImpl(), 0)
- .build()
- .asList()
- .get(0);
- LOGGER.log(Level.FINE, "MetricsSupport provider: {0}", provider.getClass().getName());
- return provider;
- }
-
- static MetricsSupport create() {
- return LAZY_PROVIDER.get()
- .builder()
- .restServiceSettings(MetricsSupport.defaultedMetricsRestServiceSettingsBuilder())
- .build();
- }
-
- static MetricsSupport.Builder builder() {
- return LAZY_PROVIDER.get()
- .builder()
- .restServiceSettings(MetricsSupport.defaultedMetricsRestServiceSettingsBuilder());
- }
-
- static MetricsSupport create(MetricsSettings metricsSettings, RestServiceSettings restServiceSettings) {
- return LAZY_PROVIDER.get().create(metricsSettings, restServiceSettings);
- }
-}
diff --git a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MinimalMetricsSupport.java b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MinimalMetricsSupport.java
deleted file mode 100644
index 45bc6d58a12..00000000000
--- a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MinimalMetricsSupport.java
+++ /dev/null
@@ -1,142 +0,0 @@
-/*
- * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics.serviceapi;
-
-import java.util.logging.Logger;
-import java.util.stream.Stream;
-
-import io.helidon.common.http.Http;
-import io.helidon.metrics.api.MetricsSettings;
-import io.helidon.reactive.webserver.Handler;
-import io.helidon.reactive.webserver.Routing;
-import io.helidon.servicecommon.rest.HelidonRestServiceSupport;
-import io.helidon.servicecommon.rest.RestServiceSettings;
-
-import org.eclipse.microprofile.metrics.MetricRegistry;
-
-/**
- * Minimal implementation of {@link io.helidon.metrics.serviceapi.MetricsSupport}.
- *
- * Apps and other Helidon components which use {@code MetricSupport} (such as
- * the MP metrics component) can very easily take advantage of the minimal implementation of the metrics registries and the
- * metrics
- * themselves if metrics is disabled via configuration or settings simply by using the {@code MetricsSupport} factory methods
- * which, based on the metrics settings, might choose this implementation.
- *
- * This implementation sets up the usual metrics-related endpoints but always sends a 404 response with an explanatory
- * message.
- */
-public class MinimalMetricsSupport extends HelidonRestServiceSupport implements MetricsSupport {
-
- static final String DISABLED_ENDPOINT_MESSAGE = "Metrics is disabled";
- private static final Handler DISABLED_ENDPOINT_HANDLER =
- (req, res) -> res.status(Http.Status.NOT_FOUND_404.code()).send(DISABLED_ENDPOINT_MESSAGE);
-
- static MinimalMetricsSupport.Builder builder() {
- return new Builder();
- }
-
- static MinimalMetricsSupport create(RestServiceSettings restServiceSettings) {
- return new MinimalMetricsSupport(restServiceSettings);
- }
-
- /**
- * Adds routing rules so metrics-related requests go to the "not available" endpoint.
- *
- * @param endpointContext web context for metrics
- * @param serviceEndpointRoutingRules routing rules for the metrics service
- */
- public static void createEndpointForDisabledMetrics(String endpointContext, Routing.Rules serviceEndpointRoutingRules) {
- // routing to top-level root (/metrics)
- serviceEndpointRoutingRules
- .get(endpointContext, DISABLED_ENDPOINT_HANDLER)
- .options(endpointContext, DISABLED_ENDPOINT_HANDLER);
-
- // routing to GET and OPTIONS for each metrics scope (registry type) and a specific metric within each scope:
- // application, base, vendor
- Stream.of(MetricRegistry.Type.values())
- .map(MetricRegistry.Type::name)
- .map(String::toLowerCase)
- .forEach(type -> Stream.of("", "/{metric}") // for the whole scope and for a specific metric within that scope
- .map(suffix -> endpointContext + "/" + type + suffix)
- .forEach(path ->
- serviceEndpointRoutingRules
- .get(path, DISABLED_ENDPOINT_HANDLER)
- .options(path, DISABLED_ENDPOINT_HANDLER)
- ));
- }
-
- private final RestServiceSettings restServiceSettings;
-
- @Override
- protected void postConfigureEndpoint(Routing.Rules defaultRules, Routing.Rules serviceEndpointRoutingRules) {
- createEndpointForDisabledMetrics(restServiceSettings.webContext(), serviceEndpointRoutingRules);
- }
-
- @Override
- public void prepareMetricsEndpoints(String endpointContext, Routing.Rules serviceEndpointRoutingRules) {
- createEndpointForDisabledMetrics(endpointContext, serviceEndpointRoutingRules);
- }
-
- @Override
- public void update(Routing.Rules rules) {
- configureEndpoint(rules, rules);
- }
-
- @Override
- public void configureVendorMetrics(String routingName, Routing.Rules routingRules) {
- }
-
- private MinimalMetricsSupport(RestServiceSettings restServiceSettings) {
- this(Logger.getLogger(MinimalMetricsSupport.class.getName()),
- restServiceSettings,
- "metrics");
- }
-
- private MinimalMetricsSupport(Builder builder) {
- this(Logger.getLogger(MinimalMetricsSupport.class.getName()),
- builder.restServiceSettingsBuilder.build(),
- "metrics");
- }
-
- private MinimalMetricsSupport(Logger logger, RestServiceSettings restServiceSettings, String serviceName) {
- super(logger, restServiceSettings, serviceName);
- this.restServiceSettings = restServiceSettings;
- }
-
- static class Builder implements MetricsSupport.Builder {
-
- private RestServiceSettings.Builder restServiceSettingsBuilder = RestServiceSettings.builder()
- .webContext("/metrics");
-
- @Override
- public Builder metricsSettings(MetricsSettings.Builder metricsSettingsBuilder) {
- return this;
- }
-
- @Override
- public Builder restServiceSettings(
- RestServiceSettings.Builder restServiceSettingsBuilder) {
- this.restServiceSettingsBuilder = restServiceSettingsBuilder;
- return this;
- }
-
- @Override
- public MinimalMetricsSupport build() {
- return new MinimalMetricsSupport(this);
- }
- }
-}
diff --git a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MinimalMetricsSupportProviderImpl.java b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MinimalMetricsSupportProviderImpl.java
deleted file mode 100644
index 251e9c07eee..00000000000
--- a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/MinimalMetricsSupportProviderImpl.java
+++ /dev/null
@@ -1,36 +0,0 @@
-/*
- * Copyright (c) 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics.serviceapi;
-
-import io.helidon.metrics.api.MetricsSettings;
-import io.helidon.metrics.serviceapi.spi.MetricsSupportProvider;
-import io.helidon.servicecommon.rest.RestServiceSettings;
-
-/**
- * Provider of minimal web support for metrics.
- */
-class MinimalMetricsSupportProviderImpl implements MetricsSupportProvider {
-
- @Override
- public MinimalMetricsSupport.Builder builder() {
- return MinimalMetricsSupport.builder();
- }
-
- @Override
- public MinimalMetricsSupport create(MetricsSettings metricsSettings, RestServiceSettings restServiceSettings) {
- return MinimalMetricsSupport.create(restServiceSettings);
- }
-}
diff --git a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/PrometheusFormat.java b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/PrometheusFormat.java
new file mode 100644
index 00000000000..dc756042bd4
--- /dev/null
+++ b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/PrometheusFormat.java
@@ -0,0 +1,821 @@
+/*
+ * Copyright (c) 2022 Oracle and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.helidon.metrics.serviceapi;
+
+import java.math.BigDecimal;
+import java.time.Duration;
+import java.util.Arrays;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+import java.util.StringJoiner;
+import java.util.concurrent.TimeUnit;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+import java.util.function.Supplier;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+import io.helidon.metrics.api.HelidonMetric;
+import io.helidon.metrics.api.LabeledSnapshot;
+import io.helidon.metrics.api.MetricInstance;
+import io.helidon.metrics.api.Registry;
+import io.helidon.metrics.api.Sample;
+import io.helidon.metrics.api.SampledMetric;
+import io.helidon.metrics.api.SnapshotMetric;
+import io.helidon.metrics.api.SystemTagsManager;
+
+import org.eclipse.microprofile.metrics.ConcurrentGauge;
+import org.eclipse.microprofile.metrics.Counter;
+import org.eclipse.microprofile.metrics.Gauge;
+import org.eclipse.microprofile.metrics.Histogram;
+import org.eclipse.microprofile.metrics.Metadata;
+import org.eclipse.microprofile.metrics.Meter;
+import org.eclipse.microprofile.metrics.MetricID;
+import org.eclipse.microprofile.metrics.MetricUnits;
+import org.eclipse.microprofile.metrics.SimpleTimer;
+import org.eclipse.microprofile.metrics.Timer;
+
+import static java.lang.System.Logger.Level.WARNING;
+
+/**
+ * Support for creating Prometheus responses for metrics endpoints.
+ */
+public final class PrometheusFormat {
+ private static final System.Logger LOGGER = System.getLogger(PrometheusFormat.class.getName());
+
+ private static final Pattern DOUBLE_UNDERSCORE = Pattern.compile("__");
+ private static final Pattern COLON_UNDERSCORE = Pattern.compile(":_");
+ private static final Map PROMETHEUS_CONVERTERS = new HashMap<>();
+
+ private static final int EXEMPLAR_MAX_LENGTH = 128;
+
+ private static final long KILOBITS = 1000 / 8;
+ private static final long MEGABITS = 1000 * KILOBITS;
+ private static final long GIGABITS = 1000 * MEGABITS;
+ private static final long KIBIBITS = 1024 / 8;
+ private static final long MEBIBITS = 1024 * KIBIBITS;
+ private static final long GIBIBITS = 1024 * MEBIBITS;
+ private static final long KILOBYTES = 1000;
+ private static final long MEGABYTES = 1000 * KILOBYTES;
+ private static final long GIGABYTES = 1000 * MEGABYTES;
+
+ static {
+ //see https://prometheus.io/docs/practices/naming/#base-units
+ addTimeConverter(MetricUnits.NANOSECONDS, TimeUnit.NANOSECONDS);
+ addTimeConverter(MetricUnits.MICROSECONDS, TimeUnit.MICROSECONDS);
+ addTimeConverter(MetricUnits.MILLISECONDS, TimeUnit.MILLISECONDS);
+ addTimeConverter(MetricUnits.SECONDS, TimeUnit.SECONDS);
+ addTimeConverter(MetricUnits.MILLISECONDS, TimeUnit.MILLISECONDS);
+ addTimeConverter(MetricUnits.MINUTES, TimeUnit.MINUTES);
+ addTimeConverter(MetricUnits.HOURS, TimeUnit.HOURS);
+ addTimeConverter(MetricUnits.DAYS, TimeUnit.DAYS);
+
+ addConverter(new Units(MetricUnits.BITS, "bytes", o -> ((Number) o).doubleValue() / 8));
+ addByteConverter(MetricUnits.KILOBITS, KILOBITS);
+ addByteConverter(MetricUnits.MEGABITS, MEGABITS);
+ addByteConverter(MetricUnits.GIGABITS, GIGABITS);
+ addByteConverter(MetricUnits.KIBIBITS, KIBIBITS);
+ addByteConverter(MetricUnits.MEBIBITS, MEBIBITS);
+ addByteConverter(MetricUnits.GIBIBITS, GIBIBITS);
+ addByteConverter(MetricUnits.KILOBYTES, KILOBYTES);
+ addByteConverter(MetricUnits.MEGABYTES, MEGABYTES);
+ addByteConverter(MetricUnits.GIGABYTES, GIGABYTES);
+
+ addConverter(new Units("fahrenheits", "celsius", o -> ((((Number) o).doubleValue() - 32) * 5) / 9));
+ addConverter(new LengthUnits("millimeters", (double) 1 / 1000));
+ addConverter(new LengthUnits("centimeters", (double) 1 / 100));
+ addConverter(new LengthUnits("kilometers", 1000));
+ }
+
+ private PrometheusFormat() {
+ }
+
+ /**
+ * Create Prometheus metric response for specified metric in a specified registry.
+ *
+ * @param registry registry
+ * @param metricName metric name
+ * @return data of the metric
+ */
+ public static String prometheusDataByName(Registry registry, String metricName) {
+ StringBuilder sb = new StringBuilder();
+ boolean isFirst = true;
+ for (MetricInstance metricEntry : registry.list(metricName)) {
+ HelidonMetric metric = metricEntry.metric();
+ if (registry.enabled(metricName)) {
+ prometheusData(sb, metricEntry.id(), metric, isFirst);
+ }
+ isFirst = false;
+ }
+ return sb.toString();
+ }
+
+ /**
+ * Create Prometheus metric response for specified registries.
+ *
+ * @param registries registries to use
+ * @return data of metrics
+ */
+
+ public static String prometheusData(Registry... registries) {
+ return Arrays.stream(registries).filter(r -> !r.empty()).map(PrometheusFormat::prometheusData)
+ .collect(Collectors.joining());
+ }
+
+ /**
+ * Create Prometheus metric response for a specific metric instance.
+ *
+ * @param metricId metric ID
+ * @param value metric instance
+ * @param withHelpType whether to add help information
+ * @return data of metric
+ */
+ public static String prometheusData(MetricID metricId, HelidonMetric value, boolean withHelpType) {
+ StringBuilder sb = new StringBuilder();
+ prometheusData(sb, metricId, value, withHelpType);
+ return sb.toString();
+ }
+
+ @SuppressWarnings("unchecked")
+ private static void prometheusData(StringBuilder sb, MetricID key, HelidonMetric value, boolean withHelpType) {
+ Metadata metadata = value.metadata();
+ switch (metadata.getTypeRaw()) {
+ case CONCURRENT_GAUGE -> concurrentGauge(sb, key, metadata, value, (ConcurrentGauge) value, withHelpType);
+ case COUNTER -> counter(sb, key, metadata, value, (Counter) value, withHelpType);
+ case GAUGE -> gauge(sb, key, metadata, value, (Gauge) value, withHelpType);
+ case METERED -> meter(sb, key, metadata, value, (Meter) value, withHelpType);
+ case HISTOGRAM -> histogram(sb, key, metadata, value, (Histogram) value, withHelpType);
+ case TIMER -> timer(sb, key, metadata, value, (Timer) value, withHelpType);
+ case SIMPLE_TIMER -> simpleTimer(sb, key, metadata, value, (SimpleTimer) value, withHelpType);
+ case INVALID -> throw new IllegalArgumentException("Invalid metric encountered: " + key);
+ default -> throw new IllegalArgumentException("Invalid metric type encountered: " + metadata.getTypeRaw()
+ + ", key: " + key);
+ }
+ }
+
+ private static String nameWithUnits(String registryType, Metadata metadata, MetricID metricID) {
+ return nameWithUnits(registryType, metricID.getName(), units(metadata));
+ }
+
+ private static String nameWithUnits(String registryType, String name, Units units) {
+ return prometheusName(registryType, name) + units.getPrometheusUnit().map((it) -> "_" + it).orElse("");
+ }
+
+ private static String prometheusName(String registryType, String name) {
+ return prometheusClean(name, registryType + "_");
+ }
+
+ private static String tags(Map tags) {
+ StringJoiner sj = new StringJoiner(",", "{", "}").setEmptyValue("");
+ SystemTagsManager.instance().allTags(tags).forEach(entry -> {
+ if (entry.getKey() != null) {
+ sj.add(String.format("%s=\"%s\"", prometheusClean(entry.getKey(), ""), prometheusTagValue(entry.getValue())));
+ }
+ });
+ return sj.toString();
+ }
+
+ private static String prometheusData(Registry registry) {
+ StringBuilder builder = new StringBuilder();
+ Set serialized = new HashSet<>();
+ registry.stream().sorted(Comparator.comparing(MetricInstance::id)).forEach(entry -> {
+ String name = entry.id().getName();
+ if (!serialized.contains(name)) {
+ prometheusData(builder, entry.id(), entry.metric(), true);
+ serialized.add(name);
+ } else {
+ prometheusData(builder, entry.id(), entry.metric(), false);
+ }
+ });
+ return builder.toString();
+ }
+
+ private static void simpleTimer(StringBuilder sb,
+ MetricID metricId,
+ Metadata metadata,
+ HelidonMetric helidonMetric,
+ SimpleTimer value,
+ boolean withHelpType) {
+ String tags = tags(metricId.getTags());
+ String baseName = prometheusName(helidonMetric.registryType(), metricId.getName());
+ String name = baseName + "_total";
+ help(sb, metadata, name, "counter", withHelpType);
+ sb.append(name).append(tags).append(" ").append(value.getCount());
+
+ Sample.Labeled sample = null;
+ if (helidonMetric instanceof Sample.Labeled labeled) {
+ sample = labeled;
+ sb.append(prometheusExemplar(TimeUnit.NANOSECONDS.toSeconds(labeled.value()), labeled));
+ }
+ sb.append("\n");
+
+ name = baseName + "_elapsedTime_" + MetricUnits.SECONDS;
+ if (withHelpType) {
+ prometheusType(sb, name, "gauge");
+ }
+ sb.append(name).append(tags).append(" ").append(value.getElapsedTime().toSeconds()).append(exemplarForElapsedTime(sample))
+ .append("\n");
+
+ name = baseName + "_maxTimeDuration_" + MetricUnits.SECONDS;
+ if (withHelpType) {
+ prometheusType(sb, name, "gauge");
+ }
+ sb.append(name).append(tags).append(" ").append(durationPrometheusOutput(value.getMaxTimeDuration()))
+ // todo Níma
+ // .append(exemplarForElapsedTime(value.getMaxTimeDuration(),
+ // simpleTimerImpl == null ? null : simpleTimerImpl.lastMaxSample))
+ .append("\n");
+
+ name = baseName + "_minTimeDuration_" + MetricUnits.SECONDS;
+ if (withHelpType) {
+ prometheusType(sb, name, "gauge");
+ }
+ sb.append(name).append(tags).append(" ").append(durationPrometheusOutput(value.getMinTimeDuration()))
+ // TOOD Níma
+ // .append(exemplarForElapsedTime(getMinTimeDuration(),
+ // simpleTimerImpl == null ? null : simpleTimerImpl.lastMinSample))
+ .append("\n");
+ }
+
+ private static void timer(StringBuilder sb,
+ MetricID metricId,
+ Metadata metadata,
+ HelidonMetric helidonMetric,
+ Timer value,
+ boolean withHelpType) {
+ if (!(helidonMetric instanceof SnapshotMetric snapshotable)) {
+ return;
+ }
+ // In Prometheus, times are always expressed in seconds. So force the TimeUnits value accordingly, ignoring
+ // whatever units were specified in the timer's metadata.
+ String baseName = prometheusClean(metricId.getName(), helidonMetric.registryType() + "_");
+ PrometheusName name = PrometheusName.create(helidonMetric.registryType(),
+ metadata,
+ metricId,
+ TimeUnits.PROMETHEUS_TIMER_CONVERSION_TIME_UNITS,
+ baseName);
+
+ appendPrometheusTimerStatElement(sb, name, "rate_per_second", withHelpType, "gauge", value.getMeanRate());
+ appendPrometheusTimerStatElement(sb, name, "one_min_rate_per_second", withHelpType, "gauge", value.getOneMinuteRate());
+ appendPrometheusTimerStatElement(sb, name, "five_min_rate_per_second", withHelpType, "gauge", value.getFiveMinuteRate());
+ appendPrometheusTimerStatElement(sb,
+ name,
+ "fifteen_min_rate_per_second",
+ withHelpType,
+ "gauge",
+ value.getFifteenMinuteRate());
+
+ LabeledSnapshot snap = snapshotable.snapshot();
+ histogram(sb,
+ name,
+ metadata,
+ snap,
+ TimeUnits.PROMETHEUS_TIMER_CONVERSION_TIME_UNITS,
+ value.getCount(),
+ value.getElapsedTime().toSeconds(),
+ withHelpType);
+ }
+
+ private static void appendPrometheusTimerStatElement(StringBuilder sb,
+ PrometheusName name,
+ String statName,
+ boolean withHelpType,
+ String typeName,
+ double value) {
+ // For the timer stats output, suppress any units conversion; just emit the value directly.
+ if (withHelpType) {
+ prometheusType(sb, name.nameStat(statName), typeName);
+ }
+ sb.append(name.nameStatTags(statName)).append(" ").append(value).append("\n");
+ }
+
+ private static void histogram(StringBuilder sb,
+ MetricID metricId,
+ Metadata metadata,
+ HelidonMetric helidonMetric,
+ Histogram value,
+ boolean withHelpType) {
+
+ if (!(helidonMetric instanceof SnapshotMetric snapshotable)) {
+ return;
+ }
+
+ String name = metricId.getName();
+ String baseName = prometheusClean(name, helidonMetric.registryType() + "_");
+ Units units = units(metadata);
+
+ PrometheusName pName = PrometheusName.create(helidonMetric.registryType(), metadata, metricId, units, baseName);
+ histogram(sb, pName, metadata, snapshotable.snapshot(), units, value.getCount(), value.getSum(), withHelpType);
+ }
+
+ private static void histogram(StringBuilder sb,
+ PrometheusName name,
+ Metadata metadata,
+ LabeledSnapshot snap,
+ Units units,
+ long count,
+ long sum,
+ boolean withHelpType) {
+ // # TYPE application:file_sizes_mean_bytes gauge
+ // application:file_sizes_mean_bytes 4738.231
+ appendPrometheusElement(sb, name, "mean", withHelpType, "gauge", snap.mean());
+
+ // # TYPE application:file_sizes_max_bytes gauge
+ // application:file_sizes_max_bytes 31716
+ appendPrometheusElement(sb, name, "max", withHelpType, "gauge", snap.max());
+
+ // # TYPE application:file_sizes_min_bytes gauge
+ // application:file_sizes_min_bytes 180
+ appendPrometheusElement(sb, name, "min", withHelpType, "gauge", snap.min());
+
+ // # TYPE application:file_sizes_stddev_bytes gauge
+ // application:file_sizes_stddev_bytes 1054.7343037063602
+ appendPrometheusElement(sb, name, "stddev", withHelpType, "gauge", snap.stdDev());
+
+ // # TYPE application:file_sizes_bytes summary
+ // # HELP application:file_sizes_bytes Users file size
+ // application:file_sizes_bytes_count 2037
+
+ help(sb, metadata, name.nameUnits(), "summary", withHelpType);
+
+ sb.append(name.nameUnitsSuffixTags("count")).append(" ").append(count).append('\n');
+ sb.append(name.nameUnitsSuffixTags("sum")).append(" ").append(sum).append('\n');
+ // application:file_sizes_bytes{quantile="0.5"} 4201
+ // for each supported quantile
+ prometheusQuantile(sb, name, units, "0.5", snap.median());
+ prometheusQuantile(sb, name, units, "0.75", snap.sample75thPercentile());
+ prometheusQuantile(sb, name, units, "0.95", snap.sample95thPercentile());
+ prometheusQuantile(sb, name, units, "0.98", snap.sample98thPercentile());
+ prometheusQuantile(sb, name, units, "0.99", snap.sample99thPercentile());
+ prometheusQuantile(sb, name, units, "0.999", snap.sample999thPercentile());
+ }
+
+ private static void prometheusQuantile(StringBuilder sb,
+ PrometheusName name,
+ Units units,
+ String quantile,
+ Sample.Derived derived) {
+ // application:file_sizes_bytes{quantile="0.5"} 4201
+ String quantileTag = "quantile=\"" + quantile + "\"";
+ String tags = name.prometheusTags();
+ if (name.prometheusTags().isEmpty()) {
+ tags = "{" + quantileTag + "}";
+ } else {
+ tags = tags.substring(0, tags.length() - 1) + "," + quantileTag + "}";
+ }
+
+ sb.append(name.nameUnits()).append(tags).append(" ").append(units.convert(derived.value()));
+ sb.append(prometheusExemplar(units, derived.sample()));
+ sb.append("\n");
+ }
+
+ private static void appendPrometheusElement(StringBuilder sb,
+ PrometheusName name,
+ String statName,
+ boolean withHelpType,
+ String typeName,
+ Sample.Derived derived) {
+ appendPrometheusElement(sb,
+ name,
+ () -> name.nameStatUnits(statName),
+ withHelpType,
+ typeName,
+ derived.value(),
+ derived.sample());
+ }
+
+ private static void appendPrometheusElement(StringBuilder sb,
+ PrometheusName name,
+ String statName,
+ boolean withHelpType,
+ String typeName,
+ Sample.Labeled sample) {
+ appendPrometheusElement(sb, name, () -> name.nameStatUnits(statName), withHelpType, typeName, sample.value(), sample);
+ }
+
+ private static void appendPrometheusElement(StringBuilder sb,
+ PrometheusName name,
+ Supplier nameToUse,
+ boolean withHelpType,
+ String typeName,
+ double value,
+ Sample.Labeled sample) {
+ if (withHelpType) {
+ prometheusType(sb, nameToUse.get(), typeName);
+ }
+ Object convertedValue = name.units().convert(value);
+ sb.append(nameToUse.get()).append(name.prometheusTags()).append(" ").append(convertedValue)
+ .append(prometheusExemplar(name.units(), sample)).append("\n");
+ }
+
+ private static void meter(StringBuilder sb,
+ MetricID metricId,
+ Metadata metadata,
+ HelidonMetric helidonMetric,
+ Meter value,
+ boolean withHelpType) {
+ /*
+ From spec:
+ # TYPE application:requests_total counter
+ # HELP application:requests_total Tracks the number of requests to the server
+ application:requests_total 29382
+ # TYPE application:requests_rate_per_second gauge
+ application:requests_rate_per_second 12.223
+ # TYPE application:requests_one_min_rate_per_second gauge
+ application:requests_one_min_rate_per_second 12.563
+ # TYPE application:requests_five_min_rate_per_second gauge
+ application:requests_five_min_rate_per_second 12.364
+ # TYPE application:requests_fifteen_min_rate_per_second gauge
+ application:requests_fifteen_min_rate_per_second 12.126
+ */
+
+ String name = metricId.getName();
+ String baseName = prometheusClean(name, helidonMetric.registryType() + "_");
+ String tags = tags(metricId.getTags());
+ String nameUnits = baseName + "_total";
+
+ if (withHelpType) {
+ prometheusType(sb, nameUnits, "counter");
+ prometheusHelp(sb, metadata, nameUnits);
+ }
+ sb.append(nameUnits).append(tags).append(" ").append(value.getCount()).append("\n");
+
+ nameUnits = baseName + "_rate_per_second";
+ if (withHelpType) {
+ prometheusType(sb, nameUnits, "gauge");
+ }
+ sb.append(nameUnits).append(tags).append(" ").append(value.getMeanRate()).append("\n");
+
+ nameUnits = baseName + "_one_min_rate_per_second";
+ if (withHelpType) {
+ prometheusType(sb, nameUnits, "gauge");
+ }
+ sb.append(nameUnits).append(tags).append(" ").append(value.getOneMinuteRate()).append("\n");
+
+ nameUnits = baseName + "_five_min_rate_per_second";
+ if (withHelpType) {
+ prometheusType(sb, nameUnits, "gauge");
+ }
+ sb.append(nameUnits).append(tags).append(" ").append(value.getFiveMinuteRate()).append("\n");
+
+ nameUnits = baseName + "_fifteen_min_rate_per_second";
+ if (withHelpType) {
+ prometheusType(sb, nameUnits, "gauge");
+ }
+ sb.append(nameUnits).append(tags).append(" ").append(value.getFifteenMinuteRate()).append("\n");
+
+ }
+
+ private static void gauge(StringBuilder sb,
+ MetricID metricId,
+ Metadata metadata,
+ HelidonMetric helidonMetric,
+ Gauge value,
+ boolean withHelpType) {
+ String name = nameWithUnits(helidonMetric.registryType(), metadata, metricId);
+ help(sb, metadata, name, metadata.getType(), withHelpType);
+ sb.append(name).append(tags(metricId.getTags())).append(" ").append(units(metadata).convert(value.getValue()))
+ .append('\n');
+ }
+
+ private static void counter(StringBuilder sb,
+ MetricID metricId,
+ Metadata metadata,
+ HelidonMetric helidonMetric,
+ Counter value,
+ boolean withHelpType) {
+ String name = prometheusName(helidonMetric.registryType(), metricId.getName());
+ name = name.endsWith("total") ? name : name + "_total";
+
+ help(sb, metadata, name, metadata.getType(), withHelpType);
+
+ sb.append(name).append(tags(metricId.getTags())).append(" ").append(value.getCount());
+
+ if (value instanceof SampledMetric sampled) {
+ sampled.sample().ifPresent(it -> sb.append(prometheusExemplar(units(metadata), it)));
+ }
+ sb.append('\n');
+ }
+
+ private static void concurrentGauge(StringBuilder sb,
+ MetricID metricId,
+ Metadata metadata,
+ HelidonMetric helidonMetric,
+ ConcurrentGauge value,
+ boolean withHelpType) {
+ String name = nameWithUnits(helidonMetric.registryType(), metadata, metricId);
+ String nameCurrent = name + "_current";
+ help(sb, metadata, nameCurrent, "gauge", withHelpType);
+
+ sb.append(nameCurrent).append(tags(metricId.getTags())).append(" ").append(value.getCount()).append('\n');
+ String nameMin = name + "_min";
+ if (withHelpType) {
+ prometheusType(sb, nameMin, "gauge");
+ }
+ sb.append(nameMin).append(tags(metricId.getTags())).append(" ").append(value.getMin()).append('\n');
+ String nameMax = name + "_max";
+ if (withHelpType) {
+ prometheusType(sb, nameMax, "gauge");
+ }
+ sb.append(nameMax).append(tags(metricId.getTags())).append(" ").append(value.getMax()).append('\n');
+ }
+
+ private static void help(StringBuilder sb, Metadata metadata, String name, String type, boolean withHelpType) {
+ if (withHelpType) {
+ prometheusType(sb, name, type);
+ prometheusHelp(sb, metadata, name);
+ }
+ }
+
+ private static void prometheusType(StringBuilder sb, String nameWithUnits, String type) {
+ sb.append("# TYPE ").append(nameWithUnits).append(" ").append(type).append('\n');
+ }
+
+ private static void prometheusHelp(StringBuilder sb, Metadata metadata, String nameWithUnits) {
+ sb.append("# HELP ").append(nameWithUnits).append(" ").append(metadata.getDescription()).append('\n');
+ }
+
+ private static Units units(Metadata metadata) {
+ String unit = metadata.getUnit();
+ if ((null == unit) || unit.isEmpty() || MetricUnits.NONE.equals(unit)) {
+ return new Units(null);
+ }
+
+ Units units = PROMETHEUS_CONVERTERS.get(unit);
+ return units == null ? new Units(unit, unit, Function.identity()) : units;
+ }
+
+ private static String prometheusExemplar(Units units, Sample.Labeled sample) {
+ return sample == null ? "" : prometheusExemplar(units.convert(sample.value()), sample);
+ }
+
+ private static String prometheusExemplar(Object value, Sample.Labeled sample) {
+ if (sample == null || sample.label().isBlank()) {
+ return "";
+ }
+ // The loaded service provides the entire label, including enclosing braces. For example, {trace_id=xxx}.
+ String exemplar = String.format(" # %s %s %f", sample.label(), value, sample.timestamp() / 1000.0);
+ if (exemplar.length() <= EXEMPLAR_MAX_LENGTH) {
+ return exemplar;
+ }
+ LOGGER.log(WARNING,
+ String.format("Exemplar string exceeds the maximum length(%d); suppressing '%s'",
+ exemplar.length(),
+ exemplar));
+ return "";
+ }
+
+ private static void addByteConverter(String metricUnit, long toByteRatio) {
+ PROMETHEUS_CONVERTERS.put(metricUnit, new Units(metricUnit, "bytes", o -> ((Number) o).doubleValue() * toByteRatio));
+ }
+
+ private static void addConverter(Units units) {
+ PROMETHEUS_CONVERTERS.put(units.getMetricUnit(), units);
+ }
+
+ private static void addTimeConverter(String metricUnit, TimeUnit timeUnit) {
+ PROMETHEUS_CONVERTERS.put(metricUnit, new TimeUnits(metricUnit, timeUnit));
+ }
+
+ private static String prometheusTagValue(String value) {
+ value = value.replace("\\", "\\\\");
+ value = value.replace("\"", "\\\"");
+ value = value.replace("\n", "\\n");
+ return value;
+ }
+
+ private static String prometheusClean(String name, String prefix) {
+ name = name.replaceAll("[^a-zA-Z0-9_]", "_");
+
+ //Scope is always specified at the start of the metric name.
+ //Scope and name are separated by underscore (_) as of
+ // metrics 2.0 (OpenMetrics).
+ name = prefix + name;
+
+ String orig;
+ do {
+ orig = name;
+ //Double underscore is translated to single underscore
+ name = DOUBLE_UNDERSCORE.matcher(name).replaceAll("_");
+ } while (!orig.equals(name));
+
+ do {
+ orig = name;
+ //Colon-underscore (:_) is translated to single colon
+ name = COLON_UNDERSCORE.matcher(name).replaceAll(":");
+ } while (!orig.equals(name));
+
+ return name;
+ }
+
+ private static String durationPrometheusOutput(Duration duration) {
+ return duration == null ? "NaN" : Double.toString(((double) duration.toNanos()) / 1000.0 / 1000.0 / 1000.0);
+ }
+
+ private static String exemplarForElapsedTime(Sample.Labeled sample) {
+ return sample == null ? "" : prometheusExemplar(sample.value(), sample);
+ }
+
+ private static String convertTime(Object o, TimeUnit from) {
+ return String.valueOf(TimeUnit.SECONDS.convert(new BigDecimal(String.valueOf(o)).longValue(),
+ from));
+ }
+
+ private static String convertNanos(Object o) {
+ return String.valueOf(new BigDecimal(String.valueOf(o)).doubleValue() / TimeUnits.NANOSECONDS);
+ }
+
+ private static String convertMicros(Object o) {
+ return String.valueOf(new BigDecimal(String.valueOf(o)).doubleValue() / TimeUnits.MICROSECONDS);
+ }
+
+ private static String convertMillis(Object o) {
+ return String.valueOf(new BigDecimal(String.valueOf(o)).doubleValue() / TimeUnits.MILLISECONDS);
+ }
+
+ static class Units {
+ private final String metricUnit;
+ private final String prometheusUnit;
+ private final Function converter;
+
+ Units(String unit) {
+ this.metricUnit = unit;
+ this.prometheusUnit = unit;
+ this.converter = o -> o;
+ }
+
+ private Units(String metricUnit, String prometheusUnit, Function converter) {
+ this.metricUnit = metricUnit;
+ this.prometheusUnit = prometheusUnit;
+ this.converter = converter;
+ }
+
+ public Object convert(Object value) {
+ Object apply = converter.apply(value);
+ if (apply instanceof Double) {
+ // if this is an integer value, return it as a long (so we do not see the decimal dot in output)
+ double num = (Double) apply;
+ if (Math.floor(num) == num) {
+ return (long) num;
+ }
+ }
+ return apply;
+ }
+
+ String getMetricUnit() {
+ return metricUnit;
+ }
+
+ Optional getPrometheusUnit() {
+ return Optional.ofNullable(prometheusUnit);
+ }
+ }
+
+ static final class TimeUnits extends Units {
+ static final TimeUnits PROMETHEUS_TIMER_CONVERSION_TIME_UNITS = new TimeUnits("seconds", TimeUnit.NANOSECONDS);
+ private static final long MILLISECONDS = 1000;
+ private static final long MICROSECONDS = 1000 * MILLISECONDS;
+ private static final long NANOSECONDS = 1000 * MICROSECONDS;
+ private static final String DOUBLE_NAN = String.valueOf(Double.NaN);
+ // If object is NaN return string and avoid format exception in BigDecimal
+ private static final BiFunction, Object> CHECK_NANS =
+ (o, f) -> o instanceof Double && ((Double) o).isNaN()
+ ? DOUBLE_NAN
+ : f.apply(o);
+
+ private TimeUnits(String metricUnit, TimeUnit timeUnit) {
+ super(metricUnit, "seconds", timeConverter(timeUnit));
+ }
+
+ static Function timeConverter(TimeUnit from) {
+ return switch (from) {
+ case NANOSECONDS -> (o) -> CHECK_NANS.apply(o, PrometheusFormat::convertNanos);
+ case MICROSECONDS -> (o) -> CHECK_NANS.apply(o, PrometheusFormat::convertMicros);
+ case MILLISECONDS -> (o) -> CHECK_NANS.apply(o, PrometheusFormat::convertMillis);
+ case SECONDS -> (o) -> CHECK_NANS.apply(o, String::valueOf);
+ default -> (o) -> CHECK_NANS.apply(o, it -> convertTime(it, from));
+ };
+ }
+ }
+
+ private static class LengthUnits extends Units {
+ private LengthUnits(String metricUnit, double ratio) {
+ super(metricUnit, "meters", o -> ((Number) o).doubleValue() * ratio);
+ }
+ }
+
+ /**
+ * Abstraction for a Prometheus metric name, offering various formats of output as required by the Prometheus format.
+ */
+ static class PrometheusName {
+ private final String prometheusTags;
+ private final MetricID metricID;
+ private final String prometheusNameWithUnits;
+ private final String prometheusName;
+ private final String prometheusUnit;
+ private final Units units;
+ private final String registryType;
+ private final Metadata metadata;
+
+ private PrometheusName(String registryType,
+ Metadata metadata,
+ MetricID metricID,
+ Units units,
+ String baseName) {
+ this.registryType = registryType;
+ this.metadata = metadata;
+ this.metricID = metricID;
+ this.units = units;
+ this.prometheusName = baseName;
+ this.prometheusTags = tags(metricID.getTags());
+ this.prometheusNameWithUnits = nameWithUnits(registryType,
+ metadata,
+ metricID);
+ this.prometheusUnit = units
+ .getPrometheusUnit()
+ .orElse("");
+ }
+
+ static PrometheusName create(String registryType,
+ Metadata metadata,
+ MetricID metricID,
+ Units units,
+ String baseName) {
+ return new PrometheusName(registryType, metadata, metricID, units, baseName);
+ }
+
+ Units units() {
+ return units;
+ }
+
+ /**
+ * Returns the Prometheus metric name (registry type + metric name) + units.
+ *
+ * @return name with units
+ */
+ String nameUnits() {
+ return prometheusNameWithUnits;
+ }
+
+ String nameUnits(Units units) {
+ return nameWithUnits(registryType,
+ metricID.getName(),
+ units);
+ }
+
+ /**
+ * Returns the Prometheus metric name (registry type + metric name) + statistic type + units.
+ *
+ * @param statName the statistics name (e.g., "mean") to include in the name expression
+ * @return name with stat name with units
+ */
+ String nameStatUnits(String statName) {
+ return nameStat(statName) + (prometheusUnit.isBlank() ? "" : "_" + prometheusUnit);
+ }
+
+ String nameStat(String statName) {
+ return prometheusName + "_" + statName;
+ }
+
+ String nameStatTags(String statName) {
+ return nameStat(statName) + prometheusTags;
+ }
+
+ /**
+ * Returns the Prometheus metric name (registry type + metric name) + units + suffix (e.g., "count") + tags.
+ *
+ * @param nameSuffix suffix to add to the name (after the units)
+ * @return name with units with suffix with tags
+ */
+ String nameUnitsSuffixTags(String nameSuffix) {
+ return prometheusNameWithUnits + "_" + nameSuffix + prometheusTags;
+ }
+
+ /**
+ * Returns the Prometheus format for the tags.
+ *
+ * @return tags in Prometheus format "{tag=value,tag=value,...}"
+ */
+ String prometheusTags() {
+ return prometheusTags;
+ }
+ }
+}
diff --git a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/package-info.java b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/package-info.java
index 49a62d902af..db8c4abafe3 100644
--- a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/package-info.java
+++ b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/package-info.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2021 Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -13,7 +13,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
- * API and minimal implementation for metrics support service.
+ * Tools shared by endpoints serving Metrics.
*/
package io.helidon.metrics.serviceapi;
diff --git a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/spi/MetricsSupportProvider.java b/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/spi/MetricsSupportProvider.java
deleted file mode 100644
index 1e7c70e658d..00000000000
--- a/metrics/service-api/src/main/java/io/helidon/metrics/serviceapi/spi/MetricsSupportProvider.java
+++ /dev/null
@@ -1,45 +0,0 @@
-/*
- * Copyright (c) 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics.serviceapi.spi;
-
-import io.helidon.metrics.api.MetricsSettings;
-import io.helidon.metrics.serviceapi.MetricsSupport;
-import io.helidon.servicecommon.rest.RestServiceSettings;
-
-/**
- * Provider behavior for {@link io.helidon.metrics.serviceapi.MetricsSupport.Builder} instances (and, indirectly, for {@link io.helidon.metrics.serviceapi.MetricsSupport} instances).
- *
- * @param builder type
- * @param implementation type of {@link io.helidon.metrics.serviceapi.MetricsSupport}
- */
-public interface MetricsSupportProvider, T extends MetricsSupport> {
-
- /**
- *
- * @return a new {@link MetricsSupport.Builder} for a specific implementation type of {@code MetricsSupport}
- */
- B builder();
-
- /**
- * Create a new instance of the specific type of {@link MetricsSupport}.
- *
- * @param metricsSettings metrics settings to use in creating the {@code MetricsSupport} instance
- * @param restServiceSettings REST service settings to control the service endpoint
- *
- * @return the new {@code MetricsSupport} instance
- */
- T create(MetricsSettings metricsSettings, RestServiceSettings restServiceSettings);
-}
diff --git a/metrics/service-api/src/main/java/module-info.java b/metrics/service-api/src/main/java/module-info.java
index 01354bb8cfb..7f89a7a5996 100644
--- a/metrics/service-api/src/main/java/module-info.java
+++ b/metrics/service-api/src/main/java/module-info.java
@@ -13,20 +13,16 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
- * API, SPI, and minimal implementation of metrics service.
+ * Tools for implementing metrics service endpoints.
*/
module io.helidon.metrics.serviceapi {
requires java.logging;
- requires io.helidon.reactive.webserver;
- requires static io.helidon.config.metadata;
- requires io.helidon.servicecommon.rest;
requires io.helidon.metrics.api;
+ requires jakarta.json;
exports io.helidon.metrics.serviceapi;
- exports io.helidon.metrics.serviceapi.spi;
-
- uses io.helidon.metrics.serviceapi.spi.MetricsSupportProvider;
}
diff --git a/metrics/service-api/src/test/java/io/helidon/metrics/serviceapi/MyMetricsServiceSupport.java b/metrics/service-api/src/test/java/io/helidon/metrics/serviceapi/MyMetricsServiceSupport.java
deleted file mode 100644
index fccb4cb1954..00000000000
--- a/metrics/service-api/src/test/java/io/helidon/metrics/serviceapi/MyMetricsServiceSupport.java
+++ /dev/null
@@ -1,92 +0,0 @@
-/*
- * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics.serviceapi;
-
-import java.util.logging.Logger;
-
-import io.helidon.config.Config;
-import io.helidon.metrics.api.ComponentMetricsSettings;
-import io.helidon.metrics.api.RegistryFactory;
-import io.helidon.reactive.webserver.Routing;
-import io.helidon.servicecommon.rest.HelidonRestServiceSupport;
-
-import org.eclipse.microprofile.metrics.Counter;
-import org.eclipse.microprofile.metrics.MetricRegistry;
-
-public class MyMetricsServiceSupport extends HelidonRestServiceSupport {
-
- private static final Logger LOGGER = Logger.getLogger(MyMetricsServiceSupport.class.getName());
-
- private final Counter counter;
-
- static MyMetricsServiceSupport.Builder builder() {
- return new Builder();
- }
-
- public MyMetricsServiceSupport(Builder builder) {
- super(LOGGER, builder, "myService");
-
- MetricRegistry registry = RegistryFactory
- .getInstance(builder.componentMetricsSettingsBuilder.build())
- .getRegistry(MetricRegistry.Type.APPLICATION);
- counter = registry.counter("myCounter");
- }
-
- @Override
- protected void postConfigureEndpoint(Routing.Rules defaultRules, Routing.Rules serviceEndpointRoutingRules) {
-
- }
-
- @Override
- public void update(Routing.Rules rules) {
-
- }
- void access() {
- counter.inc();
- }
-
- long getCount() {
- return counter.getCount();
- }
-
- public static class Builder extends HelidonRestServiceSupport.Builder {
-
- private ComponentMetricsSettings.Builder componentMetricsSettingsBuilder = ComponentMetricsSettings.builder();
-
- public Builder() {
- super("/myservice");
- }
-
- public Builder componentMetricsSettings(ComponentMetricsSettings.Builder componentMetricsSettingsBuilder) {
- componentMetricsSettingsBuilder = componentMetricsSettingsBuilder;
- return this;
- }
-
- @Override
- public Builder config(Config config) {
- super.config(config);
- config.get(ComponentMetricsSettings.Builder.METRICS_CONFIG_KEY)
- .as(ComponentMetricsSettings::builder)
- .ifPresent(this::componentMetricsSettings);
- return this;
- }
-
- @Override
- public MyMetricsServiceSupport build() {
- return new MyMetricsServiceSupport(this);
- }
- }
-}
diff --git a/metrics/service-api/src/test/java/io/helidon/metrics/serviceapi/TestMetricsCapableServiceSettings.java b/metrics/service-api/src/test/java/io/helidon/metrics/serviceapi/TestMetricsCapableServiceSettings.java
deleted file mode 100644
index 90c5d6fcfb9..00000000000
--- a/metrics/service-api/src/test/java/io/helidon/metrics/serviceapi/TestMetricsCapableServiceSettings.java
+++ /dev/null
@@ -1,49 +0,0 @@
-/*
- * Copyright (c) 2021 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics.serviceapi;
-
-import io.helidon.metrics.api.ComponentMetricsSettings;
-
-import org.junit.jupiter.api.Test;
-
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.is;
-
-public class TestMetricsCapableServiceSettings {
-
- @Test
- void testWithComponentMetricsDisabled() {
-
- test(false, 0L);
- }
-
- @Test
- void testWithComponentMetricsEnabled() {
- test(true, 0L);
- }
-
- private static void test(boolean componentMetricsEnabled, long expectedCounterValue) {
- ComponentMetricsSettings.Builder cms = ComponentMetricsSettings
- .builder()
- .enabled(componentMetricsEnabled);
-
- MyMetricsServiceSupport myServiceSupport = MyMetricsServiceSupport.builder().componentMetricsSettings(cms).build();
- myServiceSupport.access();
-
- assertThat("Counter value with component metrics = " + componentMetricsEnabled,
- myServiceSupport.getCount(), is(expectedCounterValue));
- }
-}
diff --git a/metrics/service-api/src/test/java/io/helidon/metrics/serviceapi/TestMinimalMetricsSupport.java b/metrics/service-api/src/test/java/io/helidon/metrics/serviceapi/TestMinimalMetricsSupport.java
deleted file mode 100644
index d2d9b7604bb..00000000000
--- a/metrics/service-api/src/test/java/io/helidon/metrics/serviceapi/TestMinimalMetricsSupport.java
+++ /dev/null
@@ -1,76 +0,0 @@
-/*
- * Copyright (c) 2021, 2022 Oracle and/or its affiliates.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.helidon.metrics.serviceapi;
-
-import java.util.concurrent.ExecutionException;
-
-import io.helidon.metrics.api.MetricsSettings;
-import io.helidon.reactive.webclient.WebClient;
-import io.helidon.reactive.webclient.WebClientResponse;
-import io.helidon.reactive.webserver.Routing;
-import io.helidon.reactive.webserver.WebServer;
-import io.helidon.servicecommon.rest.RestServiceSettings;
-
-import org.junit.jupiter.api.Test;
-
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.equalTo;
-import static org.hamcrest.Matchers.is;
-
-class TestMinimalMetricsSupport {
-
- @Test
- void testEndpoint() throws ExecutionException, InterruptedException {
- MetricsSupport metricsSupport = MetricsSupport.
- create(MetricsSettings.create(),
- RestServiceSettings.builder().webContext("/metrics").build());
-
- Routing routing = Routing.builder()
- .register(metricsSupport)
- .build();
-
- WebServer webServer = null;
-
- try {
- webServer = WebServer.builder()
- .host("localhost")
- .port(0)
- .addRouting(routing)
- .build()
- .start()
- .toCompletableFuture()
- .get();
-
-
- WebClientResponse webClientResponse = WebClient.builder()
- .baseUri("http://localhost:" + webServer.port())
- .get()
- .get()
- .path("/metrics")
- .request()
- .get();
- assertThat("Response code from /metrics endpoint", webClientResponse.status().code(), is(404));
- assertThat("Response text from /metrics endpoint",
- webClientResponse.content().as(String.class).get(),
- is(equalTo(MinimalMetricsSupport.DISABLED_ENDPOINT_MESSAGE)));
- } finally {
- if (webServer != null) {
- webServer.shutdown()
- .get();
- }
- }
- }
-}
diff --git a/metrics/trace-exemplar/src/main/java/io/helidon/metrics/exemplartrace/TraceExemplarService.java b/metrics/trace-exemplar/src/main/java/io/helidon/metrics/exemplartrace/TraceExemplarService.java
index 9beee982075..8336aed286e 100644
--- a/metrics/trace-exemplar/src/main/java/io/helidon/metrics/exemplartrace/TraceExemplarService.java
+++ b/metrics/trace-exemplar/src/main/java/io/helidon/metrics/exemplartrace/TraceExemplarService.java
@@ -16,11 +16,11 @@
package io.helidon.metrics.exemplartrace;
import io.helidon.common.context.Contexts;
-import io.helidon.metrics.ExemplarService;
+import io.helidon.metrics.api.spi.ExemplarService;
import io.helidon.tracing.SpanContext;
/**
- * Service provider for {@link io.helidon.metrics.ExemplarService}.
+ * Service provider for {@link io.helidon.metrics.api.spi.ExemplarService}.
*/
public class TraceExemplarService implements ExemplarService {
@Override
diff --git a/metrics/trace-exemplar/src/main/java/module-info.java b/metrics/trace-exemplar/src/main/java/module-info.java
index f3fc109d100..51964decbbf 100644
--- a/metrics/trace-exemplar/src/main/java/module-info.java
+++ b/metrics/trace-exemplar/src/main/java/module-info.java
@@ -14,6 +14,8 @@
* limitations under the License.
*/
+import io.helidon.metrics.api.spi.ExemplarService;
+
/**
* Provides exemplar support in metrics using tracing identifiers.
*/
@@ -23,5 +25,5 @@
requires io.helidon.common.context;
requires io.helidon.tracing;
- provides io.helidon.metrics.ExemplarService with io.helidon.metrics.exemplartrace.TraceExemplarService;
+ provides ExemplarService with io.helidon.metrics.exemplartrace.TraceExemplarService;
}
diff --git a/microprofile/access-log/pom.xml b/microprofile/access-log/pom.xml
index 777806ed11f..916a3577330 100644
--- a/microprofile/access-log/pom.xml
+++ b/microprofile/access-log/pom.xml
@@ -37,8 +37,8 @@
provided