redis.conf 83 KB

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