Skip to content

feat: #421 Support for Boolean and Number type as value in TracingUtils putAnnotation #423

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 1 commit into from
Jun 14, 2021
Merged

feat: #421 Support for Boolean and Number type as value in TracingUtils putAnnotation #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 23 additions & 1 deletion powertools-tracing/src/main/java/software/amazon/lambda/powertools/tracing/TracingUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
public final class TracingUtils {

/**
* Put an annotation to the current subsegment.
* Put an annotation to the current subsegment with a String value.
*
* @param key the key of the annotation
* @param value the value of the annotation
Expand All @@ -39,6 +39,28 @@ public static void putAnnotation(String key, String value) {
.ifPresent(segment -> segment.putAnnotation(key, value));
}

/**
* Put an annotation to the current subsegment with a Number value.
*
* @param key the key of the annotation
* @param value the value of the annotation
*/
public static void putAnnotation(String key, Number value) {
AWSXRay.getCurrentSubsegmentOptional()
.ifPresent(segment -> segment.putAnnotation(key, value));
}

/**
* Put an annotation to the current subsegment with a Boolean value.
*
* @param key the key of the annotation
* @param value the value of the annotation
*/
public static void putAnnotation(String key, Boolean value) {
AWSXRay.getCurrentSubsegmentOptional()
.ifPresent(segment -> segment.putAnnotation(key, value));
}

/**
* Put additional metadata for the current subsegment.
*
Expand Down
13 changes: 10 additions & 3 deletions ...ols-tracing/src/test/java/software/amazon/lambda/powertools/tracing/TracingUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.entry;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static software.amazon.lambda.powertools.tracing.TracingUtils.withEntitySubsegment;
Expand All @@ -45,11 +46,17 @@ void tearDown() {
void shouldSetAnnotationOnCurrentSubSegment() {
AWSXRay.beginSubsegment("subSegment");

TracingUtils.putAnnotation("key", "val");
TracingUtils.putAnnotation("stringKey", "val");
TracingUtils.putAnnotation("numberKey", 10);
TracingUtils.putAnnotation("booleanKey", false);

assertThat(AWSXRay.getTraceEntity().getAnnotations())
.hasSize(1)
.containsEntry("key", "val");
.hasSize(3)
.contains(
entry("stringKey", "val"),
entry("numberKey", 10),
entry("booleanKey", false)
);
}

@Test
Expand Down