Skip to content

Commit

Permalink
IGNITE-23718 Improve logging for ScaleCubeMessage (apache#4759)
Browse files Browse the repository at this point in the history
  • Loading branch information
sashapolo authored Nov 20, 2024
1 parent 5a9f1ec commit ad20fa8
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
2 changes: 0 additions & 2 deletions .idea/codeStyles/Project.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ default boolean needAck() {
/**
* Returns a lightweight string representation of a network message for logging.
*
* <p>NOTE: Avoid output sensetive information.</p>
* <p>NOTE: Avoid displaying sensitive information.</p>
*/
default String toStringForLightLogging() {
return getClass().getName();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@
import org.jetbrains.annotations.Nullable;

/**
* Wrapper for ScaleCube's {@link Message}. {@link Message#data} is stored in {@link #data} or {@link #message} depending on the type of the
* data (whether it is a {@link NetworkMessage} or not) and {@link Message#headers} are stored in {@link #headers}.
* Wrapper for ScaleCube's {@link Message}.
*
* <p>{@link Message#data()} is stored in {@link #data} or {@link #message} depending on the type of
* the data (whether it is a {@link NetworkMessage} or not) and {@link Message#headers()} are stored in {@link #headers}.
*/
@Transferable(NetworkMessageTypes.SCALE_CUBE_MESSAGE)
public interface ScaleCubeMessage extends NetworkMessage {
Expand All @@ -39,4 +41,17 @@ public interface ScaleCubeMessage extends NetworkMessage {
NetworkMessage message();

Map<String, String> headers();

@Override
default String toStringForLightLogging() {
Object data = data();

String dataString = data == null ? "null" : data.getClass().getName();

NetworkMessage message = message();

String messageString = message == null ? "null" : message.toStringForLightLogging();

return getClass().getName() + ": [data=" + dataString + ", message=" + messageString + "]";
}
}

0 comments on commit ad20fa8

Please sign in to comment.