Improve Log Attributes API #4416
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| package io.sentry; | ||
|
|
||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| public final class SentryAttribute { | ||
|
|
||
| private final @NotNull String name; | ||
| private final @Nullable SentryAttributeType type; | ||
| private final @Nullable Object value; | ||
|
|
||
| private SentryAttribute( | ||
| final @NotNull String name, | ||
| final @Nullable SentryAttributeType type, | ||
| final @Nullable Object value) { | ||
| this.name = name; | ||
| this.type = type; | ||
| this.value = value; | ||
| } | ||
|
|
||
| public @NotNull String getName() { | ||
| return name; | ||
| } | ||
|
|
||
| public @Nullable SentryAttributeType getType() { | ||
| return type; | ||
| } | ||
|
|
||
| public @Nullable Object getValue() { | ||
| return value; | ||
| } | ||
|
|
||
| public static @NotNull SentryAttribute named( | ||
| final @NotNull String name, final @Nullable Object value) { | ||
| return new SentryAttribute(name, null, value); | ||
| } | ||
|
|
||
| public static @NotNull SentryAttribute booleanAttribute( | ||
|
There was a problem hiding this comment. L: how about |
||
| final @NotNull String name, final @Nullable Boolean value) { | ||
| return new SentryAttribute(name, SentryAttributeType.BOOLEAN, value); | ||
| } | ||
|
|
||
| public static @NotNull SentryAttribute integerAttribute( | ||
| final @NotNull String name, final @Nullable Integer value) { | ||
| return new SentryAttribute(name, SentryAttributeType.INTEGER, value); | ||
| } | ||
|
|
||
| public static @NotNull SentryAttribute doubleAttribute( | ||
| final @NotNull String name, final @Nullable Double value) { | ||
| return new SentryAttribute(name, SentryAttributeType.DOUBLE, value); | ||
| } | ||
|
|
||
| public static @NotNull SentryAttribute stringAttribute( | ||
| final @NotNull String name, final @Nullable String value) { | ||
| return new SentryAttribute(name, SentryAttributeType.STRING, 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| package io.sentry; | ||
|
|
||
| import java.util.Locale; | ||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
| public enum SentryAttributeType { | ||
| STRING, | ||
| BOOLEAN, | ||
| INTEGER, | ||
| DOUBLE; | ||
|
|
||
| public @NotNull String apiName() { | ||
| return name().toLowerCase(Locale.ROOT); | ||
| } | ||
| } |
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,44 @@ | ||
| package io.sentry; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| public final class SentryAttributes { | ||
|
|
||
| private final @NotNull List<SentryAttribute> attributes; | ||
|
There was a problem hiding this comment. should we change this to Map<String, SentryAttribute>? |
||
|
|
||
| private SentryAttributes(final @NotNull List<SentryAttribute> attributes) { | ||
| this.attributes = attributes; | ||
| } | ||
|
|
||
| public void add(final @Nullable SentryAttribute attribute) { | ||
| if (attribute == null) { | ||
| return; | ||
| } | ||
| attributes.add(attribute); | ||
| } | ||
|
|
||
| public @NotNull List<SentryAttribute> getAttributes() { | ||
| return attributes; | ||
| } | ||
|
|
||
| public static @NotNull SentryAttributes of(SentryAttribute... attributes) { | ||
| return new SentryAttributes(Arrays.asList(attributes)); | ||
|
There was a problem hiding this comment. Where we use this class, we rely on |
||
| } | ||
|
|
||
| public static @NotNull SentryAttributes fromMap(final @Nullable Map<String, Object> attributes) { | ||
| if (attributes == null) { | ||
| return new SentryAttributes(new ArrayList<>()); | ||
| } | ||
| SentryAttributes sentryAttributes = new SentryAttributes(new ArrayList<>(attributes.size())); | ||
| for (Map.Entry<String, Object> attribute : attributes.entrySet()) { | ||
| sentryAttributes.add(SentryAttribute.named(attribute.getKey(), attribute.getValue())); | ||
| } | ||
|
Comment on lines
+38
to
+40
There was a problem hiding this comment. See above, we could filter for nulls here. |
||
|
|
||
| return sentryAttributes; | ||
| } | ||
| } | ||
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
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,42 @@ | ||
| package io.sentry.logger; | ||
|
|
||
| import io.sentry.SentryAttributes; | ||
| import io.sentry.SentryDate; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| public final class LogParams { | ||
|
|
||
| private @Nullable SentryDate timestamp; | ||
| private @Nullable SentryAttributes attributes; | ||
|
|
||
| public @Nullable SentryDate getTimestamp() { | ||
| return timestamp; | ||
| } | ||
|
|
||
| public void setTimestamp(final @Nullable SentryDate timestamp) { | ||
| this.timestamp = timestamp; | ||
| } | ||
|
|
||
| public @Nullable SentryAttributes getAttributes() { | ||
| return attributes; | ||
| } | ||
|
|
||
| public void setAttributes(final @Nullable SentryAttributes attributes) { | ||
| this.attributes = attributes; | ||
| } | ||
|
|
||
| public static @NotNull LogParams create( | ||
| final @Nullable SentryDate timestamp, final @Nullable SentryAttributes attributes) { | ||
| final @NotNull LogParams params = new LogParams(); | ||
|
|
||
| params.setTimestamp(timestamp); | ||
| params.setAttributes(attributes); | ||
|
|
||
| return params; | ||
| } | ||
|
Comment on lines
+29
to
+37
There was a problem hiding this comment. why is this not directly the constructor? |
||
|
|
||
| public static @NotNull LogParams create(final @Nullable SentryAttributes attributes) { | ||
| return create(null, attributes); | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
We call this in
sentry/src/main/java/io/sentry/SentryAttributes.javawhen building attributes from a Map.As we take in a generic Map, the key for an entry could be
null.We should check for nulls either here (making the
nameparam nullable and e.g. not constructing the attribute if it is) or insentry/src/main/java/io/sentry/SentryAttributes.javawhen iterating the entry set.