Skip to content

Skip adding dimensions with empty dimension value into default dimension #126

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.

Sign up for GitHub

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
merged 6 commits into from
Oct 6, 2022
Merged

Skip adding dimensions with empty dimension value into default dimension #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1c57889
Skip adding dimensions with empty dimension value into default dimens…
paggynie Oct 5, 2022
9bc80f5
fix UT test name of empty dimension value
paggynie Oct 5, 2022
027f8eb
add stronger dimension validation on default dimension
paggynie Oct 6, 2022
bdbfdbb
remove unused import
paggynie Oct 6, 2022
b9369d4
fix format
paggynie Oct 6, 2022
95824a5
change name of exception
paggynie Oct 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions src/main/java/software/amazon/cloudwatchlogs/emf/logger/MetricsLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@
import java.util.function.Supplier;
import lombok.Getter;
import lombok.Setter;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import software.amazon.cloudwatchlogs.emf.environment.Environment;
import software.amazon.cloudwatchlogs.emf.environment.EnvironmentProvider;
import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
import software.amazon.cloudwatchlogs.emf.exception.InvalidDimensionException;
import software.amazon.cloudwatchlogs.emf.exception.InvalidMetricException;
import software.amazon.cloudwatchlogs.emf.exception.InvalidNamespaceException;
import software.amazon.cloudwatchlogs.emf.exception.InvalidTimestampException;
Expand Down Expand Up @@ -259,19 +260,25 @@ public MetricsLogger setTimestamp(Instant timestamp) throws InvalidTimestampExce
return this;
}

@SneakyThrows
private void configureContextForEnvironment(MetricsContext context, Environment environment) {
if (context.hasDefaultDimensions()) {
return;
}
DimensionSet defaultDimension = new DimensionSet();
defaultDimension.addDimension("LogGroup", environment.getLogGroupName());
defaultDimension.addDimension("ServiceName", environment.getName());
defaultDimension.addDimension("ServiceType", environment.getType());
setDefaultDimension(defaultDimension, "LogGroup", environment.getLogGroupName());
setDefaultDimension(defaultDimension, "ServiceName", environment.getName());
setDefaultDimension(defaultDimension, "ServiceType", environment.getType());
context.setDefaultDimensions(defaultDimension);
environment.configureContext(context);
}

private void setDefaultDimension(DimensionSet defaultDimension, String dimKey, String dimVal) {
try {
defaultDimension.addDimension(dimKey, dimVal);
} catch (InvalidDimensionException | DimensionSetExceededException ignored) {
}
}

private MetricsLogger applyReadLock(Supplier<MetricsLogger> any) {
rwl.readLock().lock();
try {
Expand Down
25 changes: 25 additions & 0 deletions src/test/java/software/amazon/cloudwatchlogs/emf/logger/MetricsLoggerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

import java.time.Instant;
import java.util.List;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -84,6 +85,30 @@ void putDimensions_setsDimension()
sink.getContext().getDimensions().get(0).getDimensionValue(dimensionName));
}

@Test
void whenDefaultDimension_DimensionValue_Empty() throws DimensionSetExceededException {
when(environment.getLogGroupName()).thenReturn("");
logger.flush();

assertEquals(1, sink.getContext().getDimensions().size());
Set<String> dimensionKeys = sink.getContext().getDimensions().get(0).getDimensionKeys();
assertEquals(2, dimensionKeys.size());
dimensionKeys.contains("ServiceName");
dimensionKeys.contains("ServiceType");
}

@Test
void whenDefaultDimension_DimensionValue_Blank() throws DimensionSetExceededException {
when(environment.getLogGroupName()).thenReturn(" ");
logger.flush();

assertEquals(1, sink.getContext().getDimensions().size());
Set<String> dimensionKeys = sink.getContext().getDimensions().get(0).getDimensionKeys();
assertEquals(2, dimensionKeys.size());
dimensionKeys.contains("ServiceName");
dimensionKeys.contains("ServiceType");
}

@ParameterizedTest
@ValueSource(strings = {"", " ", "ƊĪⱮḔǸŠƗȌŅ", ":dim"})
void whenSetDimension_withInvalidName_thenThrowInvalidDimensionException(String dimensionName) {
Expand Down