Mmuzaf commented on a change in pull request #8207:
URL: https://github.com/apache/ignite/pull/8207#discussion_r485565146
##########
File path:
modules/core/src/main/java/org/apache/ignite/IgniteSystemProperties.java
##########
@@ -816,132 +1188,184 @@
*
* Default value is {@code false}.
*/
+ @SystemProperty("If the property is set
org.apache.ignite.internal.pagemem.wal.record.TxRecord records " +
+ "will be logged to WAL")
public static final String IGNITE_WAL_LOG_TX_RECORDS =
"IGNITE_WAL_LOG_TX_RECORDS";
/** Max amount of remembered errors for {@link GridLogThrottle}. */
+ @SystemProperty(value = "Max amount of remembered errors for
GridLogThrottle", type = Integer.class,
+ defaults = "" + DFLT_LOG_THROTTLE_CAPACITY)
public static final String IGNITE_LOG_THROTTLE_CAPACITY =
"IGNITE_LOG_THROTTLE_CAPACITY";
/**
* If this property is set, {@link
DataStorageConfiguration#setWriteThrottlingEnabled(boolean)}
* will be overridden to {@code true} regardless the initial value in the
configuration.
*/
+ @SystemProperty(value = "Checkpoint throttling policy", type =
String.class)
public static final String IGNITE_OVERRIDE_WRITE_THROTTLING_ENABLED =
"IGNITE_OVERRIDE_WRITE_THROTTLING_ENABLED";
/**
* Property for setup WAL serializer version.
*/
+ @SystemProperty(value = "WAL serializer version", type = Integer.class,
+ defaults = "" + LATEST_SERIALIZER_VERSION)
public static final String IGNITE_WAL_SERIALIZER_VERSION =
"IGNITE_WAL_SERIALIZER_VERSION";
/** Property for setup Ignite WAL segment sync timeout. */
+ @SystemProperty(value = "WAL segment sync timeout in milliseconds", type =
Long.class,
+ defaults = "" + DFLT_WAL_SEGMENT_SYNC_TIMEOUT)
public static final String IGNITE_WAL_SEGMENT_SYNC_TIMEOUT =
"IGNITE_WAL_SEGMENT_SYNC_TIMEOUT";
/**
* If the property is set Ignite will use legacy node comparator (based on
node order) inste
*
* Default value is {@code false}.
*/
+ @SystemProperty("Enables usage of legacy node comparator (based on node
order)")
public static final String IGNITE_USE_LEGACY_NODE_COMPARATOR =
"IGNITE_USE_LEGACY_NODE_COMPARATOR";
/**
* Property that indicates should be mapped byte buffer used or not.
* Possible values: {@code true} and {@code false}.
*/
+ @SystemProperty(value = "Enables usage of the mapped byte buffer",
defaults = "" + DFLT_WAL_MMAP)
public static final String IGNITE_WAL_MMAP = "IGNITE_WAL_MMAP";
/**
* When set to {@code true}, Data store folders are generated only by
consistent id, and no consistent ID will be
* set based on existing data store folders. This option also enables
compatible folder generation mode as it was
* before 2.3.
*/
+ @SystemProperty("When set to true, Data store folders are generated only
by consistent id, " +
+ "and no consistent ID will be set based on existing data store
folders. This option also enables compatible " +
+ "folder generation mode as it was before 2.3")
public static final String IGNITE_DATA_STORAGE_FOLDER_BY_CONSISTENT_ID =
"IGNITE_DATA_STORAGE_FOLDER_BY_CONSISTENT_ID";
/** Ignite JVM pause detector disabled. */
+ @SystemProperty("Disables JVM pause detector")
public static final String IGNITE_JVM_PAUSE_DETECTOR_DISABLED =
"IGNITE_JVM_PAUSE_DETECTOR_DISABLED";
/** Ignite JVM pause detector precision. */
+ @SystemProperty(value = "JVM pause detector precision", type =
Integer.class,
+ defaults = "" + DFLT_JVM_PAUSE_DETECTOR_PRECISION)
public static final String IGNITE_JVM_PAUSE_DETECTOR_PRECISION =
"IGNITE_JVM_PAUSE_DETECTOR_PRECISION";
/** Ignite JVM pause detector threshold. */
+ @SystemProperty(value = "JVM pause detector threshold", type =
Integer.class,
+ defaults = "" + DEFAULT_JVM_PAUSE_DETECTOR_THRESHOLD)
public static final String IGNITE_JVM_PAUSE_DETECTOR_THRESHOLD =
"IGNITE_JVM_PAUSE_DETECTOR_THRESHOLD";
/** Ignite JVM pause detector last events count. */
+ @SystemProperty(value = "JVM pause detector last events count", type =
Integer.class,
+ defaults = "" + DFLT_JVM_PAUSE_DETECTOR_LAST_EVENTS_COUNT)
public static final String IGNITE_JVM_PAUSE_DETECTOR_LAST_EVENTS_COUNT =
"IGNITE_JVM_PAUSE_DETECTOR_LAST_EVENTS_COUNT";
/**
* Default value is {@code false}.
+ *
+ * @deprecated Not used.
*/
+ @Deprecated
+ @SystemProperty("Enables WAL debug log on recovery")
public static final String IGNITE_WAL_DEBUG_LOG_ON_RECOVERY =
"IGNITE_WAL_DEBUG_LOG_ON_RECOVERY";
/**
* Number of checkpoint history entries held in memory.
*/
+ @SystemProperty(value = "Number of checkpoint history entries held in
memory", type = Integer.class,
+ defaults = "" + DFLT_PDS_MAX_CHECKPOINT_MEMORY_HISTORY_SIZE)
public static final String IGNITE_PDS_MAX_CHECKPOINT_MEMORY_HISTORY_SIZE =
"IGNITE_PDS_MAX_CHECKPOINT_MEMORY_HISTORY_SIZE";
/**
* If this property is set to {@code true} enable logging in {@link
GridClient}.
*/
+ @SystemProperty("Enables logging in GridClient")
public static final String IGNITE_GRID_CLIENT_LOG_ENABLED =
"IGNITE_GRID_CLIENT_LOG_ENABLED";
/**
* When set to {@code true}, direct IO may be enabled. Direct IO enabled
only if JAR file with corresponding
* feature is available in classpath and OS and filesystem settings allows
to enable this mode.
* Default is {@code true}.
*/
+ @SystemProperty(value = "Enables direct IO. Direct IO enabled only if JAR
" +
+ "file with corresponding feature is available in classpath and OS and
filesystem settings allows to enable " +
+ "this mode", defaults = "true")
public static final String IGNITE_DIRECT_IO_ENABLED =
"IGNITE_DIRECT_IO_ENABLED";
/**
* When set to {@code true}, warnings that are intended for development
environments and not for production
* (such as coding mistakes in code using Ignite) will not be logged.
*/
+ @SystemProperty("Enables development environments warnings")
public static final String IGNITE_DEV_ONLY_LOGGING_DISABLED =
"IGNITE_DEV_ONLY_LOGGING_DISABLED";
/**
* When set to {@code true} (default), pages are written to page store
without holding segment lock (with delay).
* Because other thread may require exactly the same page to be loaded
from store, reads are protected by locking.
*/
+ @SystemProperty(value = "When set to true (default), pages are written to
page store without " +
+ "holding segment lock (with delay). Because other thread may require
exactly the same page to be loaded " +
+ "from store, reads are protected by locking", defaults = "" +
DFLT_DELAYED_REPLACED_PAGE_WRITE)
public static final String IGNITE_DELAYED_REPLACED_PAGE_WRITE =
"IGNITE_DELAYED_REPLACED_PAGE_WRITE";
/**
* When set to {@code true}, WAL implementation with dedicated worker will
be used even in FSYNC mode.
* Default is {@code false}.
*/
+ @SystemProperty("When set to true, WAL implementation with dedicated
worker will be used " +
+ "even in FSYNC mode")
public static final String IGNITE_WAL_FSYNC_WITH_DEDICATED_WORKER =
"IGNITE_WAL_FSYNC_WITH_DEDICATED_WORKER";
Review comment:
The default value is `false`. Should we mention it?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]