This repository has been archived by the owner on Oct 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 123
/
Copy pathcassandra.ini
2051 lines (1756 loc) · 74.8 KB
/
cassandra.ini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
[]
mountpoint = cassandra-spec.ecf
infos/plugins = dump
;Until the max plugin error is not fixed, some specifications will be left commented out
[cluster_name]
;type = string
check/type = string
default = "Test Cluster"
description = "
The name of the cluster. This is mainly used to prevent machines in
one logical cluster from joining another."
[num_tokens]
;type = unsigned_long
check/type = unsigned_long
default = 1
description = "
This defines the number of tokens randomly assigned to this node on the ring.
The more tokens relative to other nodes, the larger the proportion of data
that this node will store. You probably want all nodes to have the same number
of tokens assuming they have equal hardware capabilities.
Specifying initial_token will override this setting on the node's initial start,
on subsequent starts, this setting will apply even if initial token is set.
If you already have a cluster with 1 token per node and wish to migrate to
multiple tokens per node, see http://wiki.apache.org/cassandra/Operations
"
[allocate_tokens_for_keyspace]
;type = string
check/type = string
default = "KEYSPACE"
description = "
Triggers automatic allocation of num_tokens tokens for this node. The allocation
algorithm attempts to choose tokens in a way that optimizes replicated load over
the nodes in the datacenter for the replication strategy used by the specified
keyspace.
The load assigned to each node will be close to proportional to its number of
vnodes.
Only supported with the Murmur3Partitioner."
[initial_token]
;type = string
check/type = string
default = ""
description = "
initial_token allows you to specify tokens manually. While you can use it with
vnodes (num_tokens > 1, above) -- in which case you should provide a
comma-separated list -- it's primarily used when adding nodes to legacy clusters
that do not have vnodes enabled."
[hinted_handoff_enabled]
;type = boolean
check/type = boolean
default = true
description = "
See http://wiki.apache.org/cassandra/HintedHandoff
May either be 'true' or 'false' to enable globally"
[hinted_handoff_disabled_datacenters/_]
;type = string
check/type = string
default = ""
description = "
When hinted_handoff_enabled is true, a black list of data centers that will not
perform hinted handoff."
[max_hint_window_in_ms]
;type = unsigned_long
check/type = unsigned_long
default = 10800000
description = "
This defines the maximum amount of time a dead host will have hints
generated. After that amount of time, no new hints will be created
until the host is alive and goes down again."
[hinted_handoff_throttle_in_kb]
;type = unsigned_long
check/type = unsigned_long
default = 1024
description = "
Maximum throttle in KBs per second per delivery thread. This will be
reduced proportionally to the number of nodes in the cluster. (If there
are two nodes in the cluster, each delivery thread will use the maximum
rate; if there are three, each will throttle to half of the maximum,
since we expect two nodes to be delivering hints simultaneously.)"
[max_hints_delivery_threads]
;type = unsigned_long
check/type = unsigned_long
default = 2
description = "
Number of threads with which to deliver hints;
Consider increasing this number when you have multi-dc deployments, since
cross-dc handoff tends to be slower"
[hints_directory]
;type = string
check/type = string
;check/path =
default = "$CASSANDRA_HOME/data/hints"
description = "
Directory where Cassandra should store hints."
[hints_flush_period_in_ms]
;type = unsigned_long
check/type = unsigned_long
default = 10000
description = "
How often hints should be flushed from the internal buffers to disk.
Will *not* trigger fsync."
[max_hints_file_size_in_mb]
;type = unsigned_long
check/type = unsigned_long
default = 128
description = "
Maximum size for a single hints file, in megabytes."
[hints_compression/_/class_name]
;type = string
check/enum = #2
check/enum/#0 = LZ4Compressor
check/enum/#1 = SnappyCompressor
check/enum/#2 = Deflate
default = LZ4Compressor
description = "
Compression to apply to the hint files. If omitted, hints files
will be written uncompressed. LZ4, Snappy, and Deflate compressors
are supported."
[batchlog_replay_throttle_in_kb]
;type = unsigned_long
check/type = unsigned_long
default = 1024
description = "
Maximum throttle in KBs per second, total. This will be
reduced proportionally to the number of nodes in the cluster."
[authenticator]
;type = string
check/enum = #1
check/enum/#0 = AllowAllAuthenticator
check/enum/#1 = PasswordAuthenticator
default = "AllowAllAuthenticator"
description = "Authentication backend, implementing IAuthenticator; used to identify users
Out of the box, Cassandra provides org.apache.cassandra.auth.{AllowAllAuthenticator,
PasswordAuthenticator}.
- AllowAllAuthenticator performs no checks - set it to disable authentication.
- PasswordAuthenticator relies on username/password pairs to authenticate
users. It keeps usernames and hashed passwords in system_auth.roles table.
Please increase system_auth keyspace replication factor if you use this authenticator.
If using PasswordAuthenticator, CassandraRoleManager must also be used (see below)"
[authorizer]
;type = string
check/enum = #1
check/enum/#0 = AllowAllAuthenticator
check/enum/#1 = CassandraAuthorizer
default = "AllowAllAuthenticator"
description = "# Authorization backend, implementing IAuthorizer; used to limit access/provide permissions
Out of the box, Cassandra provides org.apache.cassandra.auth.{AllowAllAuthorizer,
CassandraAuthorizer}.
- AllowAllAuthorizer allows any action to any user - set it to disable authorization.
- CassandraAuthorizer stores permissions in system_auth.role_permissions table. Please
increase system_auth keyspace replication factor if you use this authorizer."
[role_manager]
;type = string
check/type = string
default = "CassandraRoleManager"
description = "# Part of the Authentication & Authorization backend, implementing IRoleManager; used
to maintain grants and memberships between roles.
Out of the box, Cassandra provides org.apache.cassandra.auth.CassandraRoleManager,
which stores role information in the system_auth keyspace. Most functions of the
IRoleManager require an authenticated login, so unless the configured IAuthenticator
actually implements authentication, most of this functionality will be unavailable.
- CassandraRoleManager stores role data in the system_auth keyspace. Please
increase system_auth keyspace replication factor if you use this role manager."
[roles_validity_in_ms]
;type = unsigned_long
check/type = unsigned_long
default = 2000
description = "
Validity period for roles cache (fetching granted roles can be an expensive
operation depending on the role manager, CassandraRoleManager is one example)
Granted roles are cached for authenticated sessions in AuthenticatedUser and
after the period specified here, become eligible for (async) reload.
Will be disabled automatically for AllowAllAuthenticator."
[roles_update_interval_in_ms]
;type = unsigned_long
check/type = unsigned_long
default = 2000
description = "
Refresh interval for roles cache (if enabled).
After this interval, cache entries become eligible for refresh. Upon next
access, an async reload is scheduled and the old value returned until it
completes. If roles_validity_in_ms is non-zero, then this must be
also."
[permissions_validity_in_ms]
;type = unsigned_long
check/type = unsigned_long
default = 2000
description = "
Validity period for permissions cache (fetching permissions can be an
expensive operation depending on the authorizer, CassandraAuthorizer is
one example).
Will be disabled automatically for AllowAllAuthorizer."
[permissions_update_interval_in_ms]
;type = unsigned_long
check/type = unsigned_long
default = 2000
description = "
Refresh interval for permissions cache (if enabled).
After this interval, cache entries become eligible for refresh. Upon next
access, an async reload is scheduled and the old value returned until it
completes. If permissions_validity_in_ms is non-zero, then this must be
also."
[credentials_validity_in_ms]
;type = unsigned_long
check/type = unsigned_long
default = 2000
description = "
Validity period for credentials cache. This cache is tightly coupled to
the provided PasswordAuthenticator implementation of IAuthenticator. If
another IAuthenticator implementation is configured, this cache will not
be automatically used and so the following settings will have no effect.
Please note, credentials are cached in their encrypted form, so while
activating this cache may reduce the number of queries made to the
underlying table, it may not bring a significant reduction in the
latency of individual authentication attempts."
[credentials_update_interval_in_ms]
;type = unsigned_long
check/type = unsigned_long
default = 2000
description = "
Refresh interval for credentials cache (if enabled).
After this interval, cache entries become eligible for refresh. Upon next
access, an async reload is scheduled and the old value returned until it
completes. If credentials_validity_in_ms is non-zero, then this must be
also."
[partitioner]
;type = string
check/enum = #3
check/enum/#0 = org.apache.cassandra.dht.Murmur3Partitioner
check/enum/#1 = org.apache.cassandra.dht.RandomPartitioner
check/enum/#2 = org.apache.cassandra.dht.ByteOrderedPartitioner
check/enum/#3 = org.apache.cassandra.dht.OrderPreservingPartitioner
default = "org.apache.cassandra.dht.Murmur3Partitioner"
description = "
The partitioner is responsible for distributing groups of rows (by
partition key) across nodes in the cluster. You should leave this
alone for new clusters. The partitioner can NOT be changed without
reloading all data, so when upgrading you should set this to the
same partitioner you were already using.
Besides Murmur3Partitioner, partitioners included for backwards
compatibility include RandomPartitioner, ByteOrderedPartitioner, and
OrderPreservingPartitioner."
[data_file_directories/_]
;type = string
check/type = string
default = "$CASSANDRA_HOME/data/data"
;check/path = ;Cannot perform pathcheck as $CASSANDRA_HOME is relative
description = "
Directories where Cassandra should store data on disk. Cassandra
will spread data evenly across them, subject to the granularity of
the configured compaction strategy."
[commitlog_directory]
;type = string
check/type = string
;check/path = ;Cannot perform pathcheck as $CASSANDRA_HOME is relative
default = "$CASSANDRA_HOME/data/commitlog"
description = "
commit log. when running on magnetic HDD, this should be a
separate spindle than the data directories."
[cdc_enabled]
;type = boolean
check/type = boolean
default = false
description = "
Enable / disable CDC functionality on a per-node basis. This modifies the logic used
for write path allocation rejection (standard: never reject. cdc: reject Mutation
containing a CDC-enabled table if at space limit in cdc_raw_directory)."
[cdc_raw_directory]
;check/path = ;Cannot perform pathcheck as $CASSANDRA_HOME is relative
;type = string
check/type = string
default = "$CASSANDRA_HOME/data/cdc_raw"
description = "
CommitLogSegments are moved to this directory on flush if cdc_enabled: true and the
segment contains mutations for a CDC-enabled table. This should be placed on a
separate spindle than the data directories."
[disk_failure_policy]
;type = string
check/enum = #4
check/enum/#0 = die
check/enum/#1 = stop_paranoid
check/enum/#2 = stop
check/enum/#3 = best_effort
check/enum/#4 = ignore
default = "stop"
description = "
Policy for data disk failures:
die
shut down gossip and client transports and kill the JVM for any fs errors or
single-sstable errors, so the node can be replaced.
stop_paranoid
shut down gossip and client transports even for single-sstable errors,
kill the JVM for errors during startup.
stop
shut down gossip and client transports, leaving the node effectively dead, but
can still be inspected via JMX, kill the JVM for errors during startup.
best_effort
stop using the failed disk and respond to requests based on
remaining available sstables. This means you WILL see obsolete
data at CL.ONE!
ignore
ignore fatal errors and let requests fail, as in pre-1.2 Cassandra"
[commit_failure_policy]
;type = string
check/enum = #3
check/enum/#0 = die
check/enum/#1 = stop
check/enum/#2 = stop_commit
check/enum/#3 = ignore
default = "stop"
description = "
Policy for commit disk failures:
die
shut down gossip and Thrift and kill the JVM, so the node can be replaced.
stop
shut down gossip and Thrift, leaving the node effectively dead, but
can still be inspected via JMX.
stop_commit
shutdown the commit log, letting writes collect but
continuing to service reads, as in pre-2.0.5 Cassandra
ignore
ignore fatal errors and let the batches fail"
[prepared_statements_cache_size_mb]
;type = string
check/type = string
;check/validation = ^(|0|[1-9]\d*)$
;check/validation/match = LINE
;check/validation/message = "Valid values are either 'auto' (omitting the value) or a value greater 0"
default =
description = "
Maximum size of the native protocol prepared statement cache
Valid values are either 'auto' (omitting the value) or a value greater 0.
Note that specifying a too large value will result in long running GCs and possbily
out-of-memory errors. Keep the value at a small fraction of the heap.
If you constantly see 'prepared statements discarded in the last minute because
cache limit reached' messages, the first step is to investigate the root cause
of these messages and check whether prepared statements are used correctly -
i.e. use bind markers for variable parts.
Do only change the default value, if you really have more prepared statements than
fit in the cache. In most cases it is not neccessary to change this value.
Constantly re-preparing statements is a performance penalty.
Default value ('auto') is 1/256th of the heap or 10MB, whichever is greater"
[thrift_prepared_statements_cache_size_mb]
;type = string
check/type = string
;check/validation = ^(|0|[1-9]\d*)$
;check/validation/match = LINE
;check/validation/message = "Valid values are either 'auto' (omitting the value) or a value greater 0"
default =
description = "
Maximum size of the Thrift prepared statement cache
If you do not use Thrift at all, it is safe to leave this value at 'auto'.
See description of 'prepared_statements_cache_size_mb' above for more information.
Default value ('auto') is 1/256th of the heap or 10MB, whichever is greater
"
[key_cache_size_in_mb]
;type = string
check/type = string
;check/validation = ^(|0|[1-9]\d*)$
;check/validation/match = LINE
;check/validation/message = "Valid values are either 'auto' (omitting the value) or a positive number. Set to 0 to disable key cache"
default =
description = "
Maximum size of the Thrift prepared statement cache
If you do not use Thrift at all, it is safe to leave this value at 'auto'.
See description of 'prepared_statements_cache_size_mb' above for more information.
Default value ('auto') is 1/256th of the heap or 10MB, whichever is greater
"
[key_cache_save_period]
;type = unsigned_long
check/type = unsigned_long
default = 14400
description = "
Duration in seconds after which Cassandra should
save the key cache. Caches are saved to saved_caches_directory as
specified in this configuration file.
Saved caches greatly improve cold-start speeds, and is relatively cheap in
terms of I/O for the key cache. Row cache saving is much more expensive and
has limited use."
[key_cache_keys_to_save]
;type = unsigned_long
check/type = unsigned_long
default =
description = "
Number of keys from the key cache to save"
[row_cache_class_name]
;type = string
check/enum = #1
check/enum/#0 = org.apache.cassandra.cache.OHCProvider
check/enum/#1 = org.apache.cassandra.cache.SerializingCacheProvider
default = "org.apache.cassandra.cache.OHCProvider"
description = "
Row cache implementation class name. Available implementations:
org.apache.cassandra.cache.OHCProvider
Fully off-heap row cache implementation.
org.apache.cassandra.cache.SerializingCacheProvider
This is the row cache implementation availabile
in previous releases of Cassandra."
[row_cache_size_in_mb]
;type = unsigned_long
check/type = unsigned_long
default = 0
description = "
Maximum size of the row cache in memory.
Please note that OHC cache implementation requires some additional off-heap memory to manage
the map structures and some in-flight memory during operations before/after cache entries can be
accounted against the cache capacity. This overhead is usually small compared to the whole capacity.
Do not specify more memory that the system can afford in the worst usual situation and leave some
headroom for OS block level cache. Do never allow your system to swap."
[row_cache_save_period]
;type = unsigned_long
check/type = unsigned_long
default = 0
description = "
Number of keys from the row cache to save.
Specify 0, meaning all keys are going to be saved"
[row_cache_keys_to_save]
;type = unsigned_long
check/type = unsigned_long
default = 0
description = "
Number of keys from the row cache to save.
Specify 0, meaning all keys are going to be saved"
[counter_cache_size_in_mb]
;type = string
check/type = string
;check/validation = ^(|0|[1-9]\d*)$
;check/validation/match = LINE
;check/validation/message = "Valid values are either 'auto' (omitting the value) or a positive number. Set to 0 to disable key cache"
default =
description = "
Maximum size of the counter cache in memory.
Counter cache helps to reduce counter locks' contention for hot counter cells.
In case of RF = 1 a counter cache hit will cause Cassandra to skip the read before
write entirely. With RF > 1 a counter cache hit will still help to reduce the duration
of the lock hold, helping with hot counter cell updates, but will not allow skipping
the read entirely. Only the local (clock, count) tuple of a counter cell is kept
in memory, not the whole counter, so it's relatively cheap.
NOTE: if you reduce the size, you may not get you hottest keys loaded on startup.
Empty makes it 'auto' (min(2.5% of Heap (in MB), 50MB)). Set to 0 to disable counter cache.
NOTE: if you perform counter deletes and rely on low gcgs, you should disable the counter cache.
"
[counter_cache_save_period]
;type = unsigned_long
check/type = unsigned_long
default = 7200
description = "
Duration in seconds after which Cassandra should
save the counter cache (keys only). Caches are saved to saved_caches_directory as
specified in this configuration file."
[counter_cache_keys_to_save]
;type = unsigned_long
check/type = any
default =
description = "
Number of keys from the counter cache to save
Disabled by default, meaning all keys are going to be saved"
[saved_caches_directory]
;type = string
check/type = string
;check/path = ;Cannot perform pathcheck as $CASSANDRA_HOME is relative
default = "$CASSANDRA_HOME/data/saved_caches"
description = "Saved caches directory"
[commitlog_sync]
;type = string
check/enum = #1
check/enum/#0 = periodic
check/enum/#1 = batch
default = periodic
description = "
commitlog_sync may be either 'periodic' or 'batch.''
When in batch mode, Cassandra won't ack writes until the commit log
has been fsynced to disk. It will wait
commitlog_sync_batch_window_in_ms milliseconds between fsyncs.
This window should be kept short because the writer threads will
be unable to do extra work while waiting. (You may need to increase
concurrent_writes for the same reason.)
the other option is 'periodic' where writes may be acked immediately
and the CommitLog is simply synced every commitlog_sync_period_in_ms
milliseconds."
[commitlog_sync_period_in_ms]
;type = unsigned_long
check/type = unsigned_long
default = 10000
description = "Same as commitlog_sync"
[commitlog_segment_size_in_mb]
;type = unsigned_long
check/type = unsigned_long
default = 32
description = "
The size of the individual commitlog file segments. A commitlog
segment may be archived, deleted, or recycled once all the data
in it (potentially from each columnfamily in the system) has been
flushed to sstables.
32 is almost always fine, but if you are
archiving commitlog segments (see commitlog_archiving.properties),
then you probably want a finer granularity of archiving; 8 or 16 MB
is reasonable.
Max mutation size is also configurable via max_mutation_size_in_kb setting in
cassandra.yaml.
NOTE: If max_mutation_size_in_kb is set explicitly then commitlog_segment_size_in_mb must
be set to at least twice the size of max_mutation_size_in_kb / 1024"
[commitlog_compression/#0/class_name]
;type = string
check/enum = #2
check/enum/#0 = LZ4Compressor
check/enum/#1 = SnappyCompressor
check/enum/#2 = Deflate
default = LZ4Compressor
description = "
Compression to apply to the commit files. If omitted, commit files
will be written uncompressed. LZ4, Snappy, and Deflate compressors
are supported."
[seed_provider/#0/class_name]
;type = string
check/enum = #2
check/enum/#0 = LZ4Compressor
check/enum/#1 = SnappyCompressor
check/enum/#2 = Deflate
default = LZ4Compressor
description = "
any class that implements the SeedProvider interface and has a
constructor that takes a Map<String, String> of parameters will do."
[seed_provider/#0/parameters]
description = "Addresses of hosts that are deemed contact points.
Cassandra nodes use this list of hosts to find each other and learn
the topology of the ring. You must change this if you are running
multiple nodes!"
[seed_provider/#0/parameters/#0/seeds]
;type = string
check/type = string
check/ipaddr =
default = "127.0.0.1"
description = "
any class that implements the SeedProvider interface and has a
constructor that takes a Map<String, String> of parameters will do."
[concurrent_reads]
;type = unsigned_long
check/type = unsigned_long
default = 32
description = "
For workloads with more data than can fit in memory, Cassandra's
bottleneck will be reads that need to fetch data from
disk. 'concurrent_reads' should be set to (16 * number_of_drives) in
order to allow the operations to enqueue low enough in the stack
that the OS and drives can reorder them. Same applies to
'concurrent_counter_writes', since counter writes read the current
values before incrementing and writing them back.
On the other hand, since writes are almost never IO bound, the ideal
number of 'concurrent_writes' is dependent on the number of cores in
your system; (8 * number_of_cores) is a good rule of thumb."
[concurrent_writes]
;type = unsigned_long
check/type = unsigned_long
default = 32
description = "Please refer to the description of concurrent_reads"
[concurrent_counter_writes]
;type = unsigned_long
check/type = unsigned_long
default = 32
description = "Please refer to the description of concurrent_reads"
[concurrent_materialized_view_writes]
;type = unsigned_long
check/type = unsigned_long
default = 32
description = "
For materialized view writes, as there is a read involved, so this should
be limited by the less of concurrent reads or concurrent writes."
[file_cache_size_in_mb]
;type = unsigned_long
check/type = unsigned_long
default =
description = "
Maximum memory to use for sstable chunk cache and buffer pooling.
32MB of this are reserved for pooling buffers, the rest is used as an
cache that holds uncompressed sstable chunks.
Defaults to the smaller of 1/4 of heap or 512MB. This pool is allocated off-heap,
so is in addition to the memory allocated for heap. The cache also has on-heap
overhead which is roughly 128 bytes per chunk (i.e. 0.2% of the reserved size
if the default 64k chunk size is used).
Memory is only allocated when needed."
[buffer_pool_use_heap_if_exhausted]
;type = boolean
check/type = boolean
default = false
description = "
Flag indicating whether to allocate on or off heap when the sstable buffer
pool is exhausted, that is when it has exceeded the maximum memory
file_cache_size_in_mb, beyond which it will not cache buffers but allocate on request.
"
[disk_optimization_strategy]
;type = string
check/enum = #1
check/enum/#0 = ssd
check/enum/#1 = spinning
default = ssd
description = "
The strategy for optimizing disk read
Possible values are:
ssd (for solid state disks)
spinning (for spinning disks)"
[memtable_heap_space_in_mb]
;type = unsigned_long
check/type = unsigned_long
default =
description = "
Total permitted memory to use for memtables. Cassandra will stop
accepting writes when the limit is exceeded until a flush completes,
and will trigger a flush based on memtable_cleanup_threshold
If omitted, Cassandra will it to 1/4 the size of the heap."
[memtable_offheap_space_in_mb]
;type = unsigned_long
check/type = unsigned_long
default =
description = "
Total permitted memory to use for memtables. Cassandra will stop
accepting writes when the limit is exceeded until a flush completes,
and will trigger a flush based on memtable_cleanup_threshold
If omitted, Cassandra will set it to 1/4 the size of the heap."
[memtable_cleanup_threshold]
;type = float
check/type = float
default =
description = "
memtable_cleanup_threshold is deprecated. See the comments on memtable_flush_writers
for more information.
Ratio of occupied non-flushing memtable size to total permitted size
that will trigger a flush of the largest memtable. Larger mct will
mean larger flushes and hence less compaction, but also less concurrent
flush activity which can make it difficult to keep your disks fed
under heavy write load."
[memtable_allocation_type]
;type = string
check/enum = #2
check/enum/#0 = heap_buffers
check/enum/#1 = offheap_buffers
check/enum/#2 = offheap_objects
default =
description = "
Specify the way Cassandra allocates and manages memtable memory.
Options are:
heap_buffers
on heap nio buffers
offheap_buffers
off heap (direct) nio buffers
offheap_objects
off heap objects"
[commitlog_total_space_in_mb]
;type = unsigned_long
check/type = unsigned_long
default =
description = "
Total space to use for commit logs on disk.
If space gets above this value, Cassandra will flush every dirty CF
in the oldest segment and remove it. So a small total commitlog space
will tend to cause more flush activity on less-active columnfamilies."
[memtable_flush_writers]
;type = unsigned_long
check/type = unsigned_long
default = 2
description = "
This sets the number of memtable flush writer threads per disk
as well as the total number of memtables that can be flushed concurrently.
These are generally a combination of compute and IO bound.
Memtable flushing is more CPU efficient than memtable ingest and a single thread
can keep up with the ingest rate of a whole server on a single fast disk
until it temporarily becomes IO bound under contention typically with compaction.
At that point you need multiple flush threads. At some point in the future
it may become CPU bound all the time.
You can tell if flushing is falling behind using the MemtablePool.BlockedOnAllocation
metric which should be 0, but will be non-zero if threads are blocked waiting on flushing
to free memory.
This means that two memtables can be flushed concurrently to the single data directory.
If you have multiple data directories the default is one memtable flushing at a time
but the flush will use a thread per data directory so you will get two or more writers.
Two is generally enough to flush on a fast disk [array] mounted as a single data directory.
Adding more flush writers will result in smaller more frequent flushes that introduce more
compaction overhead.
There is a direct tradeoff between number of memtables that can be flushed concurrently
and flush size and frequency. More is not better you just need enough flush writers
to never stall waiting for flushing to free memory."
[cdc_total_space_in_mb]
;type = unsigned_long
check/type = unsigned_long
default =
description = "
Total space to use for change-data-capture logs on disk.
If space gets above this value, Cassandra will throw WriteTimeoutException
on Mutations including tables with CDC enabled. A CDCCompactor is responsible
for parsing the raw CDC logs and deleting them when parsing is completed."
[cdc_free_space_check_interval_ms]
;type = unsigned_long
check/type = unsigned_long
default = 250
description = "
When we hit our cdc_raw limit and the CDCCompactor is either running behind
or experiencing backpressure, we check at the following interval to see if any
new space for cdc-tracked tables has been made available."
[index_summary_capacity_in_mb]
;type = unsigned_long
check/type = unsigned_long
default =
description = "
A fixed memory pool size in MB for for SSTable index summaries. If the memory usage of
all index summaries exceeds this limit, SSTables with low read rates will
shrink their index summaries in order to meet this limit. However, this
is a best-effort process. In extreme conditions Cassandra may need to use
more than this amount of memory."
[index_summary_resize_interval_in_minutes]
;type = long
check/type = long
default = 60
description = "
How frequently index summaries should be resampled. This is done
periodically to redistribute memory from the fixed-size pool to sstables
proportional their recent read rates. Setting to -1 will disable this
process, leaving existing index summaries at their current sampling level."
[trickle_fsync]
;type = boolean
check/type = boolean
default = false
description = "
Whether to, when doing sequential writing, fsync() at intervals in
order to force the operating system to flush the dirty
buffers. Enable this to avoid sudden dirty buffer flushing from
impacting read latencies. Almost always a good idea on SSDs; not
necessarily on platters."
[trickle_fsync_interval_in_kb]
;type = unsigned_long
check/type = unsigned_long
default = 10240
description = "
Whether to, when doing sequential writing, fsync() at intervals in
order to force the operating system to flush the dirty
buffers. Enable this to avoid sudden dirty buffer flushing from
impacting read latencies. Almost always a good idea on SSDs; not
necessarily on platters."
[storage_port]
;type = string
check/port =
default = 7000
description = "
TCP port, for commands and data
For security reasons, you should not expose this port to the internet. Firewall it if needed.
"
[ssl_storage_port]
;type = string
check/port =
default = 7001
description = "
SSL port, for encrypted communication. Unused unless enabled in
encryption_options
For security reasons, you should not expose this port to the internet. Firewall it if needed.
"
[listen_address]
check/type = string
check/ipaddr =
;type = string
default = localhost
description = "
Address or interface to bind to and tell other Cassandra nodes to connect to.
You _must_ change this if you want multiple nodes to be able to communicate!
Set listen_address OR listen_interface, not both.
Leaving it blank leaves it up to InetAddress.getLocalHost(). This
will always do the Right Thing _if_ the node is properly configured
(hostname, name resolution, etc), and the Right Thing is to use the
address associated with the hostname (it might not be).
Setting listen_address to 0.0.0.0 is always wrong."
[listen_interface]
;type = string
check/type = string
default = eth0
description = "
Set listen_address OR listen_interface, not both. Interfaces must correspond
to a single address, IP aliasing is not supported."
[listen_interface_prefer_ipv6]
;type = boolean
check/type = boolean
default = false
description = "
If you choose to specify the interface by name and the interface has an ipv4 and an ipv6 address
you can specify which should be chosen using listen_interface_prefer_ipv6. If false the first ipv4
address will be used. If true the first ipv6 address will be used. If there is only one address it will be selected regardless of ipv4/ipv6."
[broadcast_address]
;type = string
check/type = string
check/ipaddr =
default =
description = "
Address to broadcast to other Cassandra nodes
Leaving this blank will set it to the same value as listen_address"
[listen_on_broadcast_address]
;type = boolean
check/type = boolean
default = false
description = "
When using multiple physical network interfaces, set this
to true to listen on broadcast_address in addition to
the listen_address, allowing nodes to communicate in both
interfaces.
Ignore this property if the network configuration automatically
routes between the public and private networks such as EC2."
[internode_authenticator]
;type = string
check/type = string
check/ipaddr =
default = "org.apache.cassandra.auth.AllowAllInternodeAuthenticator"
description = "
Internode authentication backend, implementing IInternodeAuthenticator;
used to allow/disallow connections from peer nodes."
[start_native_transport]
;type = boolean
check/type = boolean
default = true
description = "
Whether to start the native transport server.
Please note that the address on which the native transport is bound is the
same as the rpc_address. The port however is different and specified below."
[native_transport_port]
;type = string
check/port =
default = 9042
description = "
port for the CQL native transport to listen for clients on
For security reasons, you should not expose this port to the internet. Firewall it if needed.
"
[native_transport_port_ssl]
;type = string
check/port =
default = 9042
description = "
Enabling native transport encryption in client_encryption_options allows you to either use
encryption for the standard port or to use a dedicated, additional port along with the unencrypted
standard native_transport_port.
Enabling client encryption and keeping native_transport_port_ssl disabled will use encryption
for native_transport_port. Setting native_transport_port_ssl to a different value
from native_transport_port will use encryption for native_transport_port_ssl while
keeping native_transport_port unencrypted.
"
[native_transport_max_threads]
;type = unsigned_long
check/type = unsigned_long
default = 128
description = "
The maximum threads for handling requests when the native transport is used.
This is similar to rpc_max_threads though the default differs slightly (and
there is no native_transport_min_threads, idle threads will always be stopped
after 30 seconds)."
[native_transport_max_concurrent_connections]
;type = long
check/type = long
default = -1
description = "
The maximum number of concurrent client connections.
-1 means unlimited."
[native_transport_max_concurrent_connections_per_ip]
;type = long
check/type = long
default = -1
description = "
The maximum number of concurrent client connections per source ip.
-1 means unlimited."
[start_rpc]