-
Notifications
You must be signed in to change notification settings - Fork 33
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
Add dimensions to cloudwatch metric and metric filter option for CWSink. #176
Merged
Merged
Changes from all commits
Commits
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 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 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 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
96 changes: 96 additions & 0 deletions
96
flint-core/src/main/java/org/opensearch/flint/core/metrics/reporter/DimensionedName.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,96 @@ | ||
| package org.opensearch.flint.core.metrics.reporter; | ||
|
|
||
| import com.amazonaws.services.cloudwatch.model.Dimension; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.HashSet; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| public class DimensionedName { | ||
| private static final Pattern dimensionPattern = Pattern.compile("([\\w.-]+)\\[([\\w\\W]+)]"); | ||
| private final String name; | ||
| private final Map<String, Dimension> dimensions; | ||
|
|
||
| private String encoded; | ||
|
|
||
| DimensionedName(final String name, final Map<String, Dimension> dimensions) { | ||
| this.name = name; | ||
| this.dimensions = Collections.unmodifiableMap(dimensions); | ||
| } | ||
|
|
||
| public static DimensionedName decode(final String encodedDimensionedName) { | ||
| final Matcher matcher = dimensionPattern.matcher(encodedDimensionedName); | ||
| if (matcher.find() && matcher.groupCount() == 2) { | ||
| final DimensionedNameBuilder builder = new DimensionedNameBuilder(matcher.group(1).trim()); | ||
| for (String t : matcher.group(2).split(",")) { | ||
| final String[] keyAndValue = t.split(":"); | ||
| builder.withDimension(keyAndValue[0].trim(), keyAndValue[1].trim()); | ||
| } | ||
| return builder.build(); | ||
| } else { | ||
| return new DimensionedNameBuilder(encodedDimensionedName).build(); | ||
| } | ||
| } | ||
|
|
||
| public static DimensionedNameBuilder withName(String name) { | ||
| return new DimensionedNameBuilder(name); | ||
| } | ||
|
|
||
| public DimensionedNameBuilder withDimension(final String name, final String value) { | ||
| return new DimensionedNameBuilder(this.name, new HashMap<>(this.dimensions)).withDimension(name, value); | ||
| } | ||
|
|
||
| public String getName() { | ||
| return name; | ||
| } | ||
|
|
||
| public Set<Dimension> getDimensions() { | ||
| return new HashSet<>(dimensions.values()); | ||
| } | ||
|
|
||
| public synchronized String encode() { | ||
| if (this.encoded == null) { | ||
| if (!dimensions.isEmpty()) { | ||
| final StringBuilder sb = new StringBuilder(this.name); | ||
| sb.append('['); | ||
| sb.append(this.dimensions.values().stream() | ||
| .map(dimension -> dimension.getName() + ":" + dimension.getValue()) | ||
| .collect(Collectors.joining(","))); | ||
| sb.append(']'); | ||
|
|
||
| this.encoded = sb.toString(); | ||
| } else { | ||
| this.encoded = this.name; | ||
| } | ||
| } | ||
| return this.encoded; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return this.encode(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| final DimensionedName that = (DimensionedName) o; | ||
| return Objects.equals(name, that.name) && | ||
| Objects.equals(dimensions, that.dimensions); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(name, dimensions); | ||
| } | ||
| } |
28 changes: 28 additions & 0 deletions
28
...core/src/main/java/org/opensearch/flint/core/metrics/reporter/DimensionedNameBuilder.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,28 @@ | ||
| package org.opensearch.flint.core.metrics.reporter; | ||
|
|
||
| import com.amazonaws.services.cloudwatch.model.Dimension; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| public class DimensionedNameBuilder { | ||
| private final String name; | ||
| private Map<String, Dimension> dimensions; | ||
|
|
||
| DimensionedNameBuilder(final String name) { | ||
| this(name, new HashMap<>()); | ||
| } | ||
|
|
||
| DimensionedNameBuilder(final String name, final Map<String, Dimension> dimensions) { | ||
| this.name = name; | ||
| this.dimensions = dimensions; | ||
| } | ||
|
|
||
| public DimensionedName build() { | ||
| return new DimensionedName(this.name, this.dimensions); | ||
| } | ||
|
|
||
| public DimensionedNameBuilder withDimension(final String name, final String value) { | ||
| this.dimensions.put(name, new Dimension().withName(name).withValue(value)); | ||
| return this; | ||
| } | ||
| } |
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
55 changes: 55 additions & 0 deletions
55
flint-core/src/test/java/opensearch/flint/core/metrics/reporter/DimensionedNameTest.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,55 @@ | ||
| package opensearch.flint.core.metrics.reporter; | ||
|
|
||
| import static org.hamcrest.CoreMatchers.hasItems; | ||
|
|
||
| import com.amazonaws.services.cloudwatch.model.Dimension; | ||
| import org.hamcrest.MatcherAssert; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.opensearch.flint.core.metrics.reporter.DimensionedName; | ||
|
|
||
| public class DimensionedNameTest { | ||
| @Test | ||
| public void canDecodeDimensionedString() { | ||
| final String dimensioned = "test[key1:val1,key2:val2,key3:val3]"; | ||
|
|
||
| final DimensionedName dimensionedName = DimensionedName.decode(dimensioned); | ||
|
|
||
| Assertions.assertEquals("test", dimensionedName.getName()); | ||
| Assertions.assertEquals(3, dimensionedName.getDimensions().size()); | ||
|
|
||
| MatcherAssert.assertThat(dimensionedName.getDimensions(), hasItems( | ||
| new Dimension().withName("key1").withValue("val1"), | ||
| new Dimension().withName("key2").withValue("val2"), | ||
| new Dimension().withName("key3").withValue("val3"))); | ||
| } | ||
|
|
||
| @Test | ||
| public void canEncodeDimensionedNameToString() { | ||
| final DimensionedName dimensionedName = DimensionedName.withName("test") | ||
| .withDimension("key1", "val1") | ||
| .withDimension("key2", "val2") | ||
| .withDimension("key3", "val3") | ||
| .build(); | ||
|
|
||
| Assertions.assertEquals("test[key1:val1,key2:val2,key3:val3]", dimensionedName.encode()); | ||
| } | ||
|
|
||
| @Test | ||
| public void canDeriveDimensionedNameFromCurrent() { | ||
| final DimensionedName dimensionedName = DimensionedName.withName("test") | ||
| .withDimension("key1", "val1") | ||
| .withDimension("key2", "val2") | ||
| .withDimension("key3", "val3") | ||
| .build(); | ||
|
|
||
|
|
||
| final DimensionedName derivedDimensionedName = dimensionedName | ||
| .withDimension("key3", "new_value") | ||
| .withDimension("key4", "val4").build(); | ||
|
|
||
| Assertions.assertEquals("test[key1:val1,key2:val2,key3:val3]", dimensionedName.encode()); | ||
| Assertions.assertEquals("test[key1:val1,key2:val2,key3:new_value,key4:val4]", | ||
| derivedDimensionedName.encode()); | ||
| } | ||
| } |
Oops, something went wrong.
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.
Any chance this can be
providedor not?meanwhile I'm just thinking any impact on open source user who use Flint as library. Does all classes added have to be in Flint core module?
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.
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.
There won't be any impact to opensource user. We emit metrics but nothing will be pushed unless one configures a sink.
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.
For now we only have
FlintOpenSearchClient. We may addFlintFileSystemClientlater (for storing Flint index data on S3). I was thinking for user who use Flint library in their own application.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.
Even for them we are actually providing benefit by giving out metrics similar to driver and executor metrics. CWSink they can leverage if they wish, otherwise they can ignore. We can discuss offline on this and will post the summary over here.