-
Notifications
You must be signed in to change notification settings - Fork 571
[3.x] Fix improper handling of metrics global tags #5812
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
tjquinno
merged 2 commits into
helidon-io:helidon-3.x
from
tjquinno:metrics-config-prefix-3.x
Jan 10, 2023
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
48 changes: 48 additions & 0 deletions
48
metrics/api/src/test/java/io/helidon/metrics/api/TestGlobalTags.java
This file contains hidden or 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,48 @@ | ||
| /* | ||
| * Copyright (c) 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.metrics.api; | ||
|
|
||
| import java.util.AbstractMap; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.condition.DisabledIfSystemProperty; | ||
| import org.junit.jupiter.api.condition.EnabledIfSystemProperty; | ||
|
|
||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.hamcrest.Matchers.emptyIterable; | ||
| import static org.hamcrest.Matchers.hasItem; | ||
|
|
||
| class TestGlobalTags { | ||
|
|
||
| @Test | ||
| @DisabledIfSystemProperty(named = "testSelection", matches = "topLevelAndMetricsLevel") | ||
| void testTopLevelTagsIgnoredForMetrics() { | ||
| MetricsSettings metricsSettings = MetricsSettings.create(); | ||
| assertThat("Global tags with top-level 'tags' assigned", metricsSettings.globalTags().entrySet(), emptyIterable()); | ||
| } | ||
|
|
||
| @Test | ||
| @EnabledIfSystemProperty(named = "testSelection", matches = "topLevelAndMetricsLevel") | ||
| void testGlobalTagsForMetrics() { | ||
| String tag = "myTag"; | ||
| String value = "myValue"; | ||
| String globalTags = tag + "=" + value; | ||
| MetricsSettings metricsSettings = MetricsSettings.create(); | ||
| assertThat("Global tags with top-level and metrics 'tags' assigned", | ||
| metricsSettings.globalTags().entrySet(), | ||
| hasItem(new AbstractMap.SimpleEntry<>(tag, value))); | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
37 changes: 37 additions & 0 deletions
37
microprofile/metrics/src/test/java/io/helidon/microprofile/metrics/TestConfigProcessing.java
This file contains hidden or 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,37 @@ | ||
| /* | ||
| * Copyright (c) 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.microprofile.metrics; | ||
|
|
||
| import io.helidon.config.Config; | ||
| import io.helidon.microprofile.tests.junit5.HelidonTest; | ||
|
|
||
| import jakarta.enterprise.inject.spi.CDI; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.hamcrest.Matchers.is; | ||
|
|
||
| @HelidonTest() | ||
| class TestConfigProcessing { | ||
|
|
||
| @Test | ||
| void checkTopLeveTagsIgnoredForMetrics() { | ||
| MetricsCdiExtension extension = CDI.current().getBeanManager().getExtension(MetricsCdiExtension.class); | ||
| Config seConfig = extension.seComponentConfig(); | ||
| Config metricsTags = seConfig.get("tags"); | ||
| assertThat("Tags setting is present", metricsTags.asString().isPresent(), is(false)); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How incompatible is this change? I'm concerned that users will have defined a top-level config key of "tags" to get metrics global tags to work -- or maybe that is unlikely.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this would be very unlikely, and if they did it should be an easy change to begin using the correct key.