Chronicle Queue Configuration
This chapter describes how Chronicle Queue is configured. Settings are preferably made when instantiating the queue using ChronicleQueue.singleBuilder
. For example, this builder sets the roll cycle to RollCycle.HOURLY
:
String basePath = OS.getTarget() + "/getting-started"
ChronicleQueue queue = ChronicleQueue.singleBuilder(basePath)
.rollCycle(RollCycle.HOURLY)
.build();
}
The table presented below shows the options which can be set using the Chronicle Queue builder. More detailed information about each property can be found by clicking on the field name in each row.
Some features are only available in Chronicle Queue Enterprise. Please availability for Chronicle Queue OSS in column Available in Chronicle Queue OSS. |
Type | Field name | Description | Default | Available in Chronicle Queue OSS |
---|---|---|---|---|
|
The rolling interval, meaning how often messages are appended to a new queue |
|
Yes |
|
|
The offset from the roll cycle in microseconds |
0 |
Yes |
|
|
|
OSS excludes |
||
|
The size of each index array |
The default index count associated with the selected roll cycle |
Yes |
|
|
The space between excerpts that are explicitly indexed |
The default index spacing associated with the selected roll cycle |
Yes |
|
|
The size of a memory mapping chunk. Do not change this unless necessary |
Yes |
||
|
|
Only the default value |
||
|
|
Only the default value |
||
|
Enables double-buffered writes on contention |
|
Yes |
|
|
[ |
The time provider used to evaluate the rolling timings |
|
Yes |
|
[ |
The number of tailers to preallocate when using Ring Buffer. Only set this when using |
1 |
Enterprise only |
|
Sets the Ring Buffer capacity in bytes |
|
Enterprise only |
|
|
Enables the Ring Buffer’s monitoring capability |
|
Enterprise only |
|
|
Enables Ring Buffer’s reader processes to invoke the queue drainer. By default, only only writer processes are allowed to invoke the drainer. |
|
Enterprise only |
|
|
Controls whether to force creating a reader (to recover from crash). |
|
Enterprise only |
|
|
Controls if Ring Buffer readers are reset on close. If true, re-opening a reader puts you back at the same place, and your reader can block writers if the reader is not open |
|
Enterprise only |
|
|
Priority for ring buffer’s drainer handler |
|
Enterprise only |
|
|
10,000 |
Enterprise only |