ardb.conf

# Ardb configuration file example, modified from redis's conf file.

# Home dir for ardb instance, it can be referenced by ${ARDB_HOME} in this config file
home  ..

# Note on units: when memory size is needed, it is possible to specify
# it in the usual form of 1k 5GB 4M and so forth:
#
# 1k => 1000 bytes
# 1kb => 1024 bytes
# 1m => 1000000 bytes
# 1mb => 1024*1024 bytes
# 1g => 1000000000 bytes
# 1gb => 1024*1024*1024 bytes
#
# units are case insensitive so 1GB 1Gb 1gB are all the same.

# By default Ardb does not run as a daemon. Use 'yes' if you need it.
daemonize no

# When running daemonized, Ardb writes a pid file in ${ARDB_HOME}/ardb.pid by
# default. You can specify a custom pid file location here.
pidfile ${ARDB_HOME}/ardb.pid

# Accept connections on the specified host&port/unix socket, default is 0.0.0.0:16379.
# More than one listen address supported
listen             0.0.0.0:16379
# The thread pool size for the corresponding listen server, default value is 1
thread-pool-size   2
# The QPS(query per second) limit for the listen server, 0 or negative value means no limit
# If current qps exceed the limit, Ardb would return an error.
qps-limit          0

#listen on another address with specified thread-pool-size & qps-limit
#listen             0.0.0.0:36380
#thread-pool-size   2
#qps-limit          1000

#listen on unix socket
#listen             /tmp/ardb.sock
#unixsocketperm     755
#thread-pool-size   2
#qps-limit          1000


#storage engine's options
#leveldb's options , 0 means default setting
leveldb.block_cache_size       512m
leveldb.block_size             0
leveldb.write_buffer_size      128m
leveldb.block_restart_interval 0
leveldb.max_open_files         1024
leveldb.bloom_bits             10
leveldb.batch_commit_watermark 1024
# Specify the leveldb's compression
# This can be one of snappy/none
leveldb.compression            snappy

#lmdb's options 
lmdb.database_max_size         10G
lmdb.readahead                 no
lmdb.batch_commit_watermark    1024

#rocksdb's options, similar to leveldb's options
rocksdb.statistics_enable      yes
rocksdb.max_open_files         5000
#if 'use_bulk_load_options' set to 'yes', all other rocksdb's options below would be ignored 
rocksdb.use_bulk_load_options  no
rocksdb.block_cache_size       512m
rocksdb.block_size             0
rocksdb.write_buffer_size      128m
rocksdb.block_restart_interval 0
rocksdb.bloom_bits             10
rocksdb.batch_commit_watermark 1024
# Specify the rocksdb compression
# This can be one of snappy/none
rocksdb.compression            snappy
rocksdb.skip_log_error_on_recovery yes
#0 means no limit
rocksdb.flush_compact_rate_bytes_per_sec  0
rocksdb.hard_rate_limit        2.0
rocksdb.disableWAL             no
rocksdb.max_manifest_file_size 2G
#The compaction style, could be set to 'level' or 'universal'
rocksdb.compaction_style       level
rocksdb.disable_auto_compactions no


#wiredtiger's options
# You can configure wiredtiger to support snappy as compressor by adding 'extensions' config
#wiredtiger.init_options  create,cache_size=500M,statistics=(fast,clear),log=(enabled),extensions=[/usr/loca/lib/libwiredtiger_snappy.so]
wiredtiger.init_options         create,cache_size=500M,statistics=(fast),log=(enabled)
# You can enable snappy compressor by adding 'block_compressor=snappy' in the 'wiredtiger.init_table_options'
#wiredtiger.init_table_options   block_compressor=snappy,key_format=u,value_format=u,prefix_compression=true
wiredtiger.init_table_options   key_format=u,value_format=u,prefix_compression=true


# Set the number of databases. The default database is DB 0, you can select
# a different one on a per-connection basis using SELECT <dbid> where
# dbid is a number between 0 and 'databases'-1
databases 16


# Close the connection after a client is idle for N seconds (0 to disable)
timeout 0

# TCP keepalive.
#
# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
# of communication. This is useful for two reasons:
#
# 1) Detect dead peers.
# 2) Take the connection alive from the point of view of network
#    equipment in the middle.
#
# On Linux, the specified value (in seconds) is the period used to send ACKs.
# Note that to close the connection the double of the time is needed.
# On other kernels the period depends on the kernel configuration.
#
# A reasonable value for this option is 60 seconds.
tcp-keepalive 0

# Specify the server verbosity level.
# This can be one of:
# error
# warn
# info 
# debug
# trace
loglevel info

# Specify the log file name. Also 'stdout' can be used to force
# Redis to log on the standard output. Note that if you use standard
# output for logging but daemonize, logs will be sent to /dev/null
#logfile ${ARDB_HOME}/log/ardb-server.log
logfile  stdout


# The working data directory.
#
# The DB will be written inside this directory, with the filename specified
# above using the 'dbfilename' configuration directive.
# 
# The Append Only File will also be created inside this directory.
# 
# Note that you must specify a directory here, not a file name.
data-dir ${ARDB_HOME}/data

################################# REPLICATION #################################

# Master-Slave replication. Use slaveof to make a Ardb instance a copy of
# another Ardb server. Note that the configuration is local to the slave
# so for example it is possible to configure the slave to save the DB with a
# different interval, or to listen to another port, and so on.
#
# slaveof <masterip>:<masterport>
#slaveof 127.0.0.1:6379


# Use replicate-include-db to make current ardb instance only replicate selected databases from master.
# Use replicate-exclude-db to make current ardb instance only replicate non-selected databases from master.
# replicate-include-db  1|2|3|4
# replicate-exclude-db  1|2|3|4

# The directory for replication.
repl-dir                          ${ARDB_HOME}/repl


# When a slave loses its connection with the master, or when the replication
# is still in progress, the slave can act in two different ways:
#
# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
#    still reply to client requests, possibly with out of date data, or the
#    data set may just be empty if this is the first synchronization.
#
# 2) if slave-serve-stale-data is set to 'no' the slave will reply with
#    an error "SYNC with master in progress" to all the kind of commands
#    but to INFO and SLAVEOF.
#
slave-serve-stale-data yes

# The slave priority is an integer number published by Ardb/Redis in the INFO output.
# It is used by Redis Sentinel in order to select a slave to promote into a
# master if the master is no longer working correctly.
#
# A slave with a low priority number is considered better for promotion, so
# for instance if there are three slaves with priority 10, 100, 25 Sentinel will
# pick the one with priority 10, that is the lowest.
#
# However a special priority of 0 marks the slave as not able to perform the
# role of master, so a slave with priority of 0 will never be selected by
# Redis Sentinel for promotion.
#
# By default the priority is 100.
slave-priority 100

# You can configure a slave instance to accept writes or not. Writing against
# a slave instance may be useful to store some ephemeral data (because data
# written on a slave will be easily deleted after resync with the master) but
# may also cause problems if clients are writing to it because of a
# misconfiguration.
#
# Note: read only slaves are not designed to be exposed to untrusted clients
# on the internet. It's just a protection layer against misuse of the instance.
# Still a read only slave exports by default all the administrative commands
# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
# security of read only slaves using 'rename-command' to shadow all the
# administrative / dangerous commands.
# 
# Note: any requests processed by non read only slaves would no write to replication 
# log and sync to connected slaves. 
slave-read-only yes

# The directory for backup.
backup-dir                        ${ARDB_HOME}/backup
#
# You can configure the backup file format as 'redis' or 'ardb'. The 'ardb' format 
# can only used by ardb instance, while 'redis' format file can be used by redis 
# and ardb instance. 
backup-file-format                ardb


# Slaves send PINGs to server in a predefined interval. It's possible to change
# this interval with the repl_ping_slave_period option. The default value is 10
# seconds.
#
# repl-ping-slave-period 10

# The following option sets a timeout for both Bulk transfer I/O timeout and
# master data or ping response timeout. The default value is 60 seconds.
#
# It is important to make sure that this value is greater than the value
# specified for repl-ping-slave-period otherwise a timeout will be detected
# every time there is low traffic between the master and the slave.
#
# repl-timeout 60

# Disable TCP_NODELAY on the slave socket after SYNC?
#
# If you select "yes" Ardb will use a smaller number of TCP packets and
# less bandwidth to send data to slaves. But this can add a delay for
# the data to appear on the slave side, up to 40 milliseconds with
# Linux kernels using a default configuration.
#
# If you select "no" the delay for data to appear on the slave side will
# be reduced but more bandwidth will be used for replication.
#
# By default we optimize for low latency, but in very high traffic conditions
# or when the master and slaves are many hops away, turning this to "yes" may
# be a good idea.
repl-disable-tcp-nodelay no

# Set the replication backlog size. The backlog is a buffer that accumulates
# slave data when slaves are disconnected for some time, so that when a slave
# wants to reconnect again, often a full resync is not needed, but a partial
# resync is enough, just passing the portion of data the slave missed while
# disconnected.
#
# The biggest the replication backlog, the longer the time the slave can be
# disconnected and later be able to perform a partial resynchronization.
#
# If the size is configured by 0, then Ardb instance can NOT serve as a master.
#
# repl-backlog-size 500m 
repl-backlog-size           1G

# After a master has no longer connected slaves for some time, the backlog
# will be freed. The following option configures the amount of seconds that
# need to elapse, starting from the time the last slave disconnected, for
# the backlog buffer to be freed.
#
# A value of 0 means to never release the backlog.
#
# repl-backlog-ttl 3600

# Slave clear current data store before full resync to master. 
# It make sure that slave keep consistent with master's data. But slave may cost a 
# long time to delete data, it depends on 
# If set by no, then slave may have different data with master.
slave-cleardb-before-fullresync    yes

# Master/Slave instance would persist sync state every 'repl-state-persist-period' secs.
repl-state-persist-period         5

# Slave would ignore any 'expire' setting from replication command if set by 'yes'.
# It could be used if master is redis instance serve hot data with expire setting, slave is
# ardb instance which persist all data. 
# Since master redis instance would generate a 'del' for each expired key, slave should ignore
# all 'del' command too by setting 'slave-ignore-del' to 'yes' for this scenario.
slave-ignore-expire   no
slave-ignore-del      no

# After a master has no longer connected slaves for some time, the backlog
# will be freed. The following option configures the amount of seconds that
# need to elapse, starting from the time the last slave disconnected, for
# the backlog buffer to be freed.
#
# A value of 0 means to never release the backlog.
#
# repl-backlog-ttl 3600


################################## SECURITY ###################################

# Require clients to issue AUTH <PASSWORD> before processing any other
# commands.  This might be useful in environments in which you do not trust
# others with access to the host running redis-server.
#
# This should stay commented out for backward compatibility and because most
# people do not need auth (e.g. they run their own servers).
# 
# Warning: since Redis is pretty fast an outside user can try up to
# 150k passwords per second against a good box. This means that you should
# use a very strong password otherwise it will be very easy to break.
#
# requirepass foobared

# Command renaming.
#
# It is possible to change the name of dangerous commands in a shared
# environment. For instance the CONFIG command may be renamed into something
# hard to guess so that it will still be available for internal-use tools
# but not available for general clients.
#
# Example:
#
# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
#
# It is also possible to completely kill a command by renaming it into
# an empty string:
#
# rename-command CONFIG ""
#
# Please note that changing the name of commands that are logged into the
# AOF file or transmitted to slaves may cause problems.

################################ CLUSTER  ###############################

# Max execution time of a Lua script in milliseconds.
#zookeeper-servers 127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183
#zk-recv-timeout  10000
cluster-name   ardb-cluster


################################### LIMITS ####################################

# Set the max number of connected clients at the same time. By default
# this limit is set to 10000 clients, however if the Redis server is not
# able to configure the process file limit to allow for the specified limit
# the max number of allowed clients is set to the current file limit
# minus 32 (as Redis reserves a few file descriptors for internal uses).
#
# Once the limit is reached Redis will close all the new connections sending
# an error 'max number of clients reached'.
#
# maxclients 10000


# The client output buffer limits can be used to force disconnection of clients
# that are not reading data from the server fast enough for some reason (a
# common reason is that a Pub/Sub/Slave client can't consume messages as fast as the
# publisher can produce them).
slave-client-output-buffer-limit 256mb
pubsub-client-output-buffer-limit 32mb

################################## SLOW LOG ###################################

# The Redis Slow Log is a system to log queries that exceeded a specified
# execution time. The execution time does not include the I/O operations
# like talking with the client, sending the reply and so forth,
# but just the time needed to actually execute the command (this is the only
# stage of command execution where the thread is blocked and can not serve
# other requests in the meantime).
# 
# You can configure the slow log with two parameters: one tells Redis
# what is the execution time, in microseconds, to exceed in order for the
# command to get logged, and the other parameter is the length of the
# slow log. When a new command is logged the oldest one is removed from the
# queue of logged commands.

# The following time is expressed in microseconds, so 1000000 is equivalent
# to one second. Note that a negative number disables the slow log, while
# a value of zero forces the logging of every command.
slowlog-log-slower-than 10000

# There is no limit to this length. Just be aware that it will consume memory.
# You can reclaim memory used by the slow log with SLOWLOG RESET.
slowlog-max-len 128

################################ LUA SCRIPTING  ###############################

# Max execution time of a Lua script in milliseconds.
#
# If the maximum execution time is reached Redis will log that a script is
# still in execution after the maximum allowed time and will start to
# reply to queries with an error.
#
# When a long running script exceed the maximum execution time only the
# SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
# used to stop a script that did not yet called write commands. The second
# is the only way to shut down the server in the case a write commands was
# already issue by the script but the user don't want to wait for the natural
# termination of the script.
#
# Set it to 0 or a negative value for unlimited execution without warnings.
lua-time-limit 5000

############################### ADVANCED CONFIG ###############################
## Since some redis clients would check info command's output, this configuration
## would be set in 'misc' section of 'info's output
#additional-misc-info   redis_version:2.8.9\nredis_trick:yes

# All keys have its type, like string/hash/list/zset/set. Set it to 1 to enable 
# the type evaluate procedure, which would decrease the performance for 'set'.
# Set it to 0 would disable the type evaluation, which may overwrite hash/list/zset/set
# key without any warning.
check_type_before_set_string  0

# Hashes are encoded using a memory efficient data structure when they have a
# small number of entries, and the biggest entry does not exceed a given
# threshold. These thresholds can be configured using the following directives.
hash-max-ziplist-entries 256
hash-max-ziplist-value   256

# Similarly to hashes, small lists are also encoded in a special way in order
# to save a lot of space. The special representation is only used when
# you are under the following limits:
list-max-ziplist-entries 256
list-max-ziplist-value   256

# Similarly to hashes and lists, sorted sets are also specially encoded in
# order to save a lot of space. This encoding is only used when the length and
# elements of a sorted set are below the following limits:
set-max-ziplist-entries 256
set-max-ziplist-value   256

# Similarly to hashes and lists, sorted sets are also specially encoded in
# order to save a lot of space. This encoding is only used when the length and
# elements of a sorted set are below the following limits:
zset-max-ziplist-entries 256
zset-max-ziplist-value   256

#The max string value length for storing bits.
#If more bits need to be stored, then ardb would use 'bitset' to store bits.
max-string-bitset-value  1M

# Experiment: L1 cahce is the high level LRU cache holded in memory.
# Use 'CACHE LOAD key' to load a key in L1 cache, 'CACHE EVICT key' to evict one, 'CACHE STATUS key' to view status for a key.
# WARNING, do NOT enable this if you do not know what's L1 cache used for. 
#L1-zset-max-cache-size    10000
#L1-set-max-cache-size     1000000
#L1-hash-max-cache-size    1000000
#L1-list-max-cache-size    1000000
#L1-string-max-cache-size  1000000

L1-zset-read-fill-cache   no
L1-zset-seek-load-cache   no
L1-set-read-fill-cache    no
L1-set-seek-load-cache    no
L1-hash-read-fill-cache   no
L1-hash-seek-load-cache   no
L1-list-read-fill-cache   no
L1-list-seek-load-cache   no
L1-string-read-fill-cache no


# HyperLogLog sparse representation bytes limit. The limit includes the
# 16 bytes header. When an HyperLogLog using the sparse representation crosses
# this limit, it is convereted into the dense representation.
#
# A value greater than 16000 is totally useless, since at that point the
# dense representation is more memory efficient.
# 
# The suggested value is ~ 3000 in order to have the benefits of
# the space efficient encoding without slowing down too much PFADD,
# which is O(N) with the sparse encoding. Thev value can be raised to
# ~ 10000 when CPU is not a concern, but space is, and the data set is
# composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
hll-sparse-max-bytes 3000


# All 'compact' configs only have effect with LevelDB/RocksDB engine
#
# Enable compact GC task or not
compact-enable  no
compact-after-write 50000000

#Min interval seconds between two compact gc task, default 1 hour
compact-min-interval 3600
#Max interval seconds between two compact gc task, default 24 hours
compact-max-interval 86400

#trusted-ip  10.10.10.10
#trusted-ip  10.10.10.*

# If the client only write set/hash with one 'hmset/sadd' command, you can enable the configuration,
# It can reduce one 'del' operation if you want to replace exist key. If the exist key is not zip encoded,
# there would be some undefined result for some commands.
replace-all-for-multi-sadd no
replace-all-for-hmset      no

# Ardb would store cursor in memory 
scan-redis-compatible         yes
scan-cursor-expire-after      60

# By default Ardb would run lua script atomic. Use 'no' if you do not need it.
lua-exec-atomic  yes