mirror of https://github.com/hyperledger/besu
Fix registering new metric categories from plugins (#7825)
Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>pull/7832/head
Fabio Di Fabio
3 weeks ago
committed by
GitHub
parent
f82bb7d6b7
commit
22a570eda4
@ -0,0 +1,76 @@ |
|||||||
|
/* |
||||||
|
* Copyright contributors to Besu. |
||||||
|
* |
||||||
|
* 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. |
||||||
|
* |
||||||
|
* SPDX-License-Identifier: Apache-2.0 |
||||||
|
*/ |
||||||
|
package org.hyperledger.besu.tests.acceptance.plugins; |
||||||
|
|
||||||
|
import org.hyperledger.besu.plugin.BesuContext; |
||||||
|
import org.hyperledger.besu.plugin.BesuPlugin; |
||||||
|
import org.hyperledger.besu.plugin.services.MetricsSystem; |
||||||
|
import org.hyperledger.besu.plugin.services.metrics.MetricCategory; |
||||||
|
import org.hyperledger.besu.plugin.services.metrics.MetricCategoryRegistry; |
||||||
|
|
||||||
|
import java.util.Locale; |
||||||
|
import java.util.Optional; |
||||||
|
|
||||||
|
import com.google.auto.service.AutoService; |
||||||
|
import org.slf4j.Logger; |
||||||
|
import org.slf4j.LoggerFactory; |
||||||
|
|
||||||
|
@AutoService(BesuPlugin.class) |
||||||
|
public class TestMetricsPlugin implements BesuPlugin { |
||||||
|
private static final Logger LOG = LoggerFactory.getLogger(TestMetricsPlugin.class); |
||||||
|
private BesuContext besuContext; |
||||||
|
|
||||||
|
@Override |
||||||
|
public void register(final BesuContext context) { |
||||||
|
LOG.info("Registering TestMetricsPlugin"); |
||||||
|
besuContext = context; |
||||||
|
context |
||||||
|
.getService(MetricCategoryRegistry.class) |
||||||
|
.orElseThrow() |
||||||
|
.addMetricCategory(TestMetricCategory.TEST_METRIC_CATEGORY); |
||||||
|
} |
||||||
|
|
||||||
|
@Override |
||||||
|
public void start() { |
||||||
|
LOG.info("Starting TestMetricsPlugin"); |
||||||
|
besuContext |
||||||
|
.getService(MetricsSystem.class) |
||||||
|
.orElseThrow() |
||||||
|
.createGauge( |
||||||
|
TestMetricCategory.TEST_METRIC_CATEGORY, |
||||||
|
"test_metric", |
||||||
|
"Returns 1 on succes", |
||||||
|
() -> 1.0); |
||||||
|
} |
||||||
|
|
||||||
|
@Override |
||||||
|
public void stop() { |
||||||
|
LOG.info("Stopping TestMetricsPlugin"); |
||||||
|
} |
||||||
|
|
||||||
|
public enum TestMetricCategory implements MetricCategory { |
||||||
|
TEST_METRIC_CATEGORY; |
||||||
|
|
||||||
|
@Override |
||||||
|
public String getName() { |
||||||
|
return name().toLowerCase(Locale.ROOT); |
||||||
|
} |
||||||
|
|
||||||
|
@Override |
||||||
|
public Optional<String> getApplicationPrefix() { |
||||||
|
return Optional.of("plugin_test_"); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,73 @@ |
|||||||
|
/* |
||||||
|
* Copyright contributors to Besu. |
||||||
|
* |
||||||
|
* 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. |
||||||
|
* |
||||||
|
* SPDX-License-Identifier: Apache-2.0 |
||||||
|
*/ |
||||||
|
package org.hyperledger.besu.tests.acceptance.plugins; |
||||||
|
|
||||||
|
import static org.assertj.core.api.Assertions.assertThat; |
||||||
|
import static org.hyperledger.besu.tests.acceptance.plugins.TestMetricsPlugin.TestMetricCategory.TEST_METRIC_CATEGORY; |
||||||
|
|
||||||
|
import org.hyperledger.besu.metrics.prometheus.MetricsConfiguration; |
||||||
|
import org.hyperledger.besu.tests.acceptance.dsl.AcceptanceTestBase; |
||||||
|
import org.hyperledger.besu.tests.acceptance.dsl.node.BesuNode; |
||||||
|
import org.hyperledger.besu.tests.acceptance.dsl.node.configuration.BesuNodeConfigurationBuilder; |
||||||
|
|
||||||
|
import java.io.IOException; |
||||||
|
import java.net.URI; |
||||||
|
import java.net.http.HttpClient; |
||||||
|
import java.net.http.HttpRequest; |
||||||
|
import java.net.http.HttpResponse; |
||||||
|
import java.util.List; |
||||||
|
import java.util.Set; |
||||||
|
|
||||||
|
import org.junit.jupiter.api.BeforeEach; |
||||||
|
import org.junit.jupiter.api.Test; |
||||||
|
|
||||||
|
public class MetricsPluginTest extends AcceptanceTestBase { |
||||||
|
private BesuNode node; |
||||||
|
private MetricsConfiguration metricsConfiguration; |
||||||
|
|
||||||
|
@BeforeEach |
||||||
|
public void setUp() throws Exception { |
||||||
|
metricsConfiguration = |
||||||
|
MetricsConfiguration.builder() |
||||||
|
.enabled(true) |
||||||
|
.port(0) |
||||||
|
.metricCategories(Set.of(TEST_METRIC_CATEGORY)) |
||||||
|
.build(); |
||||||
|
node = |
||||||
|
besu.create( |
||||||
|
new BesuNodeConfigurationBuilder() |
||||||
|
.name("node1") |
||||||
|
.plugins(List.of("testPlugins")) |
||||||
|
.metricsConfiguration(metricsConfiguration) |
||||||
|
.build()); |
||||||
|
|
||||||
|
cluster.start(node); |
||||||
|
} |
||||||
|
|
||||||
|
@Test |
||||||
|
public void metricCategoryAdded() throws IOException, InterruptedException { |
||||||
|
final var httpClient = HttpClient.newHttpClient(); |
||||||
|
final var req = HttpRequest.newBuilder(URI.create(node.metricsHttpUrl().get())).build(); |
||||||
|
final var resp = httpClient.send(req, HttpResponse.BodyHandlers.ofLines()); |
||||||
|
assertThat(resp.statusCode()).isEqualTo(200); |
||||||
|
final var foundMetric = |
||||||
|
resp.body() |
||||||
|
.filter( |
||||||
|
line -> line.startsWith(TEST_METRIC_CATEGORY.getApplicationPrefix().orElseThrow())) |
||||||
|
.findFirst() |
||||||
|
.orElseThrow(); |
||||||
|
assertThat(foundMetric).endsWith("1.0"); |
||||||
|
} |
||||||
|
} |
||||||
@ -1,73 +0,0 @@ |
|||||||
/* |
|
||||||
* Copyright ConsenSys AG. |
|
||||||
* |
|
||||||
* 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. |
|
||||||
* |
|
||||||
* SPDX-License-Identifier: Apache-2.0 |
|
||||||
*/ |
|
||||||
package org.hyperledger.besu.cli.converter; |
|
||||||
|
|
||||||
import org.hyperledger.besu.plugin.services.metrics.MetricCategory; |
|
||||||
|
|
||||||
import java.util.EnumSet; |
|
||||||
import java.util.HashMap; |
|
||||||
import java.util.Locale; |
|
||||||
import java.util.Map; |
|
||||||
|
|
||||||
import com.google.common.annotations.VisibleForTesting; |
|
||||||
import picocli.CommandLine; |
|
||||||
|
|
||||||
/** The Metric category converter for CLI options. */ |
|
||||||
public class MetricCategoryConverter implements CommandLine.ITypeConverter<MetricCategory> { |
|
||||||
|
|
||||||
private final Map<String, MetricCategory> metricCategories = new HashMap<>(); |
|
||||||
|
|
||||||
/** Default Constructor. */ |
|
||||||
public MetricCategoryConverter() {} |
|
||||||
|
|
||||||
@Override |
|
||||||
public MetricCategory convert(final String value) { |
|
||||||
final MetricCategory category = metricCategories.get(value); |
|
||||||
if (category == null) { |
|
||||||
throw new IllegalArgumentException("Unknown category: " + value); |
|
||||||
} |
|
||||||
return category; |
|
||||||
} |
|
||||||
|
|
||||||
/** |
|
||||||
* Add Metrics categories. |
|
||||||
* |
|
||||||
* @param <T> the type parameter |
|
||||||
* @param categoryEnum the category enum |
|
||||||
*/ |
|
||||||
public <T extends Enum<T> & MetricCategory> void addCategories(final Class<T> categoryEnum) { |
|
||||||
EnumSet.allOf(categoryEnum) |
|
||||||
.forEach(category -> metricCategories.put(category.name(), category)); |
|
||||||
} |
|
||||||
|
|
||||||
/** |
|
||||||
* Add registry category. |
|
||||||
* |
|
||||||
* @param metricCategory the metric category |
|
||||||
*/ |
|
||||||
public void addRegistryCategory(final MetricCategory metricCategory) { |
|
||||||
metricCategories.put(metricCategory.getName().toUpperCase(Locale.ROOT), metricCategory); |
|
||||||
} |
|
||||||
|
|
||||||
/** |
|
||||||
* Gets metric categories. |
|
||||||
* |
|
||||||
* @return the metric categories |
|
||||||
*/ |
|
||||||
@VisibleForTesting |
|
||||||
Map<String, MetricCategory> getMetricCategories() { |
|
||||||
return metricCategories; |
|
||||||
} |
|
||||||
} |
|
||||||
@ -1,63 +0,0 @@ |
|||||||
/* |
|
||||||
* Copyright ConsenSys AG. |
|
||||||
* |
|
||||||
* 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. |
|
||||||
* |
|
||||||
* SPDX-License-Identifier: Apache-2.0 |
|
||||||
*/ |
|
||||||
package org.hyperledger.besu.cli.converter; |
|
||||||
|
|
||||||
import static org.assertj.core.api.Assertions.assertThat; |
|
||||||
import static org.assertj.core.api.Assertions.assertThatExceptionOfType; |
|
||||||
import static org.mockito.Mockito.when; |
|
||||||
|
|
||||||
import org.hyperledger.besu.plugin.services.metrics.MetricCategory; |
|
||||||
|
|
||||||
import org.junit.jupiter.api.BeforeEach; |
|
||||||
import org.junit.jupiter.api.Test; |
|
||||||
import org.junit.jupiter.api.extension.ExtendWith; |
|
||||||
import org.mockito.Mock; |
|
||||||
import org.mockito.junit.jupiter.MockitoExtension; |
|
||||||
|
|
||||||
@ExtendWith(MockitoExtension.class) |
|
||||||
public class MetricCategoryConverterTest { |
|
||||||
|
|
||||||
private MetricCategoryConverter metricCategoryConverter; |
|
||||||
|
|
||||||
@Mock MetricCategory metricCategory; |
|
||||||
|
|
||||||
@BeforeEach |
|
||||||
public void setUp() { |
|
||||||
metricCategoryConverter = new MetricCategoryConverter(); |
|
||||||
} |
|
||||||
|
|
||||||
@Test |
|
||||||
public void convertShouldFailIfValueNotRegistered() { |
|
||||||
assertThatExceptionOfType(IllegalArgumentException.class) |
|
||||||
.isThrownBy(() -> metricCategoryConverter.convert("notRegistered")); |
|
||||||
} |
|
||||||
|
|
||||||
@Test |
|
||||||
public void addRegistryCategoryShouldUppercaseInputValues() { |
|
||||||
when(metricCategory.getName()).thenReturn("testcat"); |
|
||||||
metricCategoryConverter.addRegistryCategory(metricCategory); |
|
||||||
when(metricCategory.getName()).thenReturn("tesTCat2"); |
|
||||||
metricCategoryConverter.addRegistryCategory(metricCategory); |
|
||||||
|
|
||||||
final boolean containsLowercase = |
|
||||||
metricCategoryConverter.getMetricCategories().keySet().stream() |
|
||||||
.anyMatch(testString -> testString.chars().anyMatch(Character::isLowerCase)); |
|
||||||
|
|
||||||
assertThat(containsLowercase).isFalse(); |
|
||||||
assertThat(metricCategoryConverter.getMetricCategories().size()).isEqualTo(2); |
|
||||||
assertThat(metricCategoryConverter.getMetricCategories().keySet()) |
|
||||||
.containsExactlyInAnyOrder("TESTCAT", "TESTCAT2"); |
|
||||||
} |
|
||||||
} |
|
||||||
Loading…
Reference in new issue