[GitHub] [solr] janhoy commented on a diff in pull request #1315: SOLR-16637: Add syncLevel configuration option to the reference guide

["janhoy (via GitHub)" <gi...@apache.org>]

janhoy commented on code in PR #1315:
URL: https://github.com/apache/solr/pull/1315#discussion_r1093195793


##########
solr/solr-ref-guide/modules/configuration-guide/pages/commits-transaction-logs.adoc:
##########
@@ -279,6 +279,21 @@ The number of buckets used to keep track of maximum version values when checking
 Increase this value to reduce the cost of synchronizing access to version buckets during high-volume indexing.
 This requires `(8 bytes (long) * numVersionBuckets)` of heap space per Solr core.
 
+`syncLevel`::
++
+[%autowidth,frame=none]
+|===
+|Optional |Default: `FLUSH`
+|===
++
+The sync level of the transaction log files. Can be NONE, FLUSH or FSYNC, if nothing is set FLUSH is the default.
+
+These configuration options work in the following way:
+
+* FSYNC: Solr internal FastOutputStream buffer is explicitly flushed to the underlying OutputStream and also this OutputStream buffer is flushed to the tlog file. This is a more expensive operation but safer since the content is written to the tlog file.

Review Comment:
   Thanks for the details here. Initially I thought perhaps that the ref-guide should use plain english and find a more high-level way to talk about this than using class names `FastOutputStream` etc.
   
   Also, I wonder if we instead of "the tlog file" should spell out "the transaction log file" here too, since this is user facing.



-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org