(ignite-3) branch main updated: IGNITE-23718 Improve logging for ScaleCubeMessage (#4759)

[apolovtsev]

This is an automated email from the ASF dual-hosted git repository.

apolovtsev pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git


The following commit(s) were added to refs/heads/main by this push:
     new ad20fa8730 IGNITE-23718 Improve logging for ScaleCubeMessage (#4759)
ad20fa8730 is described below

commit ad20fa87303c506e0f64289d94cbf2832ef6095a
Author: Alexander Polovtcev <alex.polovt...@gmail.com>
AuthorDate: Wed Nov 20 21:44:13 2024 +0200

    IGNITE-23718 Improve logging for ScaleCubeMessage (#4759)
---
 .idea/codeStyles/Project.xml                          |  2 --
 .../ignite/internal/network/NetworkMessage.java       |  2 +-
 .../internal/network/message/ScaleCubeMessage.java    | 19 +++++++++++++++++--
 3 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
index 6f8eb3a91e..23dfb427c2 100644
--- a/.idea/codeStyles/Project.xml
+++ b/.idea/codeStyles/Project.xml
@@ -584,9 +584,7 @@
     <codeStyleSettings language="protobuf">
       <option name="RIGHT_MARGIN" value="80" />
       <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
         <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
       </indentOptions>
     </codeStyleSettings>
   </code_scheme>
diff --git 
a/modules/network-api/src/main/java/org/apache/ignite/internal/network/NetworkMessage.java
 
b/modules/network-api/src/main/java/org/apache/ignite/internal/network/NetworkMessage.java
index 2acb9e6297..81ef928d3f 100644
--- 
a/modules/network-api/src/main/java/org/apache/ignite/internal/network/NetworkMessage.java
+++ 
b/modules/network-api/src/main/java/org/apache/ignite/internal/network/NetworkMessage.java
@@ -75,7 +75,7 @@ public interface NetworkMessage extends Cloneable {
     /**
      * 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();
diff --git 
a/modules/network/src/main/java/org/apache/ignite/internal/network/message/ScaleCubeMessage.java
 
b/modules/network/src/main/java/org/apache/ignite/internal/network/message/ScaleCubeMessage.java
index 35fbcef26e..bbcf198b2f 100644
--- 
a/modules/network/src/main/java/org/apache/ignite/internal/network/message/ScaleCubeMessage.java
+++ 
b/modules/network/src/main/java/org/apache/ignite/internal/network/message/ScaleCubeMessage.java
@@ -26,8 +26,10 @@ import 
org.apache.ignite.internal.network.annotations.Transferable;
 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 {
@@ -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 + "]";
+    }
 }