-
Notifications
You must be signed in to change notification settings - Fork 858
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix registering new metric categories from plugins
Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>
- Loading branch information
Showing
9 changed files
with
265 additions
and
174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
...lugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/TestMetricsPlugin.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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_"); | ||
| } | ||
| } | ||
| } |
73 changes: 73 additions & 0 deletions
73
.../tests/src/test/java/org/hyperledger/besu/tests/acceptance/plugins/MetricsPluginTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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"); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
73 changes: 0 additions & 73 deletions
73
besu/src/main/java/org/hyperledger/besu/cli/converter/MetricCategoryConverter.java
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.