Document the overhead of MultiprocessRollingFileAppender

apache · Dec 17, 2024 · 31ed086 · 31ed086
1 parent 7c9d17a
commit 31ed086
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/main/include/log4cxx/rolling/multiprocessrollingfileappender.h b/src/main/include/log4cxx/rolling/multiprocessrollingfileappender.h
@@ -29,7 +29,11 @@ namespace rolling
 
 
 /**
- * A special version of the RollingFileAppender that acts properly with multiple processes
+ * A special version of the RollingFileAppender that acts properly with multiple processes.
+ *
+ * Coordinating with other processes adds significant overhead compared to RollingFileAppender.
+ * Benchmarks show the overhead of this appender is more than 4 and 10 times
+ * the overhead of RollingFileAppender on Linux and Windows respectively.
  *
  * Note: Do *not* set the option <code>Append</code> to <code>false</code>.
  * Rolling over files is only relevant when you are appending.