Dump p2p on files instead of hex logs

CHANGELOG.md

@@ -17,5 +17,6 @@ the [releases page](https://github.com/Consensys/teku/releases).
 - Deposit tree snapshots will be loaded from database as a default unless custom snapshot has been provided.
 - Added hidden option `--Xdeposit-contract-logs-syncing-enabled` to allow disabling the syncing of the deposit contract logs from the EL. This is useful when running a non-validating node. It is advisable to be used alongside with `--Xeth1-missing-deposits-event-logging-enabled=false` to avoid unnecessary logging of missing deposits.
 - Updated the bootnodes for Chiado and Gnosis networks
+- Added hidden option `--Xp2p-dumps-to-file-enabled` to enable saving p2p dumps to file.
 
 ### Bug Fixes

eth-reference-tests/src/referenceTest/java/tech/pegasys/teku/reference/phase0/forkchoice/ForkChoiceTestExecutor.java

@@ -15,6 +15,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.mockito.Mockito.mock;
 import static tech.pegasys.teku.infrastructure.async.SafeFutureAssert.safeJoin;
 import static tech.pegasys.teku.infrastructure.time.TimeUtilities.secondsToMillis;
 
@@ -69,6 +70,7 @@
 import tech.pegasys.teku.statetransition.forkchoice.MergeTransitionBlockValidator;
 import tech.pegasys.teku.statetransition.forkchoice.NoopForkChoiceNotifier;
 import tech.pegasys.teku.statetransition.forkchoice.TickProcessor;
+import tech.pegasys.teku.statetransition.util.DebugDataDumper;
 import tech.pegasys.teku.statetransition.validation.BlockBroadcastValidator;
 import tech.pegasys.teku.statetransition.validation.InternalValidationResult;
 import tech.pegasys.teku.storage.client.RecentChainData;
@@ -139,6 +141,7 @@ spec, new SignedBlockAndState(anchorBlock, anchorState)),
             new TickProcessor(spec, recentChainData),
             transitionBlockValidator,
             true,
+            mock(DebugDataDumper.class),
             storageSystem.getMetricsSystem());
     final ExecutionLayerChannelStub executionLayer =
         new ExecutionLayerChannelStub(spec, false, Optional.empty());

ethereum/statetransition/src/main/java/tech/pegasys/teku/statetransition/forkchoice/ForkChoice.java

@@ -74,6 +74,8 @@
 import tech.pegasys.teku.statetransition.attestation.DeferredAttestations;
 import tech.pegasys.teku.statetransition.blobs.BlobSidecarManager;
 import tech.pegasys.teku.statetransition.block.BlockImportPerformance;
+import tech.pegasys.teku.statetransition.util.DebugDataDumper;
+import tech.pegasys.teku.statetransition.util.noop.NoOpDebugDataDumper;
 import tech.pegasys.teku.statetransition.validation.AttestationStateSelector;
 import tech.pegasys.teku.statetransition.validation.BlockBroadcastValidator;
 import tech.pegasys.teku.statetransition.validation.InternalValidationResult;
@@ -108,6 +110,8 @@ public class ForkChoice implements ForkChoiceUpdatedResultSubscriber {
 
   private final LabelledMetric<Counter> getProposerHeadSelectedCounter;
 
+  private final DebugDataDumper debugDataDumper;
+
   public ForkChoice(
       final Spec spec,
       final EventThread forkChoiceExecutor,
@@ -118,6 +122,7 @@ public ForkChoice(
       final TickProcessor tickProcessor,
       final MergeTransitionBlockValidator transitionBlockValidator,
       final boolean forkChoiceLateBlockReorgEnabled,
+      final DebugDataDumper debugDataDumper,
       final MetricsSystem metricsSystem) {
     this.spec = spec;
     this.forkChoiceExecutor = forkChoiceExecutor;
@@ -132,6 +137,7 @@ public ForkChoice(
     this.forkChoiceLateBlockReorgEnabled = forkChoiceLateBlockReorgEnabled;
     this.lastProcessHeadSlot.set(UInt64.ZERO);
     LOG.debug("forkChoiceLateBlockReorgEnabled is set to {}", forkChoiceLateBlockReorgEnabled);
+    this.debugDataDumper = debugDataDumper;
     getProposerHeadSelectedCounter =
         metricsSystem.createLabelledCounter(
             TekuMetricCategory.BEACON,
@@ -161,6 +167,7 @@ public ForkChoice(
         new TickProcessor(spec, recentChainData),
         transitionBlockValidator,
         false,
+        new NoOpDebugDataDumper(),
         metricsSystem);
   }
 
@@ -753,6 +760,12 @@ private void reportInvalidBlock(final SignedBeaconBlock block, final BlockImport
     if (result.getFailureReason() == FailureReason.BLOCK_IS_FROM_FUTURE) {
       return;
     }
+    debugDataDumper.saveInvalidBlockToFile(
+        block.getSlot(),
+        block.getRoot(),
+        block.sszSerialize(),
+        result.getFailureReason().name(),
+        result.getFailureCause());
     P2P_LOG.onInvalidBlock(
         block.getSlot(),
         block.getRoot(),

ethereum/statetransition/src/main/java/tech/pegasys/teku/statetransition/util/DebugDataDumper.java

@@ -0,0 +1,204 @@
+/*
+ * Copyright Consensys Software Inc., 2024
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package tech.pegasys.teku.statetransition.util;
+
+import com.google.common.annotations.VisibleForTesting;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.NoSuchFileException;
+import java.nio.file.Path;
+import java.sql.Date;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.util.Optional;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.apache.tuweni.bytes.Bytes;
+import org.apache.tuweni.bytes.Bytes32;
+import tech.pegasys.teku.infrastructure.time.SystemTimeProvider;
+import tech.pegasys.teku.infrastructure.time.TimeProvider;
+import tech.pegasys.teku.infrastructure.unsigned.UInt64;
+
+public class DebugDataDumper {
+  private static final Logger LOG = LogManager.getLogger();
+
+  private static final String GOSSIP_MESSAGES_DIR = "gossip_messages";
+  private static final String DECODING_ERROR_SUB_DIR = "decoding_error";
+  private static final String REJECTED_SUB_DIR = "rejected";
+  private static final String INVALID_BLOCK_DIR = "invalid_blocks";
+
+  private boolean enabled;
+  private final Path directory;
+
+  public DebugDataDumper(final Path directory, final boolean enabled) {
+    this.enabled = enabled;
+    this.directory = directory;
+    if (!enabled) {
+      return;
+    }
+
+    final Path gossipMessagesPath = this.directory.resolve(GOSSIP_MESSAGES_DIR);
+    createDirectory(gossipMessagesPath, GOSSIP_MESSAGES_DIR, "gossip messages");
+    createDirectory(
+        gossipMessagesPath.resolve(DECODING_ERROR_SUB_DIR),
+        DECODING_ERROR_SUB_DIR,
+        "gossip messages with decoding errors");
+    createDirectory(
+        gossipMessagesPath.resolve(REJECTED_SUB_DIR), REJECTED_SUB_DIR, "rejected gossip messages");
+    createDirectory(this.directory.resolve(INVALID_BLOCK_DIR), INVALID_BLOCK_DIR, "invalid blocks");
+  }
+
+  public void saveGossipMessageDecodingError(
+      final String topic,
+      final Optional<UInt64> arrivalTimestamp,
+      final Bytes originalMessage,
+      final Throwable error) {
+    if (!enabled) {
+      return;
+    }
+    final String formattedTimestamp = formatOptionalTimestamp(arrivalTimestamp);
+    final String fileName = String.format("%s.ssz", formattedTimestamp);
+    final Path topicPath =
+        Path.of(GOSSIP_MESSAGES_DIR)
+            .resolve(DECODING_ERROR_SUB_DIR)
+            .resolve(topic.replaceAll("/", "_"));
+    final boolean success =
+        saveBytesToFile(
+            "gossip message with decoding error", topicPath.resolve(fileName), originalMessage);
+    if (success) {
+      LOG.warn("Failed to decode gossip message on topic {}", topic, error);
+    }
+  }
+
+  public void saveGossipRejectedMessageToFile(
+      final String topic,
+      final Optional<UInt64> arrivalTimestamp,
+      final Bytes decodedMessage,
+      final Optional<String> reason) {
+    if (!enabled) {
+      return;
+    }
+    final String formattedTimestamp = formatOptionalTimestamp(arrivalTimestamp);
+    final String fileName = String.format("%s.ssz", formattedTimestamp);
+    final Path topicPath =
+        Path.of(GOSSIP_MESSAGES_DIR).resolve(REJECTED_SUB_DIR).resolve(topic.replaceAll("/", "_"));
+    final boolean success =
+        saveBytesToFile("rejected gossip message", topicPath.resolve(fileName), decodedMessage);
+    if (success) {
+      LOG.warn(
+          "Rejecting gossip message on topic {}, reason: {}",
+          topic,
+          reason.orElse("failed validation"));
+    }
+  }
+
+  public void saveInvalidBlockToFile(
+      final UInt64 slot,
+      final Bytes32 blockRoot,
+      final Bytes blockSsz,
+      final String failureReason,
+      final Optional<Throwable> failureCause) {
+    if (!enabled) {
+      return;
+    }
+    final String fileName = String.format("%s_%s.ssz", slot, blockRoot.toUnprefixedHexString());
+    final boolean success =
+        saveBytesToFile("invalid block", Path.of(INVALID_BLOCK_DIR).resolve(fileName), blockSsz);
+    if (success) {
+      LOG.warn(
+          "Rejecting invalid block at slot {} with root {} because {}",
+          slot,
+          blockRoot,
+          failureReason,
+          failureCause.orElse(null));
+    }
+  }
+
+  @VisibleForTesting
+  protected boolean saveBytesToFile(
+      final String description, final Path relativeFilePath, final Bytes bytes) {
+    final Path path = directory.resolve(relativeFilePath);
+    try {
+      Files.write(path, bytes.toArray());
+    } catch (NoSuchFileException e) {
+      return saveAfterCreatingTopicDirectory(description, path, relativeFilePath, bytes);
+    } catch (IOException e) {
+      LOG.error("Failed to save {} bytes to file.", description, e);
+      return false;
+    }
+    return true;
+  }
+
+  private boolean saveAfterCreatingTopicDirectory(
+      final String description, final Path path, final Path relativeFilePath, final Bytes bytes) {
+    if (!path.getParent().toFile().mkdirs()) {
+      LOG.error(
+          "Failed to save {} bytes to file. No such directory {} to save file.",
+          description,
+          relativeFilePath.getParent());
+      return false;
+    }
+    try {
+      Files.write(path, bytes.toArray());
+    } catch (IOException e) {
+      LOG.error("Failed to save {} bytes to file.", description, e);
+      if (!path.getParent().toFile().exists()) {
+        this.enabled = false;
+        LOG.error(
+            "{} directory does not exist. Disabling saving debug data to file.",
+            relativeFilePath.getParent());
+      }
+      return false;
+    }
+    return true;
+  }
+
+  private void createDirectory(
+      final Path path, final String directoryName, final String description) {
+    if (!enabled) {
+      return;
+    }
+    if (path.toFile().mkdirs()) {
+      LOG.debug("{} directory has been created to save {}.", directoryName, description);
+    } else {
+      if (!path.toFile().exists()) {
+        this.enabled = false;
+        LOG.error(
+            "Unable to create {} directory to save {}. Disabling saving debug data to file.",
+            directoryName,
+            description);
+      }
+    }
+  }
+
+  private String formatOptionalTimestamp(final Optional<UInt64> maybeTimestamp) {
+    return formatOptionalTimestamp(maybeTimestamp, new SystemTimeProvider());
+  }
+
+  @VisibleForTesting
+  String formatOptionalTimestamp(
+      final Optional<UInt64> maybeTimestamp, final TimeProvider timeProvider) {
+    final DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH_mm_ss.SS");
+    final Date date =
+        maybeTimestamp
+            .map(timestamp -> new Date(timestamp.longValue()))
+            .orElse(new Date(timeProvider.getTimeInMillis().longValue()));
+    return df.format(date);
+  }
+
+  @VisibleForTesting
+  boolean isEnabled() {
+    return enabled;
+  }
+}

ethereum/statetransition/src/main/java/tech/pegasys/teku/statetransition/util/noop/NoOpDebugDataDumper.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright Consensys Software Inc., 2024
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package tech.pegasys.teku.statetransition.util.noop;
+
+import java.nio.file.Path;
+import java.util.Optional;
+import org.apache.tuweni.bytes.Bytes;
+import org.apache.tuweni.bytes.Bytes32;
+import tech.pegasys.teku.infrastructure.unsigned.UInt64;
+import tech.pegasys.teku.statetransition.util.DebugDataDumper;
+
+public class NoOpDebugDataDumper extends DebugDataDumper {
+
+  public NoOpDebugDataDumper() {
+    super(Path.of("."), true);
+  }
+
+  @Override
+  public void saveGossipMessageDecodingError(
+      final String topic,
+      final Optional<UInt64> arrivalTimestamp,
+      final Bytes originalMessage,
+      final Throwable error) {}
+
+  @Override
+  public void saveGossipRejectedMessageToFile(
+      final String topic,
+      final Optional<UInt64> arrivalTimestamp,
+      final Bytes decodedMessage,
+      final Optional<String> reason) {}
+
+  @Override
+  public void saveInvalidBlockToFile(
+      final UInt64 slot,
+      final Bytes32 blockRoot,
+      final Bytes blockSsz,
+      final String failureReason,
+      final Optional<Throwable> failureCause) {}
+}