redis.conf 81 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832
  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. ################################## MODULES #####################################
  35. # Load modules at startup. If the server is not able to load modules
  36. # it will abort. It is possible to use multiple loadmodule directives.
  37. #
  38. # loadmodule /path/to/my_module.so
  39. # loadmodule /path/to/other_module.so
  40. ################################## NETWORK #####################################
  41. # By default, if no "bind" configuration directive is specified, Redis listens
  42. # for connections from all the network interfaces available on the server.
  43. # It is possible to listen to just one or multiple selected interfaces using
  44. # the "bind" configuration directive, followed by one or more IP addresses.
  45. #
  46. # Examples:
  47. #
  48. # bind 192.168.1.100 10.0.0.1
  49. # bind 127.0.0.1 ::1
  50. #
  51. # ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the
  52. # internet, binding to all the interfaces is dangerous and will expose the
  53. # instance to everybody on the internet. So by default we uncomment the
  54. # following bind directive, that will force Redis to listen only into
  55. # the IPv4 loopback interface address (this means Redis will be able to
  56. # accept connections only from clients running into the same computer it
  57. # is running).
  58. #
  59. # IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES
  60. # JUST COMMENT THE FOLLOWING LINE.
  61. # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  62. bind 127.0.0.1
  63. # Protected mode is a layer of security protection, in order to avoid that
  64. # Redis instances left open on the internet are accessed and exploited.
  65. #
  66. # When protected mode is on and if:
  67. #
  68. # 1) The server is not binding explicitly to a set of addresses using the
  69. # "bind" directive.
  70. # 2) No password is configured.
  71. #
  72. # The server only accepts connections from clients connecting from the
  73. # IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain
  74. # sockets.
  75. #
  76. # By default protected mode is enabled. You should disable it only if
  77. # you are sure you want clients from other hosts to connect to Redis
  78. # even if no authentication is configured, nor a specific set of interfaces
  79. # are explicitly listed using the "bind" directive.
  80. protected-mode yes
  81. # Accept connections on the specified port, default is 6379 (IANA #815344).
  82. # If port 0 is specified Redis will not listen on a TCP socket.
  83. port 6379
  84. # TCP listen() backlog.
  85. #
  86. # In high requests-per-second environments you need an high backlog in order
  87. # to avoid slow clients connections issues. Note that the Linux kernel
  88. # will silently truncate it to the value of /proc/sys/net/core/somaxconn so
  89. # make sure to raise both the value of somaxconn and tcp_max_syn_backlog
  90. # in order to get the desired effect.
  91. tcp-backlog 511
  92. # Unix socket.
  93. #
  94. # Specify the path for the Unix socket that will be used to listen for
  95. # incoming connections. There is no default, so Redis will not listen
  96. # on a unix socket when not specified.
  97. #
  98. # unixsocket /tmp/redis.sock
  99. # unixsocketperm 700
  100. # Close the connection after a client is idle for N seconds (0 to disable)
  101. timeout 0
  102. # TCP keepalive.
  103. #
  104. # If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
  105. # of communication. This is useful for two reasons:
  106. #
  107. # 1) Detect dead peers.
  108. # 2) Take the connection alive from the point of view of network
  109. # equipment in the middle.
  110. #
  111. # On Linux, the specified value (in seconds) is the period used to send ACKs.
  112. # Note that to close the connection the double of the time is needed.
  113. # On other kernels the period depends on the kernel configuration.
  114. #
  115. # A reasonable value for this option is 300 seconds, which is the new
  116. # Redis default starting with Redis 3.2.1.
  117. tcp-keepalive 300
  118. ################################# TLS/SSL #####################################
  119. # By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration
  120. # directive can be used to define TLS-listening ports. To enable TLS on the
  121. # default port, use:
  122. #
  123. # port 0
  124. # tls-port 6379
  125. # Configure a X.509 certificate and private key to use for authenticating the
  126. # server to connected clients, masters or cluster peers. These files should be
  127. # PEM formatted.
  128. #
  129. # tls-cert-file redis.crt
  130. # tls-key-file redis.key
  131. # Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange:
  132. #
  133. # tls-dh-params-file redis.dh
  134. # Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL
  135. # clients and peers. Redis requires an explicit configuration of at least one
  136. # of these, and will not implicitly use the system wide configuration.
  137. #
  138. # tls-ca-cert-file ca.crt
  139. # tls-ca-cert-dir /etc/ssl/certs
  140. # By default, clients (including replica servers) on a TLS port are required
  141. # to authenticate using valid client side certificates.
  142. #
  143. # It is possible to disable authentication using this directive.
  144. #
  145. # tls-auth-clients no
  146. # By default, a Redis replica does not attempt to establish a TLS connection
  147. # with its master.
  148. #
  149. # Use the following directive to enable TLS on replication links.
  150. #
  151. # tls-replication yes
  152. # By default, the Redis Cluster bus uses a plain TCP connection. To enable
  153. # TLS for the bus protocol, use the following directive:
  154. #
  155. # tls-cluster yes
  156. # Explicitly specify TLS versions to support. Allowed values are case insensitive
  157. # and include "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3" (OpenSSL >= 1.1.1) or
  158. # any combination. To enable only TLSv1.2 and TLSv1.3, use:
  159. #
  160. # tls-protocols "TLSv1.2 TLSv1.3"
  161. # Configure allowed ciphers. See the ciphers(1ssl) manpage for more information
  162. # about the syntax of this string.
  163. #
  164. # Note: this configuration applies only to <= TLSv1.2.
  165. #
  166. # tls-ciphers DEFAULT:!MEDIUM
  167. # Configure allowed TLSv1.3 ciphersuites. See the ciphers(1ssl) manpage for more
  168. # information about the syntax of this string, and specifically for TLSv1.3
  169. # ciphersuites.
  170. #
  171. # tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256
  172. # When choosing a cipher, use the server's preference instead of the client
  173. # preference. By default, the server follows the client's preference.
  174. #
  175. # tls-prefer-server-ciphers yes
  176. # By default, TLS session caching is enabled to allow faster and less expensive
  177. # reconnections by clients that support it. Use the following directive to disable
  178. # caching.
  179. #
  180. # tls-session-caching no
  181. # Change the default number of TLS sessions cached. A zero value sets the cache
  182. # to unlimited size. The default size is 20480.
  183. #
  184. # tls-session-cache-size 5000
  185. # Change the default timeout of cached TLS sessions. The default timeout is 300
  186. # seconds.
  187. #
  188. # tls-session-cache-timeout 60
  189. ################################# GENERAL #####################################
  190. # By default Redis does not run as a daemon. Use 'yes' if you need it.
  191. # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
  192. daemonize no
  193. # If you run Redis from upstart or systemd, Redis can interact with your
  194. # supervision tree. Options:
  195. # supervised no - no supervision interaction
  196. # supervised upstart - signal upstart by putting Redis into SIGSTOP mode
  197. # supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET
  198. # supervised auto - detect upstart or systemd method based on
  199. # UPSTART_JOB or NOTIFY_SOCKET environment variables
  200. # Note: these supervision methods only signal "process is ready."
  201. # They do not enable continuous liveness pings back to your supervisor.
  202. supervised no
  203. # If a pid file is specified, Redis writes it where specified at startup
  204. # and removes it at exit.
  205. #
  206. # When the server runs non daemonized, no pid file is created if none is
  207. # specified in the configuration. When the server is daemonized, the pid file
  208. # is used even if not specified, defaulting to "/var/run/redis.pid".
  209. #
  210. # Creating a pid file is best effort: if Redis is not able to create it
  211. # nothing bad happens, the server will start and run normally.
  212. pidfile /var/run/redis_6379.pid
  213. # Specify the server verbosity level.
  214. # This can be one of:
  215. # debug (a lot of information, useful for development/testing)
  216. # verbose (many rarely useful info, but not a mess like the debug level)
  217. # notice (moderately verbose, what you want in production probably)
  218. # warning (only very important / critical messages are logged)
  219. loglevel notice
  220. # Specify the log file name. Also the empty string can be used to force
  221. # Redis to log on the standard output. Note that if you use standard
  222. # output for logging but daemonize, logs will be sent to /dev/null
  223. logfile ""
  224. # To enable logging to the system logger, just set 'syslog-enabled' to yes,
  225. # and optionally update the other syslog parameters to suit your needs.
  226. # syslog-enabled no
  227. # Specify the syslog identity.
  228. # syslog-ident redis
  229. # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
  230. # syslog-facility local0
  231. # Set the number of databases. The default database is DB 0, you can select
  232. # a different one on a per-connection basis using SELECT <dbid> where
  233. # dbid is a number between 0 and 'databases'-1
  234. databases 16
  235. # By default Redis shows an ASCII art logo only when started to log to the
  236. # standard output and if the standard output is a TTY. Basically this means
  237. # that normally a logo is displayed only in interactive sessions.
  238. #
  239. # However it is possible to force the pre-4.0 behavior and always show a
  240. # ASCII art logo in startup logs by setting the following option to yes.
  241. always-show-logo yes
  242. ################################ SNAPSHOTTING ################################
  243. #
  244. # Save the DB on disk:
  245. #
  246. # save <seconds> <changes>
  247. #
  248. # Will save the DB if both the given number of seconds and the given
  249. # number of write operations against the DB occurred.
  250. #
  251. # In the example below the behaviour will be to save:
  252. # after 900 sec (15 min) if at least 1 key changed
  253. # after 300 sec (5 min) if at least 10 keys changed
  254. # after 60 sec if at least 10000 keys changed
  255. #
  256. # Note: you can disable saving completely by commenting out all "save" lines.
  257. #
  258. # It is also possible to remove all the previously configured save
  259. # points by adding a save directive with a single empty string argument
  260. # like in the following example:
  261. #
  262. # save ""
  263. save 900 1
  264. save 300 10
  265. save 60 10000
  266. # By default Redis will stop accepting writes if RDB snapshots are enabled
  267. # (at least one save point) and the latest background save failed.
  268. # This will make the user aware (in a hard way) that data is not persisting
  269. # on disk properly, otherwise chances are that no one will notice and some
  270. # disaster will happen.
  271. #
  272. # If the background saving process will start working again Redis will
  273. # automatically allow writes again.
  274. #
  275. # However if you have setup your proper monitoring of the Redis server
  276. # and persistence, you may want to disable this feature so that Redis will
  277. # continue to work as usual even if there are problems with disk,
  278. # permissions, and so forth.
  279. stop-writes-on-bgsave-error yes
  280. # Compress string objects using LZF when dump .rdb databases?
  281. # For default that's set to 'yes' as it's almost always a win.
  282. # If you want to save some CPU in the saving child set it to 'no' but
  283. # the dataset will likely be bigger if you have compressible values or keys.
  284. rdbcompression yes
  285. # Since version 5 of RDB a CRC64 checksum is placed at the end of the file.
  286. # This makes the format more resistant to corruption but there is a performance
  287. # hit to pay (around 10%) when saving and loading RDB files, so you can disable it
  288. # for maximum performances.
  289. #
  290. # RDB files created with checksum disabled have a checksum of zero that will
  291. # tell the loading code to skip the check.
  292. rdbchecksum yes
  293. # The filename where to dump the DB
  294. dbfilename dump.rdb
  295. # Remove RDB files used by replication in instances without persistence
  296. # enabled. By default this option is disabled, however there are environments
  297. # where for regulations or other security concerns, RDB files persisted on
  298. # disk by masters in order to feed replicas, or stored on disk by replicas
  299. # in order to load them for the initial synchronization, should be deleted
  300. # ASAP. Note that this option ONLY WORKS in instances that have both AOF
  301. # and RDB persistence disabled, otherwise is completely ignored.
  302. #
  303. # An alternative (and sometimes better) way to obtain the same effect is
  304. # to use diskless replication on both master and replicas instances. However
  305. # in the case of replicas, diskless is not always an option.
  306. rdb-del-sync-files no
  307. # The working directory.
  308. #
  309. # The DB will be written inside this directory, with the filename specified
  310. # above using the 'dbfilename' configuration directive.
  311. #
  312. # The Append Only File will also be created inside this directory.
  313. #
  314. # Note that you must specify a directory here, not a file name.
  315. dir ./
  316. ################################# REPLICATION #################################
  317. # Master-Replica replication. Use replicaof to make a Redis instance a copy of
  318. # another Redis server. A few things to understand ASAP about Redis replication.
  319. #
  320. # +------------------+ +---------------+
  321. # | Master | ---> | Replica |
  322. # | (receive writes) | | (exact copy) |
  323. # +------------------+ +---------------+
  324. #
  325. # 1) Redis replication is asynchronous, but you can configure a master to
  326. # stop accepting writes if it appears to be not connected with at least
  327. # a given number of replicas.
  328. # 2) Redis replicas are able to perform a partial resynchronization with the
  329. # master if the replication link is lost for a relatively small amount of
  330. # time. You may want to configure the replication backlog size (see the next
  331. # sections of this file) with a sensible value depending on your needs.
  332. # 3) Replication is automatic and does not need user intervention. After a
  333. # network partition replicas automatically try to reconnect to masters
  334. # and resynchronize with them.
  335. #
  336. # replicaof <masterip> <masterport>
  337. # If the master is password protected (using the "requirepass" configuration
  338. # directive below) it is possible to tell the replica to authenticate before
  339. # starting the replication synchronization process, otherwise the master will
  340. # refuse the replica request.
  341. #
  342. # masterauth <master-password>
  343. #
  344. # However this is not enough if you are using Redis ACLs (for Redis version
  345. # 6 or greater), and the default user is not capable of running the PSYNC
  346. # command and/or other commands needed for replication. In this case it's
  347. # better to configure a special user to use with replication, and specify the
  348. # masteruser configuration as such:
  349. #
  350. # masteruser <username>
  351. #
  352. # When masteruser is specified, the replica will authenticate against its
  353. # master using the new AUTH form: AUTH <username> <password>.
  354. # When a replica loses its connection with the master, or when the replication
  355. # is still in progress, the replica can act in two different ways:
  356. #
  357. # 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will
  358. # still reply to client requests, possibly with out of date data, or the
  359. # data set may just be empty if this is the first synchronization.
  360. #
  361. # 2) if replica-serve-stale-data is set to 'no' the replica will reply with
  362. # an error "SYNC with master in progress" to all the kind of commands
  363. # but to INFO, replicaOF, AUTH, PING, SHUTDOWN, REPLCONF, ROLE, CONFIG,
  364. # SUBSCRIBE, UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB,
  365. # COMMAND, POST, HOST: and LATENCY.
  366. #
  367. replica-serve-stale-data yes
  368. # You can configure a replica instance to accept writes or not. Writing against
  369. # a replica instance may be useful to store some ephemeral data (because data
  370. # written on a replica will be easily deleted after resync with the master) but
  371. # may also cause problems if clients are writing to it because of a
  372. # misconfiguration.
  373. #
  374. # Since Redis 2.6 by default replicas are read-only.
  375. #
  376. # Note: read only replicas are not designed to be exposed to untrusted clients
  377. # on the internet. It's just a protection layer against misuse of the instance.
  378. # Still a read only replica exports by default all the administrative commands
  379. # such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
  380. # security of read only replicas using 'rename-command' to shadow all the
  381. # administrative / dangerous commands.
  382. replica-read-only yes
  383. # Replication SYNC strategy: disk or socket.
  384. #
  385. # New replicas and reconnecting replicas that are not able to continue the
  386. # replication process just receiving differences, need to do what is called a
  387. # "full synchronization". An RDB file is transmitted from the master to the
  388. # replicas.
  389. #
  390. # The transmission can happen in two different ways:
  391. #
  392. # 1) Disk-backed: The Redis master creates a new process that writes the RDB
  393. # file on disk. Later the file is transferred by the parent
  394. # process to the replicas incrementally.
  395. # 2) Diskless: The Redis master creates a new process that directly writes the
  396. # RDB file to replica sockets, without touching the disk at all.
  397. #
  398. # With disk-backed replication, while the RDB file is generated, more replicas
  399. # can be queued and served with the RDB file as soon as the current child
  400. # producing the RDB file finishes its work. With diskless replication instead
  401. # once the transfer starts, new replicas arriving will be queued and a new
  402. # transfer will start when the current one terminates.
  403. #
  404. # When diskless replication is used, the master waits a configurable amount of
  405. # time (in seconds) before starting the transfer in the hope that multiple
  406. # replicas will arrive and the transfer can be parallelized.
  407. #
  408. # With slow disks and fast (large bandwidth) networks, diskless replication
  409. # works better.
  410. repl-diskless-sync no
  411. # When diskless replication is enabled, it is possible to configure the delay
  412. # the server waits in order to spawn the child that transfers the RDB via socket
  413. # to the replicas.
  414. #
  415. # This is important since once the transfer starts, it is not possible to serve
  416. # new replicas arriving, that will be queued for the next RDB transfer, so the
  417. # server waits a delay in order to let more replicas arrive.
  418. #
  419. # The delay is specified in seconds, and by default is 5 seconds. To disable
  420. # it entirely just set it to 0 seconds and the transfer will start ASAP.
  421. repl-diskless-sync-delay 5
  422. # -----------------------------------------------------------------------------
  423. # WARNING: RDB diskless load is experimental. Since in this setup the replica
  424. # does not immediately store an RDB on disk, it may cause data loss during
  425. # failovers. RDB diskless load + Redis modules not handling I/O reads may also
  426. # cause Redis to abort in case of I/O errors during the initial synchronization
  427. # stage with the master. Use only if your do what you are doing.
  428. # -----------------------------------------------------------------------------
  429. #
  430. # Replica can load the RDB it reads from the replication link directly from the
  431. # socket, or store the RDB to a file and read that file after it was completely
  432. # recived from the master.
  433. #
  434. # In many cases the disk is slower than the network, and storing and loading
  435. # the RDB file may increase replication time (and even increase the master's
  436. # Copy on Write memory and salve buffers).
  437. # However, parsing the RDB file directly from the socket may mean that we have
  438. # to flush the contents of the current database before the full rdb was
  439. # received. For this reason we have the following options:
  440. #
  441. # "disabled" - Don't use diskless load (store the rdb file to the disk first)
  442. # "on-empty-db" - Use diskless load only when it is completely safe.
  443. # "swapdb" - Keep a copy of the current db contents in RAM while parsing
  444. # the data directly from the socket. note that this requires
  445. # sufficient memory, if you don't have it, you risk an OOM kill.
  446. repl-diskless-load disabled
  447. # Replicas send PINGs to server in a predefined interval. It's possible to
  448. # change this interval with the repl_ping_replica_period option. The default
  449. # value is 10 seconds.
  450. #
  451. # repl-ping-replica-period 10
  452. # The following option sets the replication timeout for:
  453. #
  454. # 1) Bulk transfer I/O during SYNC, from the point of view of replica.
  455. # 2) Master timeout from the point of view of replicas (data, pings).
  456. # 3) Replica timeout from the point of view of masters (REPLCONF ACK pings).
  457. #
  458. # It is important to make sure that this value is greater than the value
  459. # specified for repl-ping-replica-period otherwise a timeout will be detected
  460. # every time there is low traffic between the master and the replica.
  461. #
  462. # repl-timeout 60
  463. # Disable TCP_NODELAY on the replica socket after SYNC?
  464. #
  465. # If you select "yes" Redis will use a smaller number of TCP packets and
  466. # less bandwidth to send data to replicas. But this can add a delay for
  467. # the data to appear on the replica side, up to 40 milliseconds with
  468. # Linux kernels using a default configuration.
  469. #
  470. # If you select "no" the delay for data to appear on the replica side will
  471. # be reduced but more bandwidth will be used for replication.
  472. #
  473. # By default we optimize for low latency, but in very high traffic conditions
  474. # or when the master and replicas are many hops away, turning this to "yes" may
  475. # be a good idea.
  476. repl-disable-tcp-nodelay no
  477. # Set the replication backlog size. The backlog is a buffer that accumulates
  478. # replica data when replicas are disconnected for some time, so that when a
  479. # replica wants to reconnect again, often a full resync is not needed, but a
  480. # partial resync is enough, just passing the portion of data the replica
  481. # missed while disconnected.
  482. #
  483. # The bigger the replication backlog, the longer the time the replica can be
  484. # disconnected and later be able to perform a partial resynchronization.
  485. #
  486. # The backlog is only allocated once there is at least a replica connected.
  487. #
  488. # repl-backlog-size 1mb
  489. # After a master has no longer connected replicas for some time, the backlog
  490. # will be freed. The following option configures the amount of seconds that
  491. # need to elapse, starting from the time the last replica disconnected, for
  492. # the backlog buffer to be freed.
  493. #
  494. # Note that replicas never free the backlog for timeout, since they may be
  495. # promoted to masters later, and should be able to correctly "partially
  496. # resynchronize" with the replicas: hence they should always accumulate backlog.
  497. #
  498. # A value of 0 means to never release the backlog.
  499. #
  500. # repl-backlog-ttl 3600
  501. # The replica priority is an integer number published by Redis in the INFO
  502. # output. It is used by Redis Sentinel in order to select a replica to promote
  503. # into a master if the master is no longer working correctly.
  504. #
  505. # A replica with a low priority number is considered better for promotion, so
  506. # for instance if there are three replicas with priority 10, 100, 25 Sentinel
  507. # will pick the one with priority 10, that is the lowest.
  508. #
  509. # However a special priority of 0 marks the replica as not able to perform the
  510. # role of master, so a replica with priority of 0 will never be selected by
  511. # Redis Sentinel for promotion.
  512. #
  513. # By default the priority is 100.
  514. replica-priority 100
  515. # It is possible for a master to stop accepting writes if there are less than
  516. # N replicas connected, having a lag less or equal than M seconds.
  517. #
  518. # The N replicas need to be in "online" state.
  519. #
  520. # The lag in seconds, that must be <= the specified value, is calculated from
  521. # the last ping received from the replica, that is usually sent every second.
  522. #
  523. # This option does not GUARANTEE that N replicas will accept the write, but
  524. # will limit the window of exposure for lost writes in case not enough replicas
  525. # are available, to the specified number of seconds.
  526. #
  527. # For example to require at least 3 replicas with a lag <= 10 seconds use:
  528. #
  529. # min-replicas-to-write 3
  530. # min-replicas-max-lag 10
  531. #
  532. # Setting one or the other to 0 disables the feature.
  533. #
  534. # By default min-replicas-to-write is set to 0 (feature disabled) and
  535. # min-replicas-max-lag is set to 10.
  536. # A Redis master is able to list the address and port of the attached
  537. # replicas in different ways. For example the "INFO replication" section
  538. # offers this information, which is used, among other tools, by
  539. # Redis Sentinel in order to discover replica instances.
  540. # Another place where this info is available is in the output of the
  541. # "ROLE" command of a master.
  542. #
  543. # The listed IP and address normally reported by a replica is obtained
  544. # in the following way:
  545. #
  546. # IP: The address is auto detected by checking the peer address
  547. # of the socket used by the replica to connect with the master.
  548. #
  549. # Port: The port is communicated by the replica during the replication
  550. # handshake, and is normally the port that the replica is using to
  551. # listen for connections.
  552. #
  553. # However when port forwarding or Network Address Translation (NAT) is
  554. # used, the replica may be actually reachable via different IP and port
  555. # pairs. The following two options can be used by a replica in order to
  556. # report to its master a specific set of IP and port, so that both INFO
  557. # and ROLE will report those values.
  558. #
  559. # There is no need to use both the options if you need to override just
  560. # the port or the IP address.
  561. #
  562. # replica-announce-ip 5.5.5.5
  563. # replica-announce-port 1234
  564. ############################### KEYS TRACKING #################################
  565. # Redis implements server assisted support for client side caching of values.
  566. # This is implemented using an invalidation table that remembers, using
  567. # 16 millions of slots, what clients may have certain subsets of keys. In turn
  568. # this is used in order to send invalidation messages to clients. Please
  569. # to understand more about the feature check this page:
  570. #
  571. # https://redis.io/topics/client-side-caching
  572. #
  573. # When tracking is enabled for a client, all the read only queries are assumed
  574. # to be cached: this will force Redis to store information in the invalidation
  575. # table. When keys are modified, such information is flushed away, and
  576. # invalidation messages are sent to the clients. However if the workload is
  577. # heavily dominated by reads, Redis could use more and more memory in order
  578. # to track the keys fetched by many clients.
  579. #
  580. # For this reason it is possible to configure a maximum fill value for the
  581. # invalidation table. By default it is set to 1M of keys, and once this limit
  582. # is reached, Redis will start to evict keys in the invalidation table
  583. # even if they were not modified, just to reclaim memory: this will in turn
  584. # force the clients to invalidate the cached values. Basically the table
  585. # maximum size is a trade off between the memory you want to spend server
  586. # side to track information about who cached what, and the ability of clients
  587. # to retain cached objects in memory.
  588. #
  589. # If you set the value to 0, it means there are no limits, and Redis will
  590. # retain as many keys as needed in the invalidation table.
  591. # In the "stats" INFO section, you can find information about the number of
  592. # keys in the invalidation table at every given moment.
  593. #
  594. # Note: when key tracking is used in broadcasting mode, no memory is used
  595. # in the server side so this setting is useless.
  596. #
  597. # tracking-table-max-keys 1000000
  598. ################################## SECURITY ###################################
  599. # Warning: since Redis is pretty fast an outside user can try up to
  600. # 1 million passwords per second against a modern box. This means that you
  601. # should use very strong passwords, otherwise they will be very easy to break.
  602. # Note that because the password is really a shared secret between the client
  603. # and the server, and should not be memorized by any human, the password
  604. # can be easily a long string from /dev/urandom or whatever, so by using a
  605. # long and unguessable password no brute force attack will be possible.
  606. # Redis ACL users are defined in the following format:
  607. #
  608. # user <username> ... acl rules ...
  609. #
  610. # For example:
  611. #
  612. # user worker +@list +@connection ~jobs:* on >ffa9203c493aa99
  613. #
  614. # The special username "default" is used for new connections. If this user
  615. # has the "nopass" rule, then new connections will be immediately authenticated
  616. # as the "default" user without the need of any password provided via the
  617. # AUTH command. Otherwise if the "default" user is not flagged with "nopass"
  618. # the connections will start in not authenticated state, and will require
  619. # AUTH (or the HELLO command AUTH option) in order to be authenticated and
  620. # start to work.
  621. #
  622. # The ACL rules that describe what an user can do are the following:
  623. #
  624. # on Enable the user: it is possible to authenticate as this user.
  625. # off Disable the user: it's no longer possible to authenticate
  626. # with this user, however the already authenticated connections
  627. # will still work.
  628. # +<command> Allow the execution of that command
  629. # -<command> Disallow the execution of that command
  630. # +@<category> Allow the execution of all the commands in such category
  631. # with valid categories are like @admin, @set, @sortedset, ...
  632. # and so forth, see the full list in the server.c file where
  633. # the Redis command table is described and defined.
  634. # The special category @all means all the commands, but currently
  635. # present in the server, and that will be loaded in the future
  636. # via modules.
  637. # +<command>|subcommand Allow a specific subcommand of an otherwise
  638. # disabled command. Note that this form is not
  639. # allowed as negative like -DEBUG|SEGFAULT, but
  640. # only additive starting with "+".
  641. # allcommands Alias for +@all. Note that it implies the ability to execute
  642. # all the future commands loaded via the modules system.
  643. # nocommands Alias for -@all.
  644. # ~<pattern> Add a pattern of keys that can be mentioned as part of
  645. # commands. For instance ~* allows all the keys. The pattern
  646. # is a glob-style pattern like the one of KEYS.
  647. # It is possible to specify multiple patterns.
  648. # allkeys Alias for ~*
  649. # resetkeys Flush the list of allowed keys patterns.
  650. # ><password> Add this passowrd to the list of valid password for the user.
  651. # For example >mypass will add "mypass" to the list.
  652. # This directive clears the "nopass" flag (see later).
  653. # <<password> Remove this password from the list of valid passwords.
  654. # nopass All the set passwords of the user are removed, and the user
  655. # is flagged as requiring no password: it means that every
  656. # password will work against this user. If this directive is
  657. # used for the default user, every new connection will be
  658. # immediately authenticated with the default user without
  659. # any explicit AUTH command required. Note that the "resetpass"
  660. # directive will clear this condition.
  661. # resetpass Flush the list of allowed passwords. Moreover removes the
  662. # "nopass" status. After "resetpass" the user has no associated
  663. # passwords and there is no way to authenticate without adding
  664. # some password (or setting it as "nopass" later).
  665. # reset Performs the following actions: resetpass, resetkeys, off,
  666. # -@all. The user returns to the same state it has immediately
  667. # after its creation.
  668. #
  669. # ACL rules can be specified in any order: for instance you can start with
  670. # passwords, then flags, or key patterns. However note that the additive
  671. # and subtractive rules will CHANGE MEANING depending on the ordering.
  672. # For instance see the following example:
  673. #
  674. # user alice on +@all -DEBUG ~* >somepassword
  675. #
  676. # This will allow "alice" to use all the commands with the exception of the
  677. # DEBUG command, since +@all added all the commands to the set of the commands
  678. # alice can use, and later DEBUG was removed. However if we invert the order
  679. # of two ACL rules the result will be different:
  680. #
  681. # user alice on -DEBUG +@all ~* >somepassword
  682. #
  683. # Now DEBUG was removed when alice had yet no commands in the set of allowed
  684. # commands, later all the commands are added, so the user will be able to
  685. # execute everything.
  686. #
  687. # Basically ACL rules are processed left-to-right.
  688. #
  689. # For more information about ACL configuration please refer to
  690. # the Redis web site at https://redis.io/topics/acl
  691. # ACL LOG
  692. #
  693. # The ACL Log tracks failed commands and authentication events associated
  694. # with ACLs. The ACL Log is useful to troubleshoot failed commands blocked
  695. # by ACLs. The ACL Log is stored in memory. You can reclaim memory with
  696. # ACL LOG RESET. Define the maximum entry length of the ACL Log below.
  697. acllog-max-len 128
  698. # Using an external ACL file
  699. #
  700. # Instead of configuring users here in this file, it is possible to use
  701. # a stand-alone file just listing users. The two methods cannot be mixed:
  702. # if you configure users here and at the same time you activate the exteranl
  703. # ACL file, the server will refuse to start.
  704. #
  705. # The format of the external ACL user file is exactly the same as the
  706. # format that is used inside redis.conf to describe users.
  707. #
  708. # aclfile /etc/redis/users.acl
  709. # IMPORTANT NOTE: starting with Redis 6 "requirepass" is just a compatiblity
  710. # layer on top of the new ACL system. The option effect will be just setting
  711. # the password for the default user. Clients will still authenticate using
  712. # AUTH <password> as usually, or more explicitly with AUTH default <password>
  713. # if they follow the new protocol: both will work.
  714. #
  715. # requirepass foobared
  716. # Command renaming (DEPRECATED).
  717. #
  718. # ------------------------------------------------------------------------
  719. # WARNING: avoid using this option if possible. Instead use ACLs to remove
  720. # commands from the default user, and put them only in some admin user you
  721. # create for administrative purposes.
  722. # ------------------------------------------------------------------------
  723. #
  724. # It is possible to change the name of dangerous commands in a shared
  725. # environment. For instance the CONFIG command may be renamed into something
  726. # hard to guess so that it will still be available for internal-use tools
  727. # but not available for general clients.
  728. #
  729. # Example:
  730. #
  731. # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
  732. #
  733. # It is also possible to completely kill a command by renaming it into
  734. # an empty string:
  735. #
  736. # rename-command CONFIG ""
  737. #
  738. # Please note that changing the name of commands that are logged into the
  739. # AOF file or transmitted to replicas may cause problems.
  740. ################################### CLIENTS ####################################
  741. # Set the max number of connected clients at the same time. By default
  742. # this limit is set to 10000 clients, however if the Redis server is not
  743. # able to configure the process file limit to allow for the specified limit
  744. # the max number of allowed clients is set to the current file limit
  745. # minus 32 (as Redis reserves a few file descriptors for internal uses).
  746. #
  747. # Once the limit is reached Redis will close all the new connections sending
  748. # an error 'max number of clients reached'.
  749. #
  750. # IMPORTANT: When Redis Cluster is used, the max number of connections is also
  751. # shared with the cluster bus: every node in the cluster will use two
  752. # connections, one incoming and another outgoing. It is important to size the
  753. # limit accordingly in case of very large clusters.
  754. #
  755. # maxclients 10000
  756. ############################## MEMORY MANAGEMENT ################################
  757. # Set a memory usage limit to the specified amount of bytes.
  758. # When the memory limit is reached Redis will try to remove keys
  759. # according to the eviction policy selected (see maxmemory-policy).
  760. #
  761. # If Redis can't remove keys according to the policy, or if the policy is
  762. # set to 'noeviction', Redis will start to reply with errors to commands
  763. # that would use more memory, like SET, LPUSH, and so on, and will continue
  764. # to reply to read-only commands like GET.
  765. #
  766. # This option is usually useful when using Redis as an LRU or LFU cache, or to
  767. # set a hard memory limit for an instance (using the 'noeviction' policy).
  768. #
  769. # WARNING: If you have replicas attached to an instance with maxmemory on,
  770. # the size of the output buffers needed to feed the replicas are subtracted
  771. # from the used memory count, so that network problems / resyncs will
  772. # not trigger a loop where keys are evicted, and in turn the output
  773. # buffer of replicas is full with DELs of keys evicted triggering the deletion
  774. # of more keys, and so forth until the database is completely emptied.
  775. #
  776. # In short... if you have replicas attached it is suggested that you set a lower
  777. # limit for maxmemory so that there is some free RAM on the system for replica
  778. # output buffers (but this is not needed if the policy is 'noeviction').
  779. #
  780. # maxmemory <bytes>
  781. # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
  782. # is reached. You can select one from the following behaviors:
  783. #
  784. # volatile-lru -> Evict using approximated LRU, only keys with an expire set.
  785. # allkeys-lru -> Evict any key using approximated LRU.
  786. # volatile-lfu -> Evict using approximated LFU, only keys with an expire set.
  787. # allkeys-lfu -> Evict any key using approximated LFU.
  788. # volatile-random -> Remove a random key having an expire set.
  789. # allkeys-random -> Remove a random key, any key.
  790. # volatile-ttl -> Remove the key with the nearest expire time (minor TTL)
  791. # noeviction -> Don't evict anything, just return an error on write operations.
  792. #
  793. # LRU means Least Recently Used
  794. # LFU means Least Frequently Used
  795. #
  796. # Both LRU, LFU and volatile-ttl are implemented using approximated
  797. # randomized algorithms.
  798. #
  799. # Note: with any of the above policies, Redis will return an error on write
  800. # operations, when there are no suitable keys for eviction.
  801. #
  802. # At the date of writing these commands are: set setnx setex append
  803. # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
  804. # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
  805. # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
  806. # getset mset msetnx exec sort
  807. #
  808. # The default is:
  809. #
  810. # maxmemory-policy noeviction
  811. # LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated
  812. # algorithms (in order to save memory), so you can tune it for speed or
  813. # accuracy. For default Redis will check five keys and pick the one that was
  814. # used less recently, you can change the sample size using the following
  815. # configuration directive.
  816. #
  817. # The default of 5 produces good enough results. 10 Approximates very closely
  818. # true LRU but costs more CPU. 3 is faster but not very accurate.
  819. #
  820. # maxmemory-samples 5
  821. # Starting from Redis 5, by default a replica will ignore its maxmemory setting
  822. # (unless it is promoted to master after a failover or manually). It means
  823. # that the eviction of keys will be just handled by the master, sending the
  824. # DEL commands to the replica as keys evict in the master side.
  825. #
  826. # This behavior ensures that masters and replicas stay consistent, and is usually
  827. # what you want, however if your replica is writable, or you want the replica
  828. # to have a different memory setting, and you are sure all the writes performed
  829. # to the replica are idempotent, then you may change this default (but be sure
  830. # to understand what you are doing).
  831. #
  832. # Note that since the replica by default does not evict, it may end using more
  833. # memory than the one set via maxmemory (there are certain buffers that may
  834. # be larger on the replica, or data structures may sometimes take more memory
  835. # and so forth). So make sure you monitor your replicas and make sure they
  836. # have enough memory to never hit a real out-of-memory condition before the
  837. # master hits the configured maxmemory setting.
  838. #
  839. # replica-ignore-maxmemory yes
  840. # Redis reclaims expired keys in two ways: upon access when those keys are
  841. # found to be expired, and also in background, in what is called the
  842. # "active expire key". The key space is slowly and interactively scanned
  843. # looking for expired keys to reclaim, so that it is possible to free memory
  844. # of keys that are expired and will never be accessed again in a short time.
  845. #
  846. # The default effort of the expire cycle will try to avoid having more than
  847. # ten percent of expired keys still in memory, and will try to avoid consuming
  848. # more than 25% of total memory and to add latency to the system. However
  849. # it is possible to increase the expire "effort" that is normally set to
  850. # "1", to a greater value, up to the value "10". At its maximum value the
  851. # system will use more CPU, longer cycles (and technically may introduce
  852. # more latency), and will tollerate less already expired keys still present
  853. # in the system. It's a tradeoff betweeen memory, CPU and latecy.
  854. #
  855. # active-expire-effort 1
  856. ############################# LAZY FREEING ####################################
  857. # Redis has two primitives to delete keys. One is called DEL and is a blocking
  858. # deletion of the object. It means that the server stops processing new commands
  859. # in order to reclaim all the memory associated with an object in a synchronous
  860. # way. If the key deleted is associated with a small object, the time needed
  861. # in order to execute the DEL command is very small and comparable to most other
  862. # O(1) or O(log_N) commands in Redis. However if the key is associated with an
  863. # aggregated value containing millions of elements, the server can block for
  864. # a long time (even seconds) in order to complete the operation.
  865. #
  866. # For the above reasons Redis also offers non blocking deletion primitives
  867. # such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and
  868. # FLUSHDB commands, in order to reclaim memory in background. Those commands
  869. # are executed in constant time. Another thread will incrementally free the
  870. # object in the background as fast as possible.
  871. #
  872. # DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled.
  873. # It's up to the design of the application to understand when it is a good
  874. # idea to use one or the other. However the Redis server sometimes has to
  875. # delete keys or flush the whole database as a side effect of other operations.
  876. # Specifically Redis deletes objects independently of a user call in the
  877. # following scenarios:
  878. #
  879. # 1) On eviction, because of the maxmemory and maxmemory policy configurations,
  880. # in order to make room for new data, without going over the specified
  881. # memory limit.
  882. # 2) Because of expire: when a key with an associated time to live (see the
  883. # EXPIRE command) must be deleted from memory.
  884. # 3) Because of a side effect of a command that stores data on a key that may
  885. # already exist. For example the RENAME command may delete the old key
  886. # content when it is replaced with another one. Similarly SUNIONSTORE
  887. # or SORT with STORE option may delete existing keys. The SET command
  888. # itself removes any old content of the specified key in order to replace
  889. # it with the specified string.
  890. # 4) During replication, when a replica performs a full resynchronization with
  891. # its master, the content of the whole database is removed in order to
  892. # load the RDB file just transferred.
  893. #
  894. # In all the above cases the default is to delete objects in a blocking way,
  895. # like if DEL was called. However you can configure each case specifically
  896. # in order to instead release memory in a non-blocking way like if UNLINK
  897. # was called, using the following configuration directives.
  898. lazyfree-lazy-eviction no
  899. lazyfree-lazy-expire no
  900. lazyfree-lazy-server-del no
  901. replica-lazy-flush no
  902. # It is also possible, for the case when to replace the user code DEL calls
  903. # with UNLINK calls is not easy, to modify the default behavior of the DEL
  904. # command to act exactly like UNLINK, using the following configuration
  905. # directive:
  906. lazyfree-lazy-user-del no
  907. ################################ THREADED I/O #################################
  908. # Redis is mostly single threaded, however there are certain threaded
  909. # operations such as UNLINK, slow I/O accesses and other things that are
  910. # performed on side threads.
  911. #
  912. # Now it is also possible to handle Redis clients socket reads and writes
  913. # in different I/O threads. Since especially writing is so slow, normally
  914. # Redis users use pipelining in order to speedup the Redis performances per
  915. # core, and spawn multiple instances in order to scale more. Using I/O
  916. # threads it is possible to easily speedup two times Redis without resorting
  917. # to pipelining nor sharding of the instance.
  918. #
  919. # By default threading is disabled, we suggest enabling it only in machines
  920. # that have at least 4 or more cores, leaving at least one spare core.
  921. # Using more than 8 threads is unlikely to help much. We also recommend using
  922. # threaded I/O only if you actually have performance problems, with Redis
  923. # instances being able to use a quite big percentage of CPU time, otherwise
  924. # there is no point in using this feature.
  925. #
  926. # So for instance if you have a four cores boxes, try to use 2 or 3 I/O
  927. # threads, if you have a 8 cores, try to use 6 threads. In order to
  928. # enable I/O threads use the following configuration directive:
  929. #
  930. # io-threads 4
  931. #
  932. # Setting io-threads to 1 will just use the main thread as usually.
  933. # When I/O threads are enabled, we only use threads for writes, that is
  934. # to thread the write(2) syscall and transfer the client buffers to the
  935. # socket. However it is also possible to enable threading of reads and
  936. # protocol parsing using the following configuration directive, by setting
  937. # it to yes:
  938. #
  939. # io-threads-do-reads no
  940. #
  941. # Usually threading reads doesn't help much.
  942. #
  943. # NOTE 1: This configuration directive cannot be changed at runtime via
  944. # CONFIG SET. Aso this feature currently does not work when SSL is
  945. # enabled.
  946. #
  947. # NOTE 2: If you want to test the Redis speedup using redis-benchmark, make
  948. # sure you also run the benchmark itself in threaded mode, using the
  949. # --threads option to match the number of Redis theads, otherwise you'll not
  950. # be able to notice the improvements.
  951. ############################## APPEND ONLY MODE ###############################
  952. # By default Redis asynchronously dumps the dataset on disk. This mode is
  953. # good enough in many applications, but an issue with the Redis process or
  954. # a power outage may result into a few minutes of writes lost (depending on
  955. # the configured save points).
  956. #
  957. # The Append Only File is an alternative persistence mode that provides
  958. # much better durability. For instance using the default data fsync policy
  959. # (see later in the config file) Redis can lose just one second of writes in a
  960. # dramatic event like a server power outage, or a single write if something
  961. # wrong with the Redis process itself happens, but the operating system is
  962. # still running correctly.
  963. #
  964. # AOF and RDB persistence can be enabled at the same time without problems.
  965. # If the AOF is enabled on startup Redis will load the AOF, that is the file
  966. # with the better durability guarantees.
  967. #
  968. # Please check http://redis.io/topics/persistence for more information.
  969. appendonly no
  970. # The name of the append only file (default: "appendonly.aof")
  971. appendfilename "appendonly.aof"
  972. # The fsync() call tells the Operating System to actually write data on disk
  973. # instead of waiting for more data in the output buffer. Some OS will really flush
  974. # data on disk, some other OS will just try to do it ASAP.
  975. #
  976. # Redis supports three different modes:
  977. #
  978. # no: don't fsync, just let the OS flush the data when it wants. Faster.
  979. # always: fsync after every write to the append only log. Slow, Safest.
  980. # everysec: fsync only one time every second. Compromise.
  981. #
  982. # The default is "everysec", as that's usually the right compromise between
  983. # speed and data safety. It's up to you to understand if you can relax this to
  984. # "no" that will let the operating system flush the output buffer when
  985. # it wants, for better performances (but if you can live with the idea of
  986. # some data loss consider the default persistence mode that's snapshotting),
  987. # or on the contrary, use "always" that's very slow but a bit safer than
  988. # everysec.
  989. #
  990. # More details please check the following article:
  991. # http://antirez.com/post/redis-persistence-demystified.html
  992. #
  993. # If unsure, use "everysec".
  994. # appendfsync always
  995. appendfsync everysec
  996. # appendfsync no
  997. # When the AOF fsync policy is set to always or everysec, and a background
  998. # saving process (a background save or AOF log background rewriting) is
  999. # performing a lot of I/O against the disk, in some Linux configurations
  1000. # Redis may block too long on the fsync() call. Note that there is no fix for
  1001. # this currently, as even performing fsync in a different thread will block
  1002. # our synchronous write(2) call.
  1003. #
  1004. # In order to mitigate this problem it's possible to use the following option
  1005. # that will prevent fsync() from being called in the main process while a
  1006. # BGSAVE or BGREWRITEAOF is in progress.
  1007. #
  1008. # This means that while another child is saving, the durability of Redis is
  1009. # the same as "appendfsync none". In practical terms, this means that it is
  1010. # possible to lose up to 30 seconds of log in the worst scenario (with the
  1011. # default Linux settings).
  1012. #
  1013. # If you have latency problems turn this to "yes". Otherwise leave it as
  1014. # "no" that is the safest pick from the point of view of durability.
  1015. no-appendfsync-on-rewrite no
  1016. # Automatic rewrite of the append only file.
  1017. # Redis is able to automatically rewrite the log file implicitly calling
  1018. # BGREWRITEAOF when the AOF log size grows by the specified percentage.
  1019. #
  1020. # This is how it works: Redis remembers the size of the AOF file after the
  1021. # latest rewrite (if no rewrite has happened since the restart, the size of
  1022. # the AOF at startup is used).
  1023. #
  1024. # This base size is compared to the current size. If the current size is
  1025. # bigger than the specified percentage, the rewrite is triggered. Also
  1026. # you need to specify a minimal size for the AOF file to be rewritten, this
  1027. # is useful to avoid rewriting the AOF file even if the percentage increase
  1028. # is reached but it is still pretty small.
  1029. #
  1030. # Specify a percentage of zero in order to disable the automatic AOF
  1031. # rewrite feature.
  1032. auto-aof-rewrite-percentage 100
  1033. auto-aof-rewrite-min-size 64mb
  1034. # An AOF file may be found to be truncated at the end during the Redis
  1035. # startup process, when the AOF data gets loaded back into memory.
  1036. # This may happen when the system where Redis is running
  1037. # crashes, especially when an ext4 filesystem is mounted without the
  1038. # data=ordered option (however this can't happen when Redis itself
  1039. # crashes or aborts but the operating system still works correctly).
  1040. #
  1041. # Redis can either exit with an error when this happens, or load as much
  1042. # data as possible (the default now) and start if the AOF file is found
  1043. # to be truncated at the end. The following option controls this behavior.
  1044. #
  1045. # If aof-load-truncated is set to yes, a truncated AOF file is loaded and
  1046. # the Redis server starts emitting a log to inform the user of the event.
  1047. # Otherwise if the option is set to no, the server aborts with an error
  1048. # and refuses to start. When the option is set to no, the user requires
  1049. # to fix the AOF file using the "redis-check-aof" utility before to restart
  1050. # the server.
  1051. #
  1052. # Note that if the AOF file will be found to be corrupted in the middle
  1053. # the server will still exit with an error. This option only applies when
  1054. # Redis will try to read more data from the AOF file but not enough bytes
  1055. # will be found.
  1056. aof-load-truncated yes
  1057. # When rewriting the AOF file, Redis is able to use an RDB preamble in the
  1058. # AOF file for faster rewrites and recoveries. When this option is turned
  1059. # on the rewritten AOF file is composed of two different stanzas:
  1060. #
  1061. # [RDB file][AOF tail]
  1062. #
  1063. # When loading Redis recognizes that the AOF file starts with the "REDIS"
  1064. # string and loads the prefixed RDB file, and continues loading the AOF
  1065. # tail.
  1066. aof-use-rdb-preamble yes
  1067. ################################ LUA SCRIPTING ###############################
  1068. # Max execution time of a Lua script in milliseconds.
  1069. #
  1070. # If the maximum execution time is reached Redis will log that a script is
  1071. # still in execution after the maximum allowed time and will start to
  1072. # reply to queries with an error.
  1073. #
  1074. # When a long running script exceeds the maximum execution time only the
  1075. # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
  1076. # used to stop a script that did not yet called write commands. The second
  1077. # is the only way to shut down the server in the case a write command was
  1078. # already issued by the script but the user doesn't want to wait for the natural
  1079. # termination of the script.
  1080. #
  1081. # Set it to 0 or a negative value for unlimited execution without warnings.
  1082. lua-time-limit 5000
  1083. ################################ REDIS CLUSTER ###############################
  1084. # Normal Redis instances can't be part of a Redis Cluster; only nodes that are
  1085. # started as cluster nodes can. In order to start a Redis instance as a
  1086. # cluster node enable the cluster support uncommenting the following:
  1087. #
  1088. # cluster-enabled yes
  1089. # Every cluster node has a cluster configuration file. This file is not
  1090. # intended to be edited by hand. It is created and updated by Redis nodes.
  1091. # Every Redis Cluster node requires a different cluster configuration file.
  1092. # Make sure that instances running in the same system do not have
  1093. # overlapping cluster configuration file names.
  1094. #
  1095. # cluster-config-file nodes-6379.conf
  1096. # Cluster node timeout is the amount of milliseconds a node must be unreachable
  1097. # for it to be considered in failure state.
  1098. # Most other internal time limits are multiple of the node timeout.
  1099. #
  1100. # cluster-node-timeout 15000
  1101. # A replica of a failing master will avoid to start a failover if its data
  1102. # looks too old.
  1103. #
  1104. # There is no simple way for a replica to actually have an exact measure of
  1105. # its "data age", so the following two checks are performed:
  1106. #
  1107. # 1) If there are multiple replicas able to failover, they exchange messages
  1108. # in order to try to give an advantage to the replica with the best
  1109. # replication offset (more data from the master processed).
  1110. # Replicas will try to get their rank by offset, and apply to the start
  1111. # of the failover a delay proportional to their rank.
  1112. #
  1113. # 2) Every single replica computes the time of the last interaction with
  1114. # its master. This can be the last ping or command received (if the master
  1115. # is still in the "connected" state), or the time that elapsed since the
  1116. # disconnection with the master (if the replication link is currently down).
  1117. # If the last interaction is too old, the replica will not try to failover
  1118. # at all.
  1119. #
  1120. # The point "2" can be tuned by user. Specifically a replica will not perform
  1121. # the failover if, since the last interaction with the master, the time
  1122. # elapsed is greater than:
  1123. #
  1124. # (node-timeout * replica-validity-factor) + repl-ping-replica-period
  1125. #
  1126. # So for example if node-timeout is 30 seconds, and the replica-validity-factor
  1127. # is 10, and assuming a default repl-ping-replica-period of 10 seconds, the
  1128. # replica will not try to failover if it was not able to talk with the master
  1129. # for longer than 310 seconds.
  1130. #
  1131. # A large replica-validity-factor may allow replicas with too old data to failover
  1132. # a master, while a too small value may prevent the cluster from being able to
  1133. # elect a replica at all.
  1134. #
  1135. # For maximum availability, it is possible to set the replica-validity-factor
  1136. # to a value of 0, which means, that replicas will always try to failover the
  1137. # master regardless of the last time they interacted with the master.
  1138. # (However they'll always try to apply a delay proportional to their
  1139. # offset rank).
  1140. #
  1141. # Zero is the only value able to guarantee that when all the partitions heal
  1142. # the cluster will always be able to continue.
  1143. #
  1144. # cluster-replica-validity-factor 10
  1145. # Cluster replicas are able to migrate to orphaned masters, that are masters
  1146. # that are left without working replicas. This improves the cluster ability
  1147. # to resist to failures as otherwise an orphaned master can't be failed over
  1148. # in case of failure if it has no working replicas.
  1149. #
  1150. # Replicas migrate to orphaned masters only if there are still at least a
  1151. # given number of other working replicas for their old master. This number
  1152. # is the "migration barrier". A migration barrier of 1 means that a replica
  1153. # will migrate only if there is at least 1 other working replica for its master
  1154. # and so forth. It usually reflects the number of replicas you want for every
  1155. # master in your cluster.
  1156. #
  1157. # Default is 1 (replicas migrate only if their masters remain with at least
  1158. # one replica). To disable migration just set it to a very large value.
  1159. # A value of 0 can be set but is useful only for debugging and dangerous
  1160. # in production.
  1161. #
  1162. # cluster-migration-barrier 1
  1163. # By default Redis Cluster nodes stop accepting queries if they detect there
  1164. # is at least an hash slot uncovered (no available node is serving it).
  1165. # This way if the cluster is partially down (for example a range of hash slots
  1166. # are no longer covered) all the cluster becomes, eventually, unavailable.
  1167. # It automatically returns available as soon as all the slots are covered again.
  1168. #
  1169. # However sometimes you want the subset of the cluster which is working,
  1170. # to continue to accept queries for the part of the key space that is still
  1171. # covered. In order to do so, just set the cluster-require-full-coverage
  1172. # option to no.
  1173. #
  1174. # cluster-require-full-coverage yes
  1175. # This option, when set to yes, prevents replicas from trying to failover its
  1176. # master during master failures. However the master can still perform a
  1177. # manual failover, if forced to do so.
  1178. #
  1179. # This is useful in different scenarios, especially in the case of multiple
  1180. # data center operations, where we want one side to never be promoted if not
  1181. # in the case of a total DC failure.
  1182. #
  1183. # cluster-replica-no-failover no
  1184. # This option, when set to yes, allows nodes to serve read traffic while the
  1185. # the cluster is in a down state, as long as it believes it owns the slots.
  1186. #
  1187. # This is useful for two cases. The first case is for when an application
  1188. # doesn't require consistency of data during node failures or network partitions.
  1189. # One example of this is a cache, where as long as the node has the data it
  1190. # should be able to serve it.
  1191. #
  1192. # The second use case is for configurations that don't meet the recommended
  1193. # three shards but want to enable cluster mode and scale later. A
  1194. # master outage in a 1 or 2 shard configuration causes a read/write outage to the
  1195. # entire cluster without this option set, with it set there is only a write outage.
  1196. # Without a quorum of masters, slot ownership will not change automatically.
  1197. #
  1198. # cluster-allow-reads-when-down no
  1199. # In order to setup your cluster make sure to read the documentation
  1200. # available at http://redis.io web site.
  1201. ########################## CLUSTER DOCKER/NAT support ########################
  1202. # In certain deployments, Redis Cluster nodes address discovery fails, because
  1203. # addresses are NAT-ted or because ports are forwarded (the typical case is
  1204. # Docker and other containers).
  1205. #
  1206. # In order to make Redis Cluster working in such environments, a static
  1207. # configuration where each node knows its public address is needed. The
  1208. # following two options are used for this scope, and are:
  1209. #
  1210. # * cluster-announce-ip
  1211. # * cluster-announce-port
  1212. # * cluster-announce-bus-port
  1213. #
  1214. # Each instruct the node about its address, client port, and cluster message
  1215. # bus port. The information is then published in the header of the bus packets
  1216. # so that other nodes will be able to correctly map the address of the node
  1217. # publishing the information.
  1218. #
  1219. # If the above options are not used, the normal Redis Cluster auto-detection
  1220. # will be used instead.
  1221. #
  1222. # Note that when remapped, the bus port may not be at the fixed offset of
  1223. # clients port + 10000, so you can specify any port and bus-port depending
  1224. # on how they get remapped. If the bus-port is not set, a fixed offset of
  1225. # 10000 will be used as usually.
  1226. #
  1227. # Example:
  1228. #
  1229. # cluster-announce-ip 10.1.1.5
  1230. # cluster-announce-port 6379
  1231. # cluster-announce-bus-port 6380
  1232. ################################## SLOW LOG ###################################
  1233. # The Redis Slow Log is a system to log queries that exceeded a specified
  1234. # execution time. The execution time does not include the I/O operations
  1235. # like talking with the client, sending the reply and so forth,
  1236. # but just the time needed to actually execute the command (this is the only
  1237. # stage of command execution where the thread is blocked and can not serve
  1238. # other requests in the meantime).
  1239. #
  1240. # You can configure the slow log with two parameters: one tells Redis
  1241. # what is the execution time, in microseconds, to exceed in order for the
  1242. # command to get logged, and the other parameter is the length of the
  1243. # slow log. When a new command is logged the oldest one is removed from the
  1244. # queue of logged commands.
  1245. # The following time is expressed in microseconds, so 1000000 is equivalent
  1246. # to one second. Note that a negative number disables the slow log, while
  1247. # a value of zero forces the logging of every command.
  1248. slowlog-log-slower-than 10000
  1249. # There is no limit to this length. Just be aware that it will consume memory.
  1250. # You can reclaim memory used by the slow log with SLOWLOG RESET.
  1251. slowlog-max-len 128
  1252. ################################ LATENCY MONITOR ##############################
  1253. # The Redis latency monitoring subsystem samples different operations
  1254. # at runtime in order to collect data related to possible sources of
  1255. # latency of a Redis instance.
  1256. #
  1257. # Via the LATENCY command this information is available to the user that can
  1258. # print graphs and obtain reports.
  1259. #
  1260. # The system only logs operations that were performed in a time equal or
  1261. # greater than the amount of milliseconds specified via the
  1262. # latency-monitor-threshold configuration directive. When its value is set
  1263. # to zero, the latency monitor is turned off.
  1264. #
  1265. # By default latency monitoring is disabled since it is mostly not needed
  1266. # if you don't have latency issues, and collecting data has a performance
  1267. # impact, that while very small, can be measured under big load. Latency
  1268. # monitoring can easily be enabled at runtime using the command
  1269. # "CONFIG SET latency-monitor-threshold <milliseconds>" if needed.
  1270. latency-monitor-threshold 0
  1271. ############################# EVENT NOTIFICATION ##############################
  1272. # Redis can notify Pub/Sub clients about events happening in the key space.
  1273. # This feature is documented at http://redis.io/topics/notifications
  1274. #
  1275. # For instance if keyspace events notification is enabled, and a client
  1276. # performs a DEL operation on key "foo" stored in the Database 0, two
  1277. # messages will be published via Pub/Sub:
  1278. #
  1279. # PUBLISH __keyspace@0__:foo del
  1280. # PUBLISH __keyevent@0__:del foo
  1281. #
  1282. # It is possible to select the events that Redis will notify among a set
  1283. # of classes. Every class is identified by a single character:
  1284. #
  1285. # K Keyspace events, published with __keyspace@<db>__ prefix.
  1286. # E Keyevent events, published with __keyevent@<db>__ prefix.
  1287. # g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
  1288. # $ String commands
  1289. # l List commands
  1290. # s Set commands
  1291. # h Hash commands
  1292. # z Sorted set commands
  1293. # x Expired events (events generated every time a key expires)
  1294. # e Evicted events (events generated when a key is evicted for maxmemory)
  1295. # t Stream commands
  1296. # m Key-miss events (Note: It is not included in the 'A' class)
  1297. # A Alias for g$lshzxet, so that the "AKE" string means all the events
  1298. # (Except key-miss events which are excluded from 'A' due to their
  1299. # unique nature).
  1300. #
  1301. # The "notify-keyspace-events" takes as argument a string that is composed
  1302. # of zero or multiple characters. The empty string means that notifications
  1303. # are disabled.
  1304. #
  1305. # Example: to enable list and generic events, from the point of view of the
  1306. # event name, use:
  1307. #
  1308. # notify-keyspace-events Elg
  1309. #
  1310. # Example 2: to get the stream of the expired keys subscribing to channel
  1311. # name __keyevent@0__:expired use:
  1312. #
  1313. # notify-keyspace-events Ex
  1314. #
  1315. # By default all notifications are disabled because most users don't need
  1316. # this feature and the feature has some overhead. Note that if you don't
  1317. # specify at least one of K or E, no events will be delivered.
  1318. notify-keyspace-events ""
  1319. ############################### GOPHER SERVER #################################
  1320. # Redis contains an implementation of the Gopher protocol, as specified in
  1321. # the RFC 1436 (https://www.ietf.org/rfc/rfc1436.txt).
  1322. #
  1323. # The Gopher protocol was very popular in the late '90s. It is an alternative
  1324. # to the web, and the implementation both server and client side is so simple
  1325. # that the Redis server has just 100 lines of code in order to implement this
  1326. # support.
  1327. #
  1328. # What do you do with Gopher nowadays? Well Gopher never *really* died, and
  1329. # lately there is a movement in order for the Gopher more hierarchical content
  1330. # composed of just plain text documents to be resurrected. Some want a simpler
  1331. # internet, others believe that the mainstream internet became too much
  1332. # controlled, and it's cool to create an alternative space for people that
  1333. # want a bit of fresh air.
  1334. #
  1335. # Anyway for the 10nth birthday of the Redis, we gave it the Gopher protocol
  1336. # as a gift.
  1337. #
  1338. # --- HOW IT WORKS? ---
  1339. #
  1340. # The Redis Gopher support uses the inline protocol of Redis, and specifically
  1341. # two kind of inline requests that were anyway illegal: an empty request
  1342. # or any request that starts with "/" (there are no Redis commands starting
  1343. # with such a slash). Normal RESP2/RESP3 requests are completely out of the
  1344. # path of the Gopher protocol implementation and are served as usually as well.
  1345. #
  1346. # If you open a connection to Redis when Gopher is enabled and send it
  1347. # a string like "/foo", if there is a key named "/foo" it is served via the
  1348. # Gopher protocol.
  1349. #
  1350. # In order to create a real Gopher "hole" (the name of a Gopher site in Gopher
  1351. # talking), you likely need a script like the following:
  1352. #
  1353. # https://github.com/antirez/gopher2redis
  1354. #
  1355. # --- SECURITY WARNING ---
  1356. #
  1357. # If you plan to put Redis on the internet in a publicly accessible address
  1358. # to server Gopher pages MAKE SURE TO SET A PASSWORD to the instance.
  1359. # Once a password is set:
  1360. #
  1361. # 1. The Gopher server (when enabled, not by default) will still serve
  1362. # content via Gopher.
  1363. # 2. However other commands cannot be called before the client will
  1364. # authenticate.
  1365. #
  1366. # So use the 'requirepass' option to protect your instance.
  1367. #
  1368. # To enable Gopher support uncomment the following line and set
  1369. # the option from no (the default) to yes.
  1370. #
  1371. # gopher-enabled no
  1372. ############################### ADVANCED CONFIG ###############################
  1373. # Hashes are encoded using a memory efficient data structure when they have a
  1374. # small number of entries, and the biggest entry does not exceed a given
  1375. # threshold. These thresholds can be configured using the following directives.
  1376. hash-max-ziplist-entries 512
  1377. hash-max-ziplist-value 64
  1378. # Lists are also encoded in a special way to save a lot of space.
  1379. # The number of entries allowed per internal list node can be specified
  1380. # as a fixed maximum size or a maximum number of elements.
  1381. # For a fixed maximum size, use -5 through -1, meaning:
  1382. # -5: max size: 64 Kb <-- not recommended for normal workloads
  1383. # -4: max size: 32 Kb <-- not recommended
  1384. # -3: max size: 16 Kb <-- probably not recommended
  1385. # -2: max size: 8 Kb <-- good
  1386. # -1: max size: 4 Kb <-- good
  1387. # Positive numbers mean store up to _exactly_ that number of elements
  1388. # per list node.
  1389. # The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size),
  1390. # but if your use case is unique, adjust the settings as necessary.
  1391. list-max-ziplist-size -2
  1392. # Lists may also be compressed.
  1393. # Compress depth is the number of quicklist ziplist nodes from *each* side of
  1394. # the list to *exclude* from compression. The head and tail of the list
  1395. # are always uncompressed for fast push/pop operations. Settings are:
  1396. # 0: disable all list compression
  1397. # 1: depth 1 means "don't start compressing until after 1 node into the list,
  1398. # going from either the head or tail"
  1399. # So: [head]->node->node->...->node->[tail]
  1400. # [head], [tail] will always be uncompressed; inner nodes will compress.
  1401. # 2: [head]->[next]->node->node->...->node->[prev]->[tail]
  1402. # 2 here means: don't compress head or head->next or tail->prev or tail,
  1403. # but compress all nodes between them.
  1404. # 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail]
  1405. # etc.
  1406. list-compress-depth 0
  1407. # Sets have a special encoding in just one case: when a set is composed
  1408. # of just strings that happen to be integers in radix 10 in the range
  1409. # of 64 bit signed integers.
  1410. # The following configuration setting sets the limit in the size of the
  1411. # set in order to use this special memory saving encoding.
  1412. set-max-intset-entries 512
  1413. # Similarly to hashes and lists, sorted sets are also specially encoded in
  1414. # order to save a lot of space. This encoding is only used when the length and
  1415. # elements of a sorted set are below the following limits:
  1416. zset-max-ziplist-entries 128
  1417. zset-max-ziplist-value 64
  1418. # HyperLogLog sparse representation bytes limit. The limit includes the
  1419. # 16 bytes header. When an HyperLogLog using the sparse representation crosses
  1420. # this limit, it is converted into the dense representation.
  1421. #
  1422. # A value greater than 16000 is totally useless, since at that point the
  1423. # dense representation is more memory efficient.
  1424. #
  1425. # The suggested value is ~ 3000 in order to have the benefits of
  1426. # the space efficient encoding without slowing down too much PFADD,
  1427. # which is O(N) with the sparse encoding. The value can be raised to
  1428. # ~ 10000 when CPU is not a concern, but space is, and the data set is
  1429. # composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
  1430. hll-sparse-max-bytes 3000
  1431. # Streams macro node max size / items. The stream data structure is a radix
  1432. # tree of big nodes that encode multiple items inside. Using this configuration
  1433. # it is possible to configure how big a single node can be in bytes, and the
  1434. # maximum number of items it may contain before switching to a new node when
  1435. # appending new stream entries. If any of the following settings are set to
  1436. # zero, the limit is ignored, so for instance it is possible to set just a
  1437. # max entires limit by setting max-bytes to 0 and max-entries to the desired
  1438. # value.
  1439. stream-node-max-bytes 4096
  1440. stream-node-max-entries 100
  1441. # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
  1442. # order to help rehashing the main Redis hash table (the one mapping top-level
  1443. # keys to values). The hash table implementation Redis uses (see dict.c)
  1444. # performs a lazy rehashing: the more operation you run into a hash table
  1445. # that is rehashing, the more rehashing "steps" are performed, so if the
  1446. # server is idle the rehashing is never complete and some more memory is used
  1447. # by the hash table.
  1448. #
  1449. # The default is to use this millisecond 10 times every second in order to
  1450. # actively rehash the main dictionaries, freeing memory when possible.
  1451. #
  1452. # If unsure:
  1453. # use "activerehashing no" if you have hard latency requirements and it is
  1454. # not a good thing in your environment that Redis can reply from time to time
  1455. # to queries with 2 milliseconds delay.
  1456. #
  1457. # use "activerehashing yes" if you don't have such hard requirements but
  1458. # want to free memory asap when possible.
  1459. activerehashing yes
  1460. # The client output buffer limits can be used to force disconnection of clients
  1461. # that are not reading data from the server fast enough for some reason (a
  1462. # common reason is that a Pub/Sub client can't consume messages as fast as the
  1463. # publisher can produce them).
  1464. #
  1465. # The limit can be set differently for the three different classes of clients:
  1466. #
  1467. # normal -> normal clients including MONITOR clients
  1468. # replica -> replica clients
  1469. # pubsub -> clients subscribed to at least one pubsub channel or pattern
  1470. #
  1471. # The syntax of every client-output-buffer-limit directive is the following:
  1472. #
  1473. # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
  1474. #
  1475. # A client is immediately disconnected once the hard limit is reached, or if
  1476. # the soft limit is reached and remains reached for the specified number of
  1477. # seconds (continuously).
  1478. # So for instance if the hard limit is 32 megabytes and the soft limit is
  1479. # 16 megabytes / 10 seconds, the client will get disconnected immediately
  1480. # if the size of the output buffers reach 32 megabytes, but will also get
  1481. # disconnected if the client reaches 16 megabytes and continuously overcomes
  1482. # the limit for 10 seconds.
  1483. #
  1484. # By default normal clients are not limited because they don't receive data
  1485. # without asking (in a push way), but just after a request, so only
  1486. # asynchronous clients may create a scenario where data is requested faster
  1487. # than it can read.
  1488. #
  1489. # Instead there is a default limit for pubsub and replica clients, since
  1490. # subscribers and replicas receive data in a push fashion.
  1491. #
  1492. # Both the hard or the soft limit can be disabled by setting them to zero.
  1493. client-output-buffer-limit normal 0 0 0
  1494. client-output-buffer-limit replica 256mb 64mb 60
  1495. client-output-buffer-limit pubsub 32mb 8mb 60
  1496. # Client query buffers accumulate new commands. They are limited to a fixed
  1497. # amount by default in order to avoid that a protocol desynchronization (for
  1498. # instance due to a bug in the client) will lead to unbound memory usage in
  1499. # the query buffer. However you can configure it here if you have very special
  1500. # needs, such us huge multi/exec requests or alike.
  1501. #
  1502. # client-query-buffer-limit 1gb
  1503. # In the Redis protocol, bulk requests, that are, elements representing single
  1504. # strings, are normally limited ot 512 mb. However you can change this limit
  1505. # here.
  1506. #
  1507. # proto-max-bulk-len 512mb
  1508. # Redis calls an internal function to perform many background tasks, like
  1509. # closing connections of clients in timeout, purging expired keys that are
  1510. # never requested, and so forth.
  1511. #
  1512. # Not all tasks are performed with the same frequency, but Redis checks for
  1513. # tasks to perform according to the specified "hz" value.
  1514. #
  1515. # By default "hz" is set to 10. Raising the value will use more CPU when
  1516. # Redis is idle, but at the same time will make Redis more responsive when
  1517. # there are many keys expiring at the same time, and timeouts may be
  1518. # handled with more precision.
  1519. #
  1520. # The range is between 1 and 500, however a value over 100 is usually not
  1521. # a good idea. Most users should use the default of 10 and raise this up to
  1522. # 100 only in environments where very low latency is required.
  1523. hz 10
  1524. # Normally it is useful to have an HZ value which is proportional to the
  1525. # number of clients connected. This is useful in order, for instance, to
  1526. # avoid too many clients are processed for each background task invocation
  1527. # in order to avoid latency spikes.
  1528. #
  1529. # Since the default HZ value by default is conservatively set to 10, Redis
  1530. # offers, and enables by default, the ability to use an adaptive HZ value
  1531. # which will temporary raise when there are many connected clients.
  1532. #
  1533. # When dynamic HZ is enabled, the actual configured HZ will be used
  1534. # as a baseline, but multiples of the configured HZ value will be actually
  1535. # used as needed once more clients are connected. In this way an idle
  1536. # instance will use very little CPU time while a busy instance will be
  1537. # more responsive.
  1538. dynamic-hz yes
  1539. # When a child rewrites the AOF file, if the following option is enabled
  1540. # the file will be fsync-ed every 32 MB of data generated. This is useful
  1541. # in order to commit the file to the disk more incrementally and avoid
  1542. # big latency spikes.
  1543. aof-rewrite-incremental-fsync yes
  1544. # When redis saves RDB file, if the following option is enabled
  1545. # the file will be fsync-ed every 32 MB of data generated. This is useful
  1546. # in order to commit the file to the disk more incrementally and avoid
  1547. # big latency spikes.
  1548. rdb-save-incremental-fsync yes
  1549. # Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good
  1550. # idea to start with the default settings and only change them after investigating
  1551. # how to improve the performances and how the keys LFU change over time, which
  1552. # is possible to inspect via the OBJECT FREQ command.
  1553. #
  1554. # There are two tunable parameters in the Redis LFU implementation: the
  1555. # counter logarithm factor and the counter decay time. It is important to
  1556. # understand what the two parameters mean before changing them.
  1557. #
  1558. # The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis
  1559. # uses a probabilistic increment with logarithmic behavior. Given the value
  1560. # of the old counter, when a key is accessed, the counter is incremented in
  1561. # this way:
  1562. #
  1563. # 1. A random number R between 0 and 1 is extracted.
  1564. # 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1).
  1565. # 3. The counter is incremented only if R < P.
  1566. #
  1567. # The default lfu-log-factor is 10. This is a table of how the frequency
  1568. # counter changes with a different number of accesses with different
  1569. # logarithmic factors:
  1570. #
  1571. # +--------+------------+------------+------------+------------+------------+
  1572. # | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits |
  1573. # +--------+------------+------------+------------+------------+------------+
  1574. # | 0 | 104 | 255 | 255 | 255 | 255 |
  1575. # +--------+------------+------------+------------+------------+------------+
  1576. # | 1 | 18 | 49 | 255 | 255 | 255 |
  1577. # +--------+------------+------------+------------+------------+------------+
  1578. # | 10 | 10 | 18 | 142 | 255 | 255 |
  1579. # +--------+------------+------------+------------+------------+------------+
  1580. # | 100 | 8 | 11 | 49 | 143 | 255 |
  1581. # +--------+------------+------------+------------+------------+------------+
  1582. #
  1583. # NOTE: The above table was obtained by running the following commands:
  1584. #
  1585. # redis-benchmark -n 1000000 incr foo
  1586. # redis-cli object freq foo
  1587. #
  1588. # NOTE 2: The counter initial value is 5 in order to give new objects a chance
  1589. # to accumulate hits.
  1590. #
  1591. # The counter decay time is the time, in minutes, that must elapse in order
  1592. # for the key counter to be divided by two (or decremented if it has a value
  1593. # less <= 10).
  1594. #
  1595. # The default value for the lfu-decay-time is 1. A Special value of 0 means to
  1596. # decay the counter every time it happens to be scanned.
  1597. #
  1598. # lfu-log-factor 10
  1599. # lfu-decay-time 1
  1600. ########################### ACTIVE DEFRAGMENTATION #######################
  1601. #
  1602. # What is active defragmentation?
  1603. # -------------------------------
  1604. #
  1605. # Active (online) defragmentation allows a Redis server to compact the
  1606. # spaces left between small allocations and deallocations of data in memory,
  1607. # thus allowing to reclaim back memory.
  1608. #
  1609. # Fragmentation is a natural process that happens with every allocator (but
  1610. # less so with Jemalloc, fortunately) and certain workloads. Normally a server
  1611. # restart is needed in order to lower the fragmentation, or at least to flush
  1612. # away all the data and create it again. However thanks to this feature
  1613. # implemented by Oran Agra for Redis 4.0 this process can happen at runtime
  1614. # in an "hot" way, while the server is running.
  1615. #
  1616. # Basically when the fragmentation is over a certain level (see the
  1617. # configuration options below) Redis will start to create new copies of the
  1618. # values in contiguous memory regions by exploiting certain specific Jemalloc
  1619. # features (in order to understand if an allocation is causing fragmentation
  1620. # and to allocate it in a better place), and at the same time, will release the
  1621. # old copies of the data. This process, repeated incrementally for all the keys
  1622. # will cause the fragmentation to drop back to normal values.
  1623. #
  1624. # Important things to understand:
  1625. #
  1626. # 1. This feature is disabled by default, and only works if you compiled Redis
  1627. # to use the copy of Jemalloc we ship with the source code of Redis.
  1628. # This is the default with Linux builds.
  1629. #
  1630. # 2. You never need to enable this feature if you don't have fragmentation
  1631. # issues.
  1632. #
  1633. # 3. Once you experience fragmentation, you can enable this feature when
  1634. # needed with the command "CONFIG SET activedefrag yes".
  1635. #
  1636. # The configuration parameters are able to fine tune the behavior of the
  1637. # defragmentation process. If you are not sure about what they mean it is
  1638. # a good idea to leave the defaults untouched.
  1639. # Enabled active defragmentation
  1640. # activedefrag no
  1641. # Minimum amount of fragmentation waste to start active defrag
  1642. # active-defrag-ignore-bytes 100mb
  1643. # Minimum percentage of fragmentation to start active defrag
  1644. # active-defrag-threshold-lower 10
  1645. # Maximum percentage of fragmentation at which we use maximum effort
  1646. # active-defrag-threshold-upper 100
  1647. # Minimal effort for defrag in CPU percentage, to be used when the lower
  1648. # threshold is reached
  1649. # active-defrag-cycle-min 1
  1650. # Maximal effort for defrag in CPU percentage, to be used when the upper
  1651. # threshold is reached
  1652. # active-defrag-cycle-max 25
  1653. # Maximum number of set/hash/zset/list fields that will be processed from
  1654. # the main dictionary scan
  1655. # active-defrag-max-scan-fields 1000
  1656. # Jemalloc background thread for purging will be enabled by default
  1657. jemalloc-bg-thread yes
  1658. # It is possible to pin different threads and processes of Redis to specific
  1659. # CPUs in your system, in order to maximize the performances of the server.
  1660. # This is useful both in order to pin different Redis threads in different
  1661. # CPUs, but also in order to make sure that multiple Redis instances running
  1662. # in the same host will be pinned to different CPUs.
  1663. #
  1664. # Normally you can do this using the "taskset" command, however it is also
  1665. # possible to this via Redis configuration directly, both in Linux and FreeBSD.
  1666. #
  1667. # You can pin the server/IO threads, bio threads, aof rewrite child process, and
  1668. # the bgsave child process. The syntax to specify the cpu list is the same as
  1669. # the taskset command:
  1670. #
  1671. # Set redis server/io threads to cpu affinity 0,2,4,6:
  1672. # server_cpulist 0-7:2
  1673. #
  1674. # Set bio threads to cpu affinity 1,3:
  1675. # bio_cpulist 1,3
  1676. #
  1677. # Set aof rewrite child process to cpu affinity 8,9,10,11:
  1678. # aof_rewrite_cpulist 8-11
  1679. #
  1680. # Set bgsave child process to cpu affinity 1,10,11
  1681. # bgsave_cpulist 1,10-11