[Java] Disable recording events by default.

aeron-io · Sep 11, 2022 · 294aea6 · 294aea6
1 parent 9af3e44
commit 294aea6
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 9 deletions.
diff --git a/aeron-archive/src/main/java/io/aeron/archive/Archive.java b/aeron-archive/src/main/java/io/aeron/archive/Archive.java
@@ -973,6 +973,13 @@ public void conclude()
                 throw new ConfigurationException("Archive.Context.replicationChannel must be set");
             }
 
+            if (recordingEventsEnabled() && null == recordingEventsChannel())
+            {
+                throw new ConfigurationException(
+                    "Archive.Context.recordingEventsChannel must be set if " +
+                    "Archive.Context.recordingEventsEnabled is true");
+            }
+
             if (null == archiveDir)
             {
                 archiveDir = new File(archiveDirectoryName);
@@ -1518,7 +1525,7 @@ public Context localControlStreamId(final int controlStreamId)
         }
 
         /**
-         * Get the channel URI on which the recording events publication will publish.
+         * Get the channel URI on which the recording events publication will publish. Will be null if not configured.
          *
          * @return the channel URI on which the recording events publication will publish.
          * @see io.aeron.archive.client.AeronArchive.Configuration#RECORDING_EVENTS_CHANNEL_PROP_NAME

diff --git a/aeron-archive/src/main/java/io/aeron/archive/ArchiveMarkFile.java b/aeron-archive/src/main/java/io/aeron/archive/ArchiveMarkFile.java
@@ -317,7 +317,7 @@ private static int alignedTotalFileLength(final Archive.Context ctx)
             (4 * VarAsciiEncodingEncoder.lengthEncodingLength()) +
             ctx.controlChannel().length() +
             ctx.localControlChannel().length() +
-            ctx.recordingEventsChannel().length() +
+            (null != ctx.recordingEventsChannel() ? ctx.recordingEventsChannel().length() : 0) +
             ctx.aeronDirectoryName().length();
 
         if (headerLength > HEADER_LENGTH)

diff --git a/aeron-archive/src/main/java/io/aeron/archive/client/AeronArchive.java b/aeron-archive/src/main/java/io/aeron/archive/client/AeronArchive.java
@@ -2621,7 +2621,7 @@ public static final class Configuration
         /**
          * Channel enabled for recording progress events of recordings from an archive which defaults to true.
          */
-        public static final boolean RECORDING_EVENTS_ENABLED_DEFAULT = true;
+        public static final boolean RECORDING_EVENTS_ENABLED_DEFAULT = false;
 
         /**
          * Sparse term buffer indicator for control streams.
@@ -2774,15 +2774,13 @@ public static int controlResponseStreamId()
         }
 
         /**
-         * The value {@link #RECORDING_EVENTS_CHANNEL_DEFAULT} or system property
-         * {@link #RECORDING_EVENTS_CHANNEL_PROP_NAME} if set.
+         * The value of system property {@link #RECORDING_EVENTS_CHANNEL_PROP_NAME} if set, null otherwise.
          *
-         * @return {@link #RECORDING_EVENTS_CHANNEL_DEFAULT} or system property
-         * {@link #RECORDING_EVENTS_CHANNEL_PROP_NAME} if set.
+         * @return system property {@link #RECORDING_EVENTS_CHANNEL_PROP_NAME} if set.
          */
         public static String recordingEventsChannel()
         {
-            return System.getProperty(RECORDING_EVENTS_CHANNEL_PROP_NAME, RECORDING_EVENTS_CHANNEL_DEFAULT);
+            return System.getProperty(RECORDING_EVENTS_CHANNEL_PROP_NAME);
         }
 
         /**
@@ -2806,7 +2804,7 @@ public static int recordingEventsStreamId()
         public static boolean recordingEventsEnabled()
         {
             final String propValue = System.getProperty(RECORDING_EVENTS_ENABLED_PROP_NAME);
-            return null != propValue ? "true".equals(propValue) : RECORDING_EVENTS_ENABLED_DEFAULT;
+            return null != propValue ? Boolean.parseBoolean(propValue) : RECORDING_EVENTS_ENABLED_DEFAULT;
         }
     }
 

diff --git a/aeron-system-tests/src/test/java/io/aeron/archive/ArchiveSystemTest.java b/aeron-system-tests/src/test/java/io/aeron/archive/ArchiveSystemTest.java
@@ -135,6 +135,8 @@ private void before(final ThreadingMode threadingMode, final ArchiveThreadingMod
             .archiveDir(new File(SystemUtil.tmpDirName(), "archive-test"))
             .segmentFileLength(segmentFileLength)
             .threadingMode(archiveThreadingMode)
+            .recordingEventsChannel("aeron:udp?control-mode=dynamic|control=localhost:8030")
+            .recordingEventsEnabled(true)
             .idleStrategySupplier(YieldingIdleStrategy::new);
         try
         {