redis.conf 46 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054
  1. # Redis configuration file example.
  2. #
  3. # Note that in order to read the configuration file, Redis must be
  4. # started with the file path as first argument:
  5. #
  6. # ./redis-server /path/to/redis.conf
  7. # Note on units: when memory size is needed, it is possible to specify
  8. # it in the usual form of 1k 5GB 4M and so forth:
  9. #
  10. # 1k => 1000 bytes
  11. # 1kb => 1024 bytes
  12. # 1m => 1000000 bytes
  13. # 1mb => 1024*1024 bytes
  14. # 1g => 1000000000 bytes
  15. # 1gb => 1024*1024*1024 bytes
  16. #
  17. # units are case insensitive so 1GB 1Gb 1gB are all the same.
  18. ################################## INCLUDES ###################################
  19. # Include one or more other config files here. This is useful if you
  20. # have a standard template that goes to all Redis servers but also need
  21. # to customize a few per-server settings. Include files can include
  22. # other files, so use this wisely.
  23. #
  24. # Notice option "include" won't be rewritten by command "CONFIG REWRITE"
  25. # from admin or Redis Sentinel. Since Redis always uses the last processed
  26. # line as value of a configuration directive, you'd better put includes
  27. # at the beginning of this file to avoid overwriting config change at runtime.
  28. #
  29. # If instead you are interested in using includes to override configuration
  30. # options, it is better to use include as the last line.
  31. #
  32. # include /path/to/local.conf
  33. # include /path/to/other.conf
  34. ################################## NETWORK #####################################
  35. # By default, if no "bind" configuration directive is specified, Redis listens
  36. # for connections from all the network interfaces available on the server.
  37. # It is possible to listen to just one or multiple selected interfaces using
  38. # the "bind" configuration directive, followed by one or more IP addresses.
  39. #
  40. # Examples:
  41. #
  42. # bind 192.168.1.100 10.0.0.1
  43. # bind 127.0.0.1 ::1
  44. #
  45. # ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the
  46. # internet, binding to all the interfaces is dangerous and will expose the
  47. # instance to everybody on the internet. So by default we uncomment the
  48. # following bind directive, that will force Redis to listen only into
  49. # the IPv4 lookback interface address (this means Redis will be able to
  50. # accept connections only from clients running into the same computer it
  51. # is running).
  52. #
  53. # IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES
  54. # JUST UNCOMMENT THE FOLLOWING LINE.
  55. # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  56. bind 127.0.0.1
  57. # Accept connections on the specified port, default is 6379 (IANA #815344).
  58. # If port 0 is specified Redis will not listen on a TCP socket.
  59. port 6379
  60. # TCP listen() backlog.
  61. #
  62. # In high requests-per-second environments you need an high backlog in order
  63. # to avoid slow clients connections issues. Note that the Linux kernel
  64. # will silently truncate it to the value of /proc/sys/net/core/somaxconn so
  65. # make sure to raise both the value of somaxconn and tcp_max_syn_backlog
  66. # in order to get the desired effect.
  67. tcp-backlog 511
  68. # Unix socket.
  69. #
  70. # Specify the path for the Unix socket that will be used to listen for
  71. # incoming connections. There is no default, so Redis will not listen
  72. # on a unix socket when not specified.
  73. #
  74. # unixsocket /tmp/redis.sock
  75. # unixsocketperm 700
  76. # Close the connection after a client is idle for N seconds (0 to disable)
  77. timeout 0
  78. # TCP keepalive.
  79. #
  80. # If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
  81. # of communication. This is useful for two reasons:
  82. #
  83. # 1) Detect dead peers.
  84. # 2) Take the connection alive from the point of view of network
  85. # equipment in the middle.
  86. #
  87. # On Linux, the specified value (in seconds) is the period used to send ACKs.
  88. # Note that to close the connection the double of the time is needed.
  89. # On other kernels the period depends on the kernel configuration.
  90. #
  91. # A reasonable value for this option is 60 seconds.
  92. tcp-keepalive 0
  93. ################################# GENERAL #####################################
  94. # By default Redis does not run as a daemon. Use 'yes' if you need it.
  95. # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
  96. daemonize no
  97. # If you run Redis from upstart or systemd, Redis can interact with your
  98. # supervision tree. Options:
  99. # supervised no - no supervision interaction
  100. # supervised upstart - signal upstart by putting Redis into SIGSTOP mode
  101. # supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET
  102. # supervised auto - detect upstart or systemd method based on
  103. # UPSTART_JOB or NOTIFY_SOCKET environment variables
  104. # Note: these supervision methods only signal "process is ready."
  105. # They do not enable continuous liveness pings back to your supervisor.
  106. supervised no
  107. # If a pid file is specified, Redis writes it where specified at startup
  108. # and removes it at exit.
  109. #
  110. # When the server runs non daemonized, no pid file is created if none is
  111. # specified in the configuration. When the server is daemonized, the pid file
  112. # is used even if not specified, defaulting to "/var/run/redis.pid".
  113. #
  114. # Creating a pid file is best effort: if Redis is not able to create it
  115. # nothing bad happens, the server will start and run normally.
  116. pidfile /var/run/redis.pid
  117. # Specify the server verbosity level.
  118. # This can be one of:
  119. # debug (a lot of information, useful for development/testing)
  120. # verbose (many rarely useful info, but not a mess like the debug level)
  121. # notice (moderately verbose, what you want in production probably)
  122. # warning (only very important / critical messages are logged)
  123. loglevel notice
  124. # Specify the log file name. Also the empty string can be used to force
  125. # Redis to log on the standard output. Note that if you use standard
  126. # output for logging but daemonize, logs will be sent to /dev/null
  127. logfile ""
  128. # To enable logging to the system logger, just set 'syslog-enabled' to yes,
  129. # and optionally update the other syslog parameters to suit your needs.
  130. # syslog-enabled no
  131. # Specify the syslog identity.
  132. # syslog-ident redis
  133. # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
  134. # syslog-facility local0
  135. # Set the number of databases. The default database is DB 0, you can select
  136. # a different one on a per-connection basis using SELECT <dbid> where
  137. # dbid is a number between 0 and 'databases'-1
  138. databases 16
  139. ################################ SNAPSHOTTING ################################
  140. #
  141. # Save the DB on disk:
  142. #
  143. # save <seconds> <changes>
  144. #
  145. # Will save the DB if both the given number of seconds and the given
  146. # number of write operations against the DB occurred.
  147. #
  148. # In the example below the behaviour will be to save:
  149. # after 900 sec (15 min) if at least 1 key changed
  150. # after 300 sec (5 min) if at least 10 keys changed
  151. # after 60 sec if at least 10000 keys changed
  152. #
  153. # Note: you can disable saving completely by commenting out all "save" lines.
  154. #
  155. # It is also possible to remove all the previously configured save
  156. # points by adding a save directive with a single empty string argument
  157. # like in the following example:
  158. #
  159. # save ""
  160. save 900 1
  161. save 300 10
  162. save 60 10000
  163. # By default Redis will stop accepting writes if RDB snapshots are enabled
  164. # (at least one save point) and the latest background save failed.
  165. # This will make the user aware (in a hard way) that data is not persisting
  166. # on disk properly, otherwise chances are that no one will notice and some
  167. # disaster will happen.
  168. #
  169. # If the background saving process will start working again Redis will
  170. # automatically allow writes again.
  171. #
  172. # However if you have setup your proper monitoring of the Redis server
  173. # and persistence, you may want to disable this feature so that Redis will
  174. # continue to work as usual even if there are problems with disk,
  175. # permissions, and so forth.
  176. stop-writes-on-bgsave-error yes
  177. # Compress string objects using LZF when dump .rdb databases?
  178. # For default that's set to 'yes' as it's almost always a win.
  179. # If you want to save some CPU in the saving child set it to 'no' but
  180. # the dataset will likely be bigger if you have compressible values or keys.
  181. rdbcompression yes
  182. # Since version 5 of RDB a CRC64 checksum is placed at the end of the file.
  183. # This makes the format more resistant to corruption but there is a performance
  184. # hit to pay (around 10%) when saving and loading RDB files, so you can disable it
  185. # for maximum performances.
  186. #
  187. # RDB files created with checksum disabled have a checksum of zero that will
  188. # tell the loading code to skip the check.
  189. rdbchecksum yes
  190. # The filename where to dump the DB
  191. dbfilename dump.rdb
  192. # The working directory.
  193. #
  194. # The DB will be written inside this directory, with the filename specified
  195. # above using the 'dbfilename' configuration directive.
  196. #
  197. # The Append Only File will also be created inside this directory.
  198. #
  199. # Note that you must specify a directory here, not a file name.
  200. dir ./
  201. ################################# REPLICATION #################################
  202. # Master-Slave replication. Use slaveof to make a Redis instance a copy of
  203. # another Redis server. A few things to understand ASAP about Redis replication.
  204. #
  205. # 1) Redis replication is asynchronous, but you can configure a master to
  206. # stop accepting writes if it appears to be not connected with at least
  207. # a given number of slaves.
  208. # 2) Redis slaves are able to perform a partial resynchronization with the
  209. # master if the replication link is lost for a relatively small amount of
  210. # time. You may want to configure the replication backlog size (see the next
  211. # sections of this file) with a sensible value depending on your needs.
  212. # 3) Replication is automatic and does not need user intervention. After a
  213. # network partition slaves automatically try to reconnect to masters
  214. # and resynchronize with them.
  215. #
  216. # slaveof <masterip> <masterport>
  217. # If the master is password protected (using the "requirepass" configuration
  218. # directive below) it is possible to tell the slave to authenticate before
  219. # starting the replication synchronization process, otherwise the master will
  220. # refuse the slave request.
  221. #
  222. # masterauth <master-password>
  223. # When a slave loses its connection with the master, or when the replication
  224. # is still in progress, the slave can act in two different ways:
  225. #
  226. # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
  227. # still reply to client requests, possibly with out of date data, or the
  228. # data set may just be empty if this is the first synchronization.
  229. #
  230. # 2) if slave-serve-stale-data is set to 'no' the slave will reply with
  231. # an error "SYNC with master in progress" to all the kind of commands
  232. # but to INFO and SLAVEOF.
  233. #
  234. slave-serve-stale-data yes
  235. # You can configure a slave instance to accept writes or not. Writing against
  236. # a slave instance may be useful to store some ephemeral data (because data
  237. # written on a slave will be easily deleted after resync with the master) but
  238. # may also cause problems if clients are writing to it because of a
  239. # misconfiguration.
  240. #
  241. # Since Redis 2.6 by default slaves are read-only.
  242. #
  243. # Note: read only slaves are not designed to be exposed to untrusted clients
  244. # on the internet. It's just a protection layer against misuse of the instance.
  245. # Still a read only slave exports by default all the administrative commands
  246. # such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
  247. # security of read only slaves using 'rename-command' to shadow all the
  248. # administrative / dangerous commands.
  249. slave-read-only yes
  250. # Replication SYNC strategy: disk or socket.
  251. #
  252. # -------------------------------------------------------
  253. # WARNING: DISKLESS REPLICATION IS EXPERIMENTAL CURRENTLY
  254. # -------------------------------------------------------
  255. #
  256. # New slaves and reconnecting slaves that are not able to continue the replication
  257. # process just receiving differences, need to do what is called a "full
  258. # synchronization". An RDB file is transmitted from the master to the slaves.
  259. # The transmission can happen in two different ways:
  260. #
  261. # 1) Disk-backed: The Redis master creates a new process that writes the RDB
  262. # file on disk. Later the file is transferred by the parent
  263. # process to the slaves incrementally.
  264. # 2) Diskless: The Redis master creates a new process that directly writes the
  265. # RDB file to slave sockets, without touching the disk at all.
  266. #
  267. # With disk-backed replication, while the RDB file is generated, more slaves
  268. # can be queued and served with the RDB file as soon as the current child producing
  269. # the RDB file finishes its work. With diskless replication instead once
  270. # the transfer starts, new slaves arriving will be queued and a new transfer
  271. # will start when the current one terminates.
  272. #
  273. # When diskless replication is used, the master waits a configurable amount of
  274. # time (in seconds) before starting the transfer in the hope that multiple slaves
  275. # will arrive and the transfer can be parallelized.
  276. #
  277. # With slow disks and fast (large bandwidth) networks, diskless replication
  278. # works better.
  279. repl-diskless-sync no
  280. # When diskless replication is enabled, it is possible to configure the delay
  281. # the server waits in order to spawn the child that transfers the RDB via socket
  282. # to the slaves.
  283. #
  284. # This is important since once the transfer starts, it is not possible to serve
  285. # new slaves arriving, that will be queued for the next RDB transfer, so the server
  286. # waits a delay in order to let more slaves arrive.
  287. #
  288. # The delay is specified in seconds, and by default is 5 seconds. To disable
  289. # it entirely just set it to 0 seconds and the transfer will start ASAP.
  290. repl-diskless-sync-delay 5
  291. # Slaves send PINGs to server in a predefined interval. It's possible to change
  292. # this interval with the repl_ping_slave_period option. The default value is 10
  293. # seconds.
  294. #
  295. # repl-ping-slave-period 10
  296. # The following option sets the replication timeout for:
  297. #
  298. # 1) Bulk transfer I/O during SYNC, from the point of view of slave.
  299. # 2) Master timeout from the point of view of slaves (data, pings).
  300. # 3) Slave timeout from the point of view of masters (REPLCONF ACK pings).
  301. #
  302. # It is important to make sure that this value is greater than the value
  303. # specified for repl-ping-slave-period otherwise a timeout will be detected
  304. # every time there is low traffic between the master and the slave.
  305. #
  306. # repl-timeout 60
  307. # Disable TCP_NODELAY on the slave socket after SYNC?
  308. #
  309. # If you select "yes" Redis will use a smaller number of TCP packets and
  310. # less bandwidth to send data to slaves. But this can add a delay for
  311. # the data to appear on the slave side, up to 40 milliseconds with
  312. # Linux kernels using a default configuration.
  313. #
  314. # If you select "no" the delay for data to appear on the slave side will
  315. # be reduced but more bandwidth will be used for replication.
  316. #
  317. # By default we optimize for low latency, but in very high traffic conditions
  318. # or when the master and slaves are many hops away, turning this to "yes" may
  319. # be a good idea.
  320. repl-disable-tcp-nodelay no
  321. # Set the replication backlog size. The backlog is a buffer that accumulates
  322. # slave data when slaves are disconnected for some time, so that when a slave
  323. # wants to reconnect again, often a full resync is not needed, but a partial
  324. # resync is enough, just passing the portion of data the slave missed while
  325. # disconnected.
  326. #
  327. # The bigger the replication backlog, the longer the time the slave can be
  328. # disconnected and later be able to perform a partial resynchronization.
  329. #
  330. # The backlog is only allocated once there is at least a slave connected.
  331. #
  332. # repl-backlog-size 1mb
  333. # After a master has no longer connected slaves for some time, the backlog
  334. # will be freed. The following option configures the amount of seconds that
  335. # need to elapse, starting from the time the last slave disconnected, for
  336. # the backlog buffer to be freed.
  337. #
  338. # A value of 0 means to never release the backlog.
  339. #
  340. # repl-backlog-ttl 3600
  341. # The slave priority is an integer number published by Redis in the INFO output.
  342. # It is used by Redis Sentinel in order to select a slave to promote into a
  343. # master if the master is no longer working correctly.
  344. #
  345. # A slave with a low priority number is considered better for promotion, so
  346. # for instance if there are three slaves with priority 10, 100, 25 Sentinel will
  347. # pick the one with priority 10, that is the lowest.
  348. #
  349. # However a special priority of 0 marks the slave as not able to perform the
  350. # role of master, so a slave with priority of 0 will never be selected by
  351. # Redis Sentinel for promotion.
  352. #
  353. # By default the priority is 100.
  354. slave-priority 100
  355. # It is possible for a master to stop accepting writes if there are less than
  356. # N slaves connected, having a lag less or equal than M seconds.
  357. #
  358. # The N slaves need to be in "online" state.
  359. #
  360. # The lag in seconds, that must be <= the specified value, is calculated from
  361. # the last ping received from the slave, that is usually sent every second.
  362. #
  363. # This option does not GUARANTEE that N replicas will accept the write, but
  364. # will limit the window of exposure for lost writes in case not enough slaves
  365. # are available, to the specified number of seconds.
  366. #
  367. # For example to require at least 3 slaves with a lag <= 10 seconds use:
  368. #
  369. # min-slaves-to-write 3
  370. # min-slaves-max-lag 10
  371. #
  372. # Setting one or the other to 0 disables the feature.
  373. #
  374. # By default min-slaves-to-write is set to 0 (feature disabled) and
  375. # min-slaves-max-lag is set to 10.
  376. ################################## SECURITY ###################################
  377. # Require clients to issue AUTH <PASSWORD> before processing any other
  378. # commands. This might be useful in environments in which you do not trust
  379. # others with access to the host running redis-server.
  380. #
  381. # This should stay commented out for backward compatibility and because most
  382. # people do not need auth (e.g. they run their own servers).
  383. #
  384. # Warning: since Redis is pretty fast an outside user can try up to
  385. # 150k passwords per second against a good box. This means that you should
  386. # use a very strong password otherwise it will be very easy to break.
  387. #
  388. # requirepass foobared
  389. # Command renaming.
  390. #
  391. # It is possible to change the name of dangerous commands in a shared
  392. # environment. For instance the CONFIG command may be renamed into something
  393. # hard to guess so that it will still be available for internal-use tools
  394. # but not available for general clients.
  395. #
  396. # Example:
  397. #
  398. # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
  399. #
  400. # It is also possible to completely kill a command by renaming it into
  401. # an empty string:
  402. #
  403. # rename-command CONFIG ""
  404. #
  405. # Please note that changing the name of commands that are logged into the
  406. # AOF file or transmitted to slaves may cause problems.
  407. ################################### CLIENTS ####################################
  408. # Set the max number of connected clients at the same time. By default
  409. # this limit is set to 10000 clients, however if the Redis server is not
  410. # able to configure the process file limit to allow for the specified limit
  411. # the max number of allowed clients is set to the current file limit
  412. # minus 32 (as Redis reserves a few file descriptors for internal uses).
  413. #
  414. # Once the limit is reached Redis will close all the new connections sending
  415. # an error 'max number of clients reached'.
  416. #
  417. # maxclients 10000
  418. ############################## MEMORY MANAGEMENT ################################
  419. # Don't use more memory than the specified amount of bytes.
  420. # When the memory limit is reached Redis will try to remove keys
  421. # according to the eviction policy selected (see maxmemory-policy).
  422. #
  423. # If Redis can't remove keys according to the policy, or if the policy is
  424. # set to 'noeviction', Redis will start to reply with errors to commands
  425. # that would use more memory, like SET, LPUSH, and so on, and will continue
  426. # to reply to read-only commands like GET.
  427. #
  428. # This option is usually useful when using Redis as an LRU cache, or to set
  429. # a hard memory limit for an instance (using the 'noeviction' policy).
  430. #
  431. # WARNING: If you have slaves attached to an instance with maxmemory on,
  432. # the size of the output buffers needed to feed the slaves are subtracted
  433. # from the used memory count, so that network problems / resyncs will
  434. # not trigger a loop where keys are evicted, and in turn the output
  435. # buffer of slaves is full with DELs of keys evicted triggering the deletion
  436. # of more keys, and so forth until the database is completely emptied.
  437. #
  438. # In short... if you have slaves attached it is suggested that you set a lower
  439. # limit for maxmemory so that there is some free RAM on the system for slave
  440. # output buffers (but this is not needed if the policy is 'noeviction').
  441. #
  442. # maxmemory <bytes>
  443. # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
  444. # is reached. You can select among five behaviors:
  445. #
  446. # volatile-lru -> remove the key with an expire set using an LRU algorithm
  447. # allkeys-lru -> remove any key according to the LRU algorithm
  448. # volatile-random -> remove a random key with an expire set
  449. # allkeys-random -> remove a random key, any key
  450. # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
  451. # noeviction -> don't expire at all, just return an error on write operations
  452. #
  453. # Note: with any of the above policies, Redis will return an error on write
  454. # operations, when there are no suitable keys for eviction.
  455. #
  456. # At the date of writing these commands are: set setnx setex append
  457. # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
  458. # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
  459. # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
  460. # getset mset msetnx exec sort
  461. #
  462. # The default is:
  463. #
  464. # maxmemory-policy noeviction
  465. # LRU and minimal TTL algorithms are not precise algorithms but approximated
  466. # algorithms (in order to save memory), so you can tune it for speed or
  467. # accuracy. For default Redis will check five keys and pick the one that was
  468. # used less recently, you can change the sample size using the following
  469. # configuration directive.
  470. #
  471. # The default of 5 produces good enough results. 10 Approximates very closely
  472. # true LRU but costs a bit more CPU. 3 is very fast but not very accurate.
  473. #
  474. # maxmemory-samples 5
  475. ############################# LAZY FREEING ####################################
  476. # Redis has two primitives to delete keys. One is called DEL and is a blocking
  477. # deletion of the object. It means that the server stops processing new commands
  478. # in order to reclaim all the memory associated with an object in a synchronous
  479. # way. If the key deleted is associated with a small object, the time needed
  480. # in order to execute th DEL command is very small and comparable to most other
  481. # O(1) or O(log_N) commands in Redis. However if the key is associated with an
  482. # aggregated value containing millions of elements, the server can block for
  483. # a long time (even seconds) in order to complete the operation.
  484. #
  485. # For the above reasons Redis also offers non blocking deletion primitives
  486. # such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and
  487. # FLUSHDB commands, in order to reclaim memory in background. Those commands
  488. # are executed in constant time. Another thread will incrementally free the
  489. # object in the background as fast as possible.
  490. #
  491. # DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled.
  492. # It's up to the design of the application to understand when it is a good
  493. # idea to use one or the other. However the Redis server sometimes has to
  494. # delete keys or flush the whole database as a side effect of other operations.
  495. # Specifically Redis deletes objects independently of an user call in the
  496. # following scenarios:
  497. #
  498. # 1) On eviction, because of the maxmemory and maxmemory policy configurations,
  499. # in order to make room for new data, without going over the specified
  500. # memory limit.
  501. # 2) Because of expire: when a key with an associated time to live (see the
  502. # EXPIRE command) must be deleted from memory.
  503. # 3) Because of a side effect of a command that stores data on a key that may
  504. # already exist. For example the RENAME command may delete the old key
  505. # content when it is replaced with another one. Similarly SUNIONSTORE
  506. # or SORT with STORE option may delete existing keys. The SET command
  507. # itself removes any old content of the specified key in order to replace
  508. # it with the specified string.
  509. # 4) During replication, when a slave performs a full resynchronization with
  510. # its master, the content of the whole database is removed in order to
  511. # load the RDB file just transfered.
  512. #
  513. # In all the above cases the default is to delete objects in a blocking way,
  514. # like if DEL was called. However you can configure each case specifically
  515. # in order to instead release memory in a non-blocking way like if UNLINK
  516. # was called, using the following configuration directives:
  517. lazyfree-lazy-eviction no
  518. lazyfree-lazy-expire no
  519. lazyfree-lazy-server-del no
  520. slave-lazy-flush no
  521. ############################## APPEND ONLY MODE ###############################
  522. # By default Redis asynchronously dumps the dataset on disk. This mode is
  523. # good enough in many applications, but an issue with the Redis process or
  524. # a power outage may result into a few minutes of writes lost (depending on
  525. # the configured save points).
  526. #
  527. # The Append Only File is an alternative persistence mode that provides
  528. # much better durability. For instance using the default data fsync policy
  529. # (see later in the config file) Redis can lose just one second of writes in a
  530. # dramatic event like a server power outage, or a single write if something
  531. # wrong with the Redis process itself happens, but the operating system is
  532. # still running correctly.
  533. #
  534. # AOF and RDB persistence can be enabled at the same time without problems.
  535. # If the AOF is enabled on startup Redis will load the AOF, that is the file
  536. # with the better durability guarantees.
  537. #
  538. # Please check http://redis.io/topics/persistence for more information.
  539. appendonly no
  540. # The name of the append only file (default: "appendonly.aof")
  541. appendfilename "appendonly.aof"
  542. # The fsync() call tells the Operating System to actually write data on disk
  543. # instead of waiting for more data in the output buffer. Some OS will really flush
  544. # data on disk, some other OS will just try to do it ASAP.
  545. #
  546. # Redis supports three different modes:
  547. #
  548. # no: don't fsync, just let the OS flush the data when it wants. Faster.
  549. # always: fsync after every write to the append only log. Slow, Safest.
  550. # everysec: fsync only one time every second. Compromise.
  551. #
  552. # The default is "everysec", as that's usually the right compromise between
  553. # speed and data safety. It's up to you to understand if you can relax this to
  554. # "no" that will let the operating system flush the output buffer when
  555. # it wants, for better performances (but if you can live with the idea of
  556. # some data loss consider the default persistence mode that's snapshotting),
  557. # or on the contrary, use "always" that's very slow but a bit safer than
  558. # everysec.
  559. #
  560. # More details please check the following article:
  561. # http://antirez.com/post/redis-persistence-demystified.html
  562. #
  563. # If unsure, use "everysec".
  564. # appendfsync always
  565. appendfsync everysec
  566. # appendfsync no
  567. # When the AOF fsync policy is set to always or everysec, and a background
  568. # saving process (a background save or AOF log background rewriting) is
  569. # performing a lot of I/O against the disk, in some Linux configurations
  570. # Redis may block too long on the fsync() call. Note that there is no fix for
  571. # this currently, as even performing fsync in a different thread will block
  572. # our synchronous write(2) call.
  573. #
  574. # In order to mitigate this problem it's possible to use the following option
  575. # that will prevent fsync() from being called in the main process while a
  576. # BGSAVE or BGREWRITEAOF is in progress.
  577. #
  578. # This means that while another child is saving, the durability of Redis is
  579. # the same as "appendfsync none". In practical terms, this means that it is
  580. # possible to lose up to 30 seconds of log in the worst scenario (with the
  581. # default Linux settings).
  582. #
  583. # If you have latency problems turn this to "yes". Otherwise leave it as
  584. # "no" that is the safest pick from the point of view of durability.
  585. no-appendfsync-on-rewrite no
  586. # Automatic rewrite of the append only file.
  587. # Redis is able to automatically rewrite the log file implicitly calling
  588. # BGREWRITEAOF when the AOF log size grows by the specified percentage.
  589. #
  590. # This is how it works: Redis remembers the size of the AOF file after the
  591. # latest rewrite (if no rewrite has happened since the restart, the size of
  592. # the AOF at startup is used).
  593. #
  594. # This base size is compared to the current size. If the current size is
  595. # bigger than the specified percentage, the rewrite is triggered. Also
  596. # you need to specify a minimal size for the AOF file to be rewritten, this
  597. # is useful to avoid rewriting the AOF file even if the percentage increase
  598. # is reached but it is still pretty small.
  599. #
  600. # Specify a percentage of zero in order to disable the automatic AOF
  601. # rewrite feature.
  602. auto-aof-rewrite-percentage 100
  603. auto-aof-rewrite-min-size 64mb
  604. # An AOF file may be found to be truncated at the end during the Redis
  605. # startup process, when the AOF data gets loaded back into memory.
  606. # This may happen when the system where Redis is running
  607. # crashes, especially when an ext4 filesystem is mounted without the
  608. # data=ordered option (however this can't happen when Redis itself
  609. # crashes or aborts but the operating system still works correctly).
  610. #
  611. # Redis can either exit with an error when this happens, or load as much
  612. # data as possible (the default now) and start if the AOF file is found
  613. # to be truncated at the end. The following option controls this behavior.
  614. #
  615. # If aof-load-truncated is set to yes, a truncated AOF file is loaded and
  616. # the Redis server starts emitting a log to inform the user of the event.
  617. # Otherwise if the option is set to no, the server aborts with an error
  618. # and refuses to start. When the option is set to no, the user requires
  619. # to fix the AOF file using the "redis-check-aof" utility before to restart
  620. # the server.
  621. #
  622. # Note that if the AOF file will be found to be corrupted in the middle
  623. # the server will still exit with an error. This option only applies when
  624. # Redis will try to read more data from the AOF file but not enough bytes
  625. # will be found.
  626. aof-load-truncated yes
  627. ################################ LUA SCRIPTING ###############################
  628. # Max execution time of a Lua script in milliseconds.
  629. #
  630. # If the maximum execution time is reached Redis will log that a script is
  631. # still in execution after the maximum allowed time and will start to
  632. # reply to queries with an error.
  633. #
  634. # When a long running script exceeds the maximum execution time only the
  635. # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
  636. # used to stop a script that did not yet called write commands. The second
  637. # is the only way to shut down the server in the case a write command was
  638. # already issued by the script but the user doesn't want to wait for the natural
  639. # termination of the script.
  640. #
  641. # Set it to 0 or a negative value for unlimited execution without warnings.
  642. lua-time-limit 5000
  643. ################################ REDIS CLUSTER ###############################
  644. #
  645. # ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  646. # WARNING EXPERIMENTAL: Redis Cluster is considered to be stable code, however
  647. # in order to mark it as "mature" we need to wait for a non trivial percentage
  648. # of users to deploy it in production.
  649. # ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  650. #
  651. # Normal Redis instances can't be part of a Redis Cluster; only nodes that are
  652. # started as cluster nodes can. In order to start a Redis instance as a
  653. # cluster node enable the cluster support uncommenting the following:
  654. #
  655. # cluster-enabled yes
  656. # Every cluster node has a cluster configuration file. This file is not
  657. # intended to be edited by hand. It is created and updated by Redis nodes.
  658. # Every Redis Cluster node requires a different cluster configuration file.
  659. # Make sure that instances running in the same system do not have
  660. # overlapping cluster configuration file names.
  661. #
  662. # cluster-config-file nodes-6379.conf
  663. # Cluster node timeout is the amount of milliseconds a node must be unreachable
  664. # for it to be considered in failure state.
  665. # Most other internal time limits are multiple of the node timeout.
  666. #
  667. # cluster-node-timeout 15000
  668. # A slave of a failing master will avoid to start a failover if its data
  669. # looks too old.
  670. #
  671. # There is no simple way for a slave to actually have a exact measure of
  672. # its "data age", so the following two checks are performed:
  673. #
  674. # 1) If there are multiple slaves able to failover, they exchange messages
  675. # in order to try to give an advantage to the slave with the best
  676. # replication offset (more data from the master processed).
  677. # Slaves will try to get their rank by offset, and apply to the start
  678. # of the failover a delay proportional to their rank.
  679. #
  680. # 2) Every single slave computes the time of the last interaction with
  681. # its master. This can be the last ping or command received (if the master
  682. # is still in the "connected" state), or the time that elapsed since the
  683. # disconnection with the master (if the replication link is currently down).
  684. # If the last interaction is too old, the slave will not try to failover
  685. # at all.
  686. #
  687. # The point "2" can be tuned by user. Specifically a slave will not perform
  688. # the failover if, since the last interaction with the master, the time
  689. # elapsed is greater than:
  690. #
  691. # (node-timeout * slave-validity-factor) + repl-ping-slave-period
  692. #
  693. # So for example if node-timeout is 30 seconds, and the slave-validity-factor
  694. # is 10, and assuming a default repl-ping-slave-period of 10 seconds, the
  695. # slave will not try to failover if it was not able to talk with the master
  696. # for longer than 310 seconds.
  697. #
  698. # A large slave-validity-factor may allow slaves with too old data to failover
  699. # a master, while a too small value may prevent the cluster from being able to
  700. # elect a slave at all.
  701. #
  702. # For maximum availability, it is possible to set the slave-validity-factor
  703. # to a value of 0, which means, that slaves will always try to failover the
  704. # master regardless of the last time they interacted with the master.
  705. # (However they'll always try to apply a delay proportional to their
  706. # offset rank).
  707. #
  708. # Zero is the only value able to guarantee that when all the partitions heal
  709. # the cluster will always be able to continue.
  710. #
  711. # cluster-slave-validity-factor 10
  712. # Cluster slaves are able to migrate to orphaned masters, that are masters
  713. # that are left without working slaves. This improves the cluster ability
  714. # to resist to failures as otherwise an orphaned master can't be failed over
  715. # in case of failure if it has no working slaves.
  716. #
  717. # Slaves migrate to orphaned masters only if there are still at least a
  718. # given number of other working slaves for their old master. This number
  719. # is the "migration barrier". A migration barrier of 1 means that a slave
  720. # will migrate only if there is at least 1 other working slave for its master
  721. # and so forth. It usually reflects the number of slaves you want for every
  722. # master in your cluster.
  723. #
  724. # Default is 1 (slaves migrate only if their masters remain with at least
  725. # one slave). To disable migration just set it to a very large value.
  726. # A value of 0 can be set but is useful only for debugging and dangerous
  727. # in production.
  728. #
  729. # cluster-migration-barrier 1
  730. # By default Redis Cluster nodes stop accepting queries if they detect there
  731. # is at least an hash slot uncovered (no available node is serving it).
  732. # This way if the cluster is partially down (for example a range of hash slots
  733. # are no longer covered) all the cluster becomes, eventually, unavailable.
  734. # It automatically returns available as soon as all the slots are covered again.
  735. #
  736. # However sometimes you want the subset of the cluster which is working,
  737. # to continue to accept queries for the part of the key space that is still
  738. # covered. In order to do so, just set the cluster-require-full-coverage
  739. # option to no.
  740. #
  741. # cluster-require-full-coverage yes
  742. # In order to setup your cluster make sure to read the documentation
  743. # available at http://redis.io web site.
  744. ################################## SLOW LOG ###################################
  745. # The Redis Slow Log is a system to log queries that exceeded a specified
  746. # execution time. The execution time does not include the I/O operations
  747. # like talking with the client, sending the reply and so forth,
  748. # but just the time needed to actually execute the command (this is the only
  749. # stage of command execution where the thread is blocked and can not serve
  750. # other requests in the meantime).
  751. #
  752. # You can configure the slow log with two parameters: one tells Redis
  753. # what is the execution time, in microseconds, to exceed in order for the
  754. # command to get logged, and the other parameter is the length of the
  755. # slow log. When a new command is logged the oldest one is removed from the
  756. # queue of logged commands.
  757. # The following time is expressed in microseconds, so 1000000 is equivalent
  758. # to one second. Note that a negative number disables the slow log, while
  759. # a value of zero forces the logging of every command.
  760. slowlog-log-slower-than 10000
  761. # There is no limit to this length. Just be aware that it will consume memory.
  762. # You can reclaim memory used by the slow log with SLOWLOG RESET.
  763. slowlog-max-len 128
  764. ################################ LATENCY MONITOR ##############################
  765. # The Redis latency monitoring subsystem samples different operations
  766. # at runtime in order to collect data related to possible sources of
  767. # latency of a Redis instance.
  768. #
  769. # Via the LATENCY command this information is available to the user that can
  770. # print graphs and obtain reports.
  771. #
  772. # The system only logs operations that were performed in a time equal or
  773. # greater than the amount of milliseconds specified via the
  774. # latency-monitor-threshold configuration directive. When its value is set
  775. # to zero, the latency monitor is turned off.
  776. #
  777. # By default latency monitoring is disabled since it is mostly not needed
  778. # if you don't have latency issues, and collecting data has a performance
  779. # impact, that while very small, can be measured under big load. Latency
  780. # monitoring can easily be enabled at runtime using the command
  781. # "CONFIG SET latency-monitor-threshold <milliseconds>" if needed.
  782. latency-monitor-threshold 0
  783. ############################# EVENT NOTIFICATION ##############################
  784. # Redis can notify Pub/Sub clients about events happening in the key space.
  785. # This feature is documented at http://redis.io/topics/notifications
  786. #
  787. # For instance if keyspace events notification is enabled, and a client
  788. # performs a DEL operation on key "foo" stored in the Database 0, two
  789. # messages will be published via Pub/Sub:
  790. #
  791. # PUBLISH __keyspace@0__:foo del
  792. # PUBLISH __keyevent@0__:del foo
  793. #
  794. # It is possible to select the events that Redis will notify among a set
  795. # of classes. Every class is identified by a single character:
  796. #
  797. # K Keyspace events, published with __keyspace@<db>__ prefix.
  798. # E Keyevent events, published with __keyevent@<db>__ prefix.
  799. # g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
  800. # $ String commands
  801. # l List commands
  802. # s Set commands
  803. # h Hash commands
  804. # z Sorted set commands
  805. # x Expired events (events generated every time a key expires)
  806. # e Evicted events (events generated when a key is evicted for maxmemory)
  807. # A Alias for g$lshzxe, so that the "AKE" string means all the events.
  808. #
  809. # The "notify-keyspace-events" takes as argument a string that is composed
  810. # of zero or multiple characters. The empty string means that notifications
  811. # are disabled.
  812. #
  813. # Example: to enable list and generic events, from the point of view of the
  814. # event name, use:
  815. #
  816. # notify-keyspace-events Elg
  817. #
  818. # Example 2: to get the stream of the expired keys subscribing to channel
  819. # name __keyevent@0__:expired use:
  820. #
  821. # notify-keyspace-events Ex
  822. #
  823. # By default all notifications are disabled because most users don't need
  824. # this feature and the feature has some overhead. Note that if you don't
  825. # specify at least one of K or E, no events will be delivered.
  826. notify-keyspace-events ""
  827. ############################### ADVANCED CONFIG ###############################
  828. # Hashes are encoded using a memory efficient data structure when they have a
  829. # small number of entries, and the biggest entry does not exceed a given
  830. # threshold. These thresholds can be configured using the following directives.
  831. hash-max-ziplist-entries 512
  832. hash-max-ziplist-value 64
  833. # Lists are also encoded in a special way to save a lot of space.
  834. # The number of entries allowed per internal list node can be specified
  835. # as a fixed maximum size or a maximum number of elements.
  836. # For a fixed maximum size, use -5 through -1, meaning:
  837. # -5: max size: 64 Kb <-- not recommended for normal workloads
  838. # -4: max size: 32 Kb <-- not recommended
  839. # -3: max size: 16 Kb <-- probably not recommended
  840. # -2: max size: 8 Kb <-- good
  841. # -1: max size: 4 Kb <-- good
  842. # Positive numbers mean store up to _exactly_ that number of elements
  843. # per list node.
  844. # The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size),
  845. # but if your use case is unique, adjust the settings as necessary.
  846. list-max-ziplist-size -2
  847. # Lists may also be compressed.
  848. # Compress depth is the number of quicklist ziplist nodes from *each* side of
  849. # the list to *exclude* from compression. The head and tail of the list
  850. # are always uncompressed for fast push/pop operations. Settings are:
  851. # 0: disable all list compression
  852. # 1: depth 1 means "don't start compressing until after 1 node into the list,
  853. # going from either the head or tail"
  854. # So: [head]->node->node->...->node->[tail]
  855. # [head], [tail] will always be uncompressed; inner nodes will compress.
  856. # 2: [head]->[next]->node->node->...->node->[prev]->[tail]
  857. # 2 here means: don't compress head or head->next or tail->prev or tail,
  858. # but compress all nodes between them.
  859. # 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail]
  860. # etc.
  861. list-compress-depth 0
  862. # Sets have a special encoding in just one case: when a set is composed
  863. # of just strings that happen to be integers in radix 10 in the range
  864. # of 64 bit signed integers.
  865. # The following configuration setting sets the limit in the size of the
  866. # set in order to use this special memory saving encoding.
  867. set-max-intset-entries 512
  868. # Similarly to hashes and lists, sorted sets are also specially encoded in
  869. # order to save a lot of space. This encoding is only used when the length and
  870. # elements of a sorted set are below the following limits:
  871. zset-max-ziplist-entries 128
  872. zset-max-ziplist-value 64
  873. # HyperLogLog sparse representation bytes limit. The limit includes the
  874. # 16 bytes header. When an HyperLogLog using the sparse representation crosses
  875. # this limit, it is converted into the dense representation.
  876. #
  877. # A value greater than 16000 is totally useless, since at that point the
  878. # dense representation is more memory efficient.
  879. #
  880. # The suggested value is ~ 3000 in order to have the benefits of
  881. # the space efficient encoding without slowing down too much PFADD,
  882. # which is O(N) with the sparse encoding. The value can be raised to
  883. # ~ 10000 when CPU is not a concern, but space is, and the data set is
  884. # composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
  885. hll-sparse-max-bytes 3000
  886. # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
  887. # order to help rehashing the main Redis hash table (the one mapping top-level
  888. # keys to values). The hash table implementation Redis uses (see dict.c)
  889. # performs a lazy rehashing: the more operation you run into a hash table
  890. # that is rehashing, the more rehashing "steps" are performed, so if the
  891. # server is idle the rehashing is never complete and some more memory is used
  892. # by the hash table.
  893. #
  894. # The default is to use this millisecond 10 times every second in order to
  895. # actively rehash the main dictionaries, freeing memory when possible.
  896. #
  897. # If unsure:
  898. # use "activerehashing no" if you have hard latency requirements and it is
  899. # not a good thing in your environment that Redis can reply from time to time
  900. # to queries with 2 milliseconds delay.
  901. #
  902. # use "activerehashing yes" if you don't have such hard requirements but
  903. # want to free memory asap when possible.
  904. activerehashing yes
  905. # The client output buffer limits can be used to force disconnection of clients
  906. # that are not reading data from the server fast enough for some reason (a
  907. # common reason is that a Pub/Sub client can't consume messages as fast as the
  908. # publisher can produce them).
  909. #
  910. # The limit can be set differently for the three different classes of clients:
  911. #
  912. # normal -> normal clients including MONITOR clients
  913. # slave -> slave clients
  914. # pubsub -> clients subscribed to at least one pubsub channel or pattern
  915. #
  916. # The syntax of every client-output-buffer-limit directive is the following:
  917. #
  918. # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
  919. #
  920. # A client is immediately disconnected once the hard limit is reached, or if
  921. # the soft limit is reached and remains reached for the specified number of
  922. # seconds (continuously).
  923. # So for instance if the hard limit is 32 megabytes and the soft limit is
  924. # 16 megabytes / 10 seconds, the client will get disconnected immediately
  925. # if the size of the output buffers reach 32 megabytes, but will also get
  926. # disconnected if the client reaches 16 megabytes and continuously overcomes
  927. # the limit for 10 seconds.
  928. #
  929. # By default normal clients are not limited because they don't receive data
  930. # without asking (in a push way), but just after a request, so only
  931. # asynchronous clients may create a scenario where data is requested faster
  932. # than it can read.
  933. #
  934. # Instead there is a default limit for pubsub and slave clients, since
  935. # subscribers and slaves receive data in a push fashion.
  936. #
  937. # Both the hard or the soft limit can be disabled by setting them to zero.
  938. client-output-buffer-limit normal 0 0 0
  939. client-output-buffer-limit slave 256mb 64mb 60
  940. client-output-buffer-limit pubsub 32mb 8mb 60
  941. # Redis calls an internal function to perform many background tasks, like
  942. # closing connections of clients in timeout, purging expired keys that are
  943. # never requested, and so forth.
  944. #
  945. # Not all tasks are performed with the same frequency, but Redis checks for
  946. # tasks to perform according to the specified "hz" value.
  947. #
  948. # By default "hz" is set to 10. Raising the value will use more CPU when
  949. # Redis is idle, but at the same time will make Redis more responsive when
  950. # there are many keys expiring at the same time, and timeouts may be
  951. # handled with more precision.
  952. #
  953. # The range is between 1 and 500, however a value over 100 is usually not
  954. # a good idea. Most users should use the default of 10 and raise this up to
  955. # 100 only in environments where very low latency is required.
  956. hz 10
  957. # When a child rewrites the AOF file, if the following option is enabled
  958. # the file will be fsync-ed every 32 MB of data generated. This is useful
  959. # in order to commit the file to the disk more incrementally and avoid
  960. # big latency spikes.
  961. aof-rewrite-incremental-fsync yes