io.helidon.integrations.microstream.metrics.MicrostreamMetricsSupport Maven / Gradle / Ivy
/*
* Copyright (c) 2021, 2023 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.integrations.microstream.metrics;
import java.util.List;
import java.util.Objects;
import java.util.function.ToDoubleFunction;
import io.helidon.common.config.Config;
import io.helidon.metrics.api.Gauge;
import io.helidon.metrics.api.MeterRegistry;
import io.helidon.metrics.api.MetricsConfig;
import io.helidon.metrics.api.MetricsFactory;
import io.helidon.metrics.api.Tag;
import one.microstream.storage.embedded.types.EmbeddedStorageManager;
import one.microstream.storage.types.StorageRawFileStatistics;
import static io.helidon.metrics.api.Meter.BaseUnits.BYTES;
/**
*
* Helper class that provides the default metrics for an Microstream EmbeddedStorageManager.
*
*/
public class MicrostreamMetricsSupport {
private static final String CONFIG_METRIC_ENABLED_VENDOR = "vendor.";
private static final GaugeInfo GLOBAL_FILE_COUNT =
new GaugeInfo<>("microstream.globalFileCount",
"Displays the number of storage files.",
null,
StorageRawFileStatistics::fileCount);
private static final GaugeInfo LIVE_DATA_LENGTH =
new GaugeInfo<>("microstream.liveDataLength",
"Displays live data length. This is the 'real' size of the stored data.",
BYTES,
StorageRawFileStatistics::liveDataLength);
private static final GaugeInfo TOTAL_DATA_LENGTH =
new GaugeInfo<>("microstream.totalDataLength",
"Displays total data length. This is the accumulated size of all storage data files.",
BYTES,
StorageRawFileStatistics::totalDataLength);
private final Config config;
private final EmbeddedStorageManager embeddedStorageManager;
private final MeterRegistry vendorRegistry;
private MicrostreamMetricsSupport(Builder builder) {
super();
this.config = builder.config();
this.embeddedStorageManager = builder.embeddedStorageManager();
MetricsFactory metricsFactory;
if (builder.metricsFactory() == null) {
metricsFactory = MetricsFactory.getInstance(config.get(MetricsConfig.METRICS_CONFIG_KEY));
} else {
metricsFactory = builder.metricsFactory();
}
this.vendorRegistry = metricsFactory.globalRegistry();
}
/**
* Create a new builder to construct an instance.
*
* @param embeddedStorageManager EmbeddedStorageManager instance that supplies the metrics data.
* @return A new builder instance
*/
public static Builder builder(EmbeddedStorageManager embeddedStorageManager) {
return new Builder(embeddedStorageManager);
}
private void register(GaugeInfo gaugeInfo, StorageRawFileStatistics stats) {
if (config.get(CONFIG_METRIC_ENABLED_VENDOR + gaugeInfo.name + ".enabled")
.asBoolean()
.orElse(true)) {
vendorRegistry.getOrCreate(gaugeInfo.builder(stats));
}
}
private record GaugeInfo(String name,
String description,
String unit,
ToDoubleFunction fn,
Tag... tags) {
Gauge.Builder builder(T stateObject) {
Gauge.Builder builder = Gauge.builder(name, stateObject, fn)
.description(description);
if (unit != null) {
builder.baseUnit(unit);
}
if (tags != null) {
builder.tags(List.of(tags));
}
return builder;
}
}
/**
* Register this metrics at the vendor metrics registry.
*/
public void registerMetrics() {
StorageRawFileStatistics stats = embeddedStorageManager.createStorageStatistics();
register(GLOBAL_FILE_COUNT, stats);
register(LIVE_DATA_LENGTH, stats);
register(TOTAL_DATA_LENGTH, stats);
}
/**
* A fluent API builder to build instances of {@link io.helidon.integrations.microstream.metrics.MicrostreamMetricsSupport}.
*/
public static final class Builder implements io.helidon.common.Builder {
private final EmbeddedStorageManager embeddedStorageManager;
private Config config = Config.empty();
private MetricsFactory metricsFactory;
private Builder(EmbeddedStorageManager embeddedStorageManager) {
Objects.requireNonNull(embeddedStorageManager);
this.embeddedStorageManager = embeddedStorageManager;
}
@Override
public MicrostreamMetricsSupport build() {
return new MicrostreamMetricsSupport(this);
}
/**
* get the current configured MetricsFactory.
* @return MetricsFactory
*/
public MetricsFactory metricsFactory() {
return this.metricsFactory;
}
/**
* get the current configuredEmbeddedStorageManager.
* @return EmbeddedStorageManager
*/
public EmbeddedStorageManager embeddedStorageManager() {
return this.embeddedStorageManager;
}
/**
* get the current configured helidon configuration.
* @return Config
*/
public Config config() {
return this.config;
}
/**
* set the MetricsFactory.
*
* @param metricsFactory metrics factory
* @return MicrostreamMetricsSupport builder
*/
public Builder metricsFactory(MetricsFactory metricsFactory) {
this.metricsFactory = metricsFactory;
return this;
}
/**
* set the helidon configuration used by the builder.
*
* @param config configuration
* @return MicrostreamMetricsSupport builder
*/
public Builder config(Config config) {
this.config = config;
return this;
}
}
}