什么是Redis

首先到Redis的官方网站,查看Redis文档,让官方告诉我们什么是Redis

Redis 概述 部署 - 图1

解释说明:

  1. Introduction to Redis Learn about the Redis open source project Redis相关的介绍,也就是最直接简单的告诉我们redis是什么?
  2. Getting started with Redis How to get up and running with Redis Redis的入门,如何使用Redis 从部署安装到基本命令的使用
  3. Clients Redis clients Redis PR Bug的修复,优化
  4. Libraries Libraries that use Redis Redis 仓库资源的迁移变动
  5. Tools A list of tools for Redis Redis相关GUI工具
  6. Modules List of Redis modules Redis相关的模块库
  7. The Redis manual A developer’s guide to Redis Redis详细的开发指南【常看】
  8. Redis reference Specifications, patterns, internals, and optimization Redis 规范、模式、内部结构和优化
  9. Redis Stack Extend Redis with modern data models and processing engines Redis 的扩展 添加了现代数据模型和处理引

官方Redis简介

Redis 是一个开源(BSD 许可)的内存数据结构存储【NoSql】,用作数据库、缓存、消息代理和流引擎。Redis 提供数据结构,例如 字符串散列列表集合、带范围查询的排序集合、位图超日志地理空间索引。Redis 内置了复制Lua 脚本LRU 驱逐事务和不同级别的磁盘持久性,并通过以下方式提供高可用性Redis SentinelRedis Cluster的自动分区。

您可以 对这些类型运行原子操作,例如附加到字符串增加哈希值将元素推入列表计算集交并 、;或获取排序集中排名最高的成员

为了达到最佳性能,Redis 使用 内存中的数据集。根据您的用例,Redis 可以通过定期将数据集转储到磁盘将每个命令附加到基于磁盘的日志来持久化您的数据。如果您只需要一个功能丰富的网络内存缓存,您也可以禁用持久性。

Redis 支持异步复制,具有快速非阻塞同步和自动重新连接以及网络拆分上的部分重新同步。

Redis 还包括:

简单总结来说:

Redis是现在最受欢迎的NoSQL数据库之一,Redis是一个使用ANSI C编写的开源、包含多种数据结构、支持网络、基于内存、可选持久性的键值对存储数据库,其具备如下特性:

  • 基于内存运行,性能高效
  • 支持分布式,理论上可以无限扩展
  • key-value存储系统
  • 开源的使用ANSI C语言编写、遵守BSD协议、支持网络、可基于内存亦可持久化的日志型、Key-Value数据库,并提供多种语言的API

相比于其他数据库类型,Redis具备的特点是:

  • C/S通讯模型
  • 单进程单线程模型
  • 丰富的数据类型
  • 操作具有原子性
  • 持久化
  • 高并发读写
  • 支持lua脚本

NoSql

市面上类似于Redis,同样是NoSQL型的数据库有很多,如下图所示,除了Redis,还有MemCacheCassadraMongo

Memcache: 这是一个和Redis非常相似的数据库,但是它的数据类型没有Redis丰富。Memcache由LiveJournal的Brad Fitzpatrick开发,作为一套分布式的高速缓存系统,被许多网站使用以提升网站的访问速度,对于一些大型的、需要频繁访问数据库的网站访问速度的提升效果十分显著。

Apache Cassandra:(社区内一般简称为C*)这是一套开源分布式NoSQL数据库系统。它最初由Facebook开发,用于储存收件箱等简单格式数据,集Google BigTable的数据模型与Amazon Dynamo的完全分布式架构于一身。Facebook于2008将 Cassandra 开源,由于其良好的可扩展性和性能,被 Apple、Comcast、Instagram、Spotify、eBay、Rackspace、Netflix等知名网站所采用,成为了一种流行的分布式结构化数据存储方案。

MongoDB:是一个基于分布式文件存储、面向文档的NoSQL数据库,由C++编写,旨在为WEB应用提供可扩展的高性能数据存储解决方案。MongoDB是一个介于关系数据库和非关系数据库之间的产品,是非关系数据库当中功能最丰富,最像关系型数据库的,它支持的数据结构非常松散,是一种类似json的BSON格式。

Redis 基本数据类型

Redis提供的数据类型主要分为5种自有类型和一种自定义类型,这5种自有类型包括:String类型、哈希类型、列表类型、集合类型和顺序集合类型

对每种数据类型,Redis都提供了丰富的操作命令,如:

  • GET/MGET
  • SET/SETEX/MSET/MSETNX
  • INCR/DECR
  • GETSET
  • DEL

哈希类型

该类型是由field和关联的value组成的map。其中,fieldvalue都是字符串类型的。

Hash的操作命令如下:

  • HGET/HMGET/HGETALL
  • HSET/HMSET/HSETNX
  • HEXISTS/HLEN
  • HKEYS/HDEL
  • HVALS

列表类型

该类型是一个插入顺序排序的字符串元素集合, 基于双链表实现。

List的操作命令如下:

  • LPUSH/LPUSHX/LPOP/RPUSH/RPUSHX/RPOP/LINSERT/LSET
  • LINDEX/LRANGE
  • LLEN/LTRIM

集合类型

Set类型是一种无顺序集合, 它和List类型最大的区别是:集合中的元素没有顺序, 且元素是唯一的。

Set类型的底层是通过哈希表实现的,其操作命令为:

  • SADD/SPOP/SMOVE/SCARD
  • SINTER/SDIFF/SDIFFSTORE/SUNION

Set类型主要应用于:在某些场景,如社交场景中,通过交集、并集和差集运算,通过Set类型可以非常方便地查找共同好友、共同关注和共同偏好等社交关系。

顺序集合类型

ZSet是一种有序集合类型,每个元素都会关联一个double类型的分数权值,通过这个权值来为集合中的成员进行从小到大的排序。与Set类型一样,其底层也是通过哈希表实现的。

ZSet命令:

  • ZADD/ZPOP/ZMOVE/ZCARD/ZCOUNT
  • ZINTER/ZDIFF/ZDIFFSTORE/ZUNION

docker 部署Redis【单机版本】

  1. 拉取redis镜像

    1. docker pull redis


    操作日志:

  2. redis 配置文件

创建redis目录

命令:mkdir redis

将redis配置文件上传到redis目录

配置文件详解:

  1. # Redis配置文件样例
  2. # Note on units: when memory size is needed, it is possible to specifiy
  3. # it in the usual form of 1k 5GB 4M and so forth:
  4. #
  5. # 1k => 1000 bytes
  6. # 1kb => 1024 bytes
  7. # 1m => 1000000 bytes
  8. # 1mb => 1024*1024 bytes
  9. # 1g => 1000000000 bytes
  10. # 1gb => 1024*1024*1024 bytes
  11. #
  12. # units are case insensitive so 1GB 1Gb 1gB are all the same.
  13. # Redis默认不是以守护进程的方式运行,可以通过该配置项修改,使用yes启用守护进程
  14. # 启用守护进程后,Redis会把pid写到一个pidfile中,在/var/run/redis.pid
  15. daemonize no
  16. # Redis以守护进程方式运行时,Redis默认会把pid写入/var/run/redis.pid文件,可以通过pidfile指定
  17. pidfile /var/run/redis.pid
  18. # 指定Redis监听端口,默认端口为6379
  19. # 如果指定0端口,表示Redis不监听TCP连接
  20. port 6379
  21. # 绑定的主机地址
  22. # 你可以绑定单一接口,如果没有绑定,所有接口都会监听到来的连接
  23. # bind 127.0.0.1
  24. # Specify the path for the unix socket that will be used to listen for
  25. # incoming connections. There is no default, so Redis will not listen
  26. # on a unix socket when not specified.
  27. #
  28. # unixsocket /tmp/redis.sock
  29. # unixsocketperm 755
  30. # 当客户端闲置多长时间后关闭连接,如果指定为0,表示关闭该功能
  31. timeout 0
  32. # 指定日志记录级别,Redis总共支持四个级别:debugverbosenoticewarning,默认为verbose
  33. # debug (很多信息, 对开发/测试比较有用)
  34. # verbose (many rarely useful info, but not a mess like the debug level)
  35. # notice (moderately verbose, what you want in production probably)
  36. # warning (only very important / critical messages are logged)
  37. loglevel verbose
  38. # 日志记录方式,默认为标准输出,如果配置为redis为守护进程方式运行,而这里又配置为标准输出,则日志将会发送给/dev/null
  39. logfile stdout
  40. # To enable logging to the system logger, just set 'syslog-enabled' to yes,
  41. # and optionally update the other syslog parameters to suit your needs.
  42. # syslog-enabled no
  43. # Specify the syslog identity.
  44. # syslog-ident redis
  45. # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
  46. # syslog-facility local0
  47. # 设置数据库的数量,默认数据库为0,可以使用select <dbid>命令在连接上指定数据库id
  48. # dbid是从0到‘databases’-1的数目
  49. databases 16
  50. ################################ SNAPSHOTTING #################################
  51. # 指定在多长时间内,有多少次更新操作,就将数据同步到数据文件,可以多个条件配合
  52. # Save the DB on disk:
  53. #
  54. # save <seconds> <changes>
  55. #
  56. # Will save the DB if both the given number of seconds and the given
  57. # number of write operations against the DB occurred.
  58. #
  59. # 满足以下条件将会同步数据:
  60. # 900秒(15分钟)内有1个更改
  61. # 300秒(5分钟)内有10个更改
  62. # 60秒内有10000个更改
  63. # Note: 可以把所有“save”行注释掉,这样就取消同步操作了
  64. save 900 1
  65. save 300 10
  66. save 60 10000
  67. # 指定存储至本地数据库时是否压缩数据,默认为yesRedis采用LZF压缩,如果为了节省CPU时间,可以关闭该选项,但会导致数据库文件变的巨大
  68. rdbcompression yes
  69. # 指定本地数据库文件名,默认值为dump.rdb
  70. dbfilename dump.rdb
  71. # 工作目录.
  72. # 指定本地数据库存放目录,文件名由上一个dbfilename配置项指定
  73. #
  74. # Also the Append Only File will be created inside this directory.
  75. #
  76. # 注意,这里只能指定一个目录,不能指定文件名
  77. dir ./
  78. ################################# REPLICATION #################################
  79. # 主从复制。使用slaveof Redis服务器复制一个Redis实例。注意,该配置仅限于当前slave有效
  80. # so for example it is possible to configure the slave to save the DB with a
  81. # different interval, or to listen to another port, and so on.
  82. # 设置当本机为slav服务时,设置master服务的ip地址及端口,在Redis启动时,它会自动从master进行数据同步
  83. # slaveof <masterip> <masterport>
  84. # master服务设置了密码保护时,slav服务连接master的密码
  85. # 下文的“requirepass”配置项可以指定密码
  86. # masterauth <master-password>
  87. # When a slave lost the connection with the master, or when the replication
  88. # is still in progress, the slave can act in two different ways:
  89. #
  90. # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
  91. # still reply to client requests, possibly with out of data data, or the
  92. # data set may just be empty if this is the first synchronization.
  93. #
  94. # 2) if slave-serve-stale data is set to 'no' the slave will reply with
  95. # an error "SYNC with master in progress" to all the kind of commands
  96. # but to INFO and SLAVEOF.
  97. #
  98. slave-serve-stale-data yes
  99. # Slaves send PINGs to server in a predefined interval. It's possible to change
  100. # this interval with the repl_ping_slave_period option. The default value is 10
  101. # seconds.
  102. #
  103. # repl-ping-slave-period 10
  104. # The following option sets a timeout for both Bulk transfer I/O timeout and
  105. # master data or ping response timeout. The default value is 60 seconds.
  106. #
  107. # It is important to make sure that this value is greater than the value
  108. # specified for repl-ping-slave-period otherwise a timeout will be detected
  109. # every time there is low traffic between the master and the slave.
  110. #
  111. # repl-timeout 60
  112. ################################## SECURITY ###################################
  113. # Warning: since Redis is pretty fast an outside user can try up to
  114. # 150k passwords per second against a good box. This means that you should
  115. # use a very strong password otherwise it will be very easy to break.
  116. # 设置Redis连接密码,如果配置了连接密码,客户端在连接Redis时需要通过auth <password>命令提供密码,默认关闭
  117. # requirepass foobared
  118. # Command renaming.
  119. #
  120. # It is possilbe to change the name of dangerous commands in a shared
  121. # environment. For instance the CONFIG command may be renamed into something
  122. # of hard to guess so that it will be still available for internal-use
  123. # tools but not available for general clients.
  124. #
  125. # Example:
  126. #
  127. # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
  128. #
  129. # It is also possilbe to completely kill a command renaming it into
  130. # an empty string:
  131. #
  132. # rename-command CONFIG ""
  133. ################################### LIMITS ####################################
  134. # 设置同一时间最大客户端连接数,默认无限制,Redis可以同时打开的客户端连接数为Redis进程可以打开的最大文件描述符数,
  135. # 如果设置maxclients 0,表示不作限制。当客户端连接数到达限制时,Redis会关闭新的连接并向客户端返回max Number of clients reached错误信息
  136. # maxclients 128
  137. # Don't use more memory than the specified amount of bytes.
  138. # When the memory limit is reached Redis will try to remove keys with an
  139. # EXPIRE set. It will try to start freeing keys that are going to expire
  140. # in little time and preserve keys with a longer time to live.
  141. # Redis will also try to remove objects from free lists if possible.
  142. #
  143. # If all this fails, Redis will start to reply with errors to commands
  144. # that will use more memory, like SET, LPUSH, and so on, and will continue
  145. # to reply to most read-only commands like GET.
  146. #
  147. # WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
  148. # 'state' server or cache, not as a real DB. When Redis is used as a real
  149. # database the memory usage will grow over the weeks, it will be obvious if
  150. # it is going to use too much memory in the long run, and you'll have the time
  151. # to upgrade. With maxmemory after the limit is reached you'll start to get
  152. # errors for write operations, and this may even lead to DB inconsistency.
  153. # 指定Redis最大内存限制,Redis在启动时会把数据加载到内存中,达到最大内存后,Redis会先尝试清除已到期或即将到期的Key
  154. # 当此方法处理后,仍然到达最大内存设置,将无法再进行写入操作,但仍然可以进行读取操作。
  155. # Redis新的vm机制,会把Key存放内存,Value会存放在swap
  156. # maxmemory <bytes>
  157. # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
  158. # is reached? You can select among five behavior:
  159. #
  160. # volatile-lru -> remove the key with an expire set using an LRU algorithm
  161. # allkeys-lru -> remove any key accordingly to the LRU algorithm
  162. # volatile-random -> remove a random key with an expire set
  163. # allkeys->random -> remove a random key, any key
  164. # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
  165. # noeviction -> don't expire at all, just return an error on write operations
  166. #
  167. # Note: with all the kind of policies, Redis will return an error on write
  168. # operations, when there are not suitable keys for eviction.
  169. #
  170. # At the date of writing this commands are: set setnx setex append
  171. # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
  172. # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
  173. # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
  174. # getset mset msetnx exec sort
  175. #
  176. # The default is:
  177. #
  178. # maxmemory-policy volatile-lru
  179. # LRU and minimal TTL algorithms are not precise algorithms but approximated
  180. # algorithms (in order to save memory), so you can select as well the sample
  181. # size to check. For instance for default Redis will check three keys and
  182. # pick the one that was used less recently, you can change the sample size
  183. # using the following configuration directive.
  184. #
  185. # maxmemory-samples 3
  186. ############################## APPEND ONLY MODE ###############################
  187. #
  188. # Note that you can have both the async dumps and the append only file if you
  189. # like (you have to comment the "save" statements above to disable the dumps).
  190. # Still if append only mode is enabled Redis will load the data from the
  191. # log file at startup ignoring the dump.rdb file.
  192. # 指定是否在每次更新操作后进行日志记录,Redis在默认情况下是异步的把数据写入磁盘,如果不开启,可能会在断电时导致一段时间内的数据丢失。
  193. # 因为redis本身同步数据文件是按上面save条件来同步的,所以有的数据会在一段时间内只存在于内存中。默认为no
  194. # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
  195. # log file in background when it gets too big.
  196. appendonly no
  197. # 指定更新日志文件名,默认为appendonly.aof
  198. # appendfilename appendonly.aof
  199. # The fsync() call tells the Operating System to actually write data on disk
  200. # instead to wait for more data in the output buffer. Some OS will really flush
  201. # data on disk, some other OS will just try to do it ASAP.
  202. # 指定更新日志条件,共有3个可选值:
  203. # no:表示等操作系统进行数据缓存同步到磁盘(快)
  204. # always:表示每次更新操作后手动调用fsync()将数据写到磁盘(慢,安全)
  205. # everysec:表示每秒同步一次(折衷,默认值)
  206. appendfsync everysec
  207. # appendfsync no
  208. # When the AOF fsync policy is set to always or everysec, and a background
  209. # saving process (a background save or AOF log background rewriting) is
  210. # performing a lot of I/O against the disk, in some Linux configurations
  211. # Redis may block too long on the fsync() call. Note that there is no fix for
  212. # this currently, as even performing fsync in a different thread will block
  213. # our synchronous write(2) call.
  214. #
  215. # In order to mitigate this problem it's possible to use the following option
  216. # that will prevent fsync() from being called in the main process while a
  217. # BGSAVE or BGREWRITEAOF is in progress.
  218. #
  219. # This means that while another child is saving the durability of Redis is
  220. # the same as "appendfsync none", that in pratical terms means that it is
  221. # possible to lost up to 30 seconds of log in the worst scenario (with the
  222. # default Linux settings).
  223. #
  224. # If you have latency problems turn this to "yes". Otherwise leave it as
  225. # "no" that is the safest pick from the point of view of durability.
  226. no-appendfsync-on-rewrite no
  227. # Automatic rewrite of the append only file.
  228. # Redis is able to automatically rewrite the log file implicitly calling
  229. # BGREWRITEAOF when the AOF log size will growth by the specified percentage.
  230. #
  231. # This is how it works: Redis remembers the size of the AOF file after the
  232. # latest rewrite (or if no rewrite happened since the restart, the size of
  233. # the AOF at startup is used).
  234. #
  235. # This base size is compared to the current size. If the current size is
  236. # bigger than the specified percentage, the rewrite is triggered. Also
  237. # you need to specify a minimal size for the AOF file to be rewritten, this
  238. # is useful to avoid rewriting the AOF file even if the percentage increase
  239. # is reached but it is still pretty small.
  240. #
  241. # Specify a precentage of zero in order to disable the automatic AOF
  242. # rewrite feature.
  243. auto-aof-rewrite-percentage 100
  244. auto-aof-rewrite-min-size 64mb
  245. ################################## SLOW LOG ###################################
  246. # The Redis Slow Log is a system to log queries that exceeded a specified
  247. # execution time. The execution time does not include the I/O operations
  248. # like talking with the client, sending the reply and so forth,
  249. # but just the time needed to actually execute the command (this is the only
  250. # stage of command execution where the thread is blocked and can not serve
  251. # other requests in the meantime).
  252. #
  253. # You can configure the slow log with two parameters: one tells Redis
  254. # what is the execution time, in microseconds, to exceed in order for the
  255. # command to get logged, and the other parameter is the length of the
  256. # slow log. When a new command is logged the oldest one is removed from the
  257. # queue of logged commands.
  258. # The following time is expressed in microseconds, so 1000000 is equivalent
  259. # to one second. Note that a negative number disables the slow log, while
  260. # a value of zero forces the logging of every command.
  261. slowlog-log-slower-than 10000
  262. # There is no limit to this length. Just be aware that it will consume memory.
  263. # You can reclaim memory used by the slow log with SLOWLOG RESET.
  264. slowlog-max-len 1024
  265. ################################ VIRTUAL MEMORY ###############################
  266. ### WARNING! Virtual Memory is deprecated in Redis 2.4
  267. ### The use of Virtual Memory is strongly discouraged.
  268. ### WARNING! Virtual Memory is deprecated in Redis 2.4
  269. ### The use of Virtual Memory is strongly discouraged.
  270. # Virtual Memory allows Redis to work with datasets bigger than the actual
  271. # amount of RAM needed to hold the whole dataset in memory.
  272. # In order to do so very used keys are taken in memory while the other keys
  273. # are swapped into a swap file, similarly to what operating systems do
  274. # with memory pages.
  275. # 指定是否启用虚拟内存机制,默认值为no
  276. # VM机制将数据分页存放,由Redis将访问量较少的页即冷数据swap到磁盘上,访问多的页面由磁盘自动换出到内存中
  277. # vm-enabled设置为yes,根据需要设置好接下来的三个VM参数,就可以启动VM
  278. vm-enabled no
  279. # vm-enabled yes
  280. # This is the path of the Redis swap file. As you can guess, swap files
  281. # can't be shared by different Redis instances, so make sure to use a swap
  282. # file for every redis process you are running. Redis will complain if the
  283. # swap file is already in use.
  284. #
  285. # Redis交换文件最好的存储是SSD(固态硬盘)
  286. # 虚拟内存文件路径,默认值为/tmp/redis.swap,不可多个Redis实例共享
  287. # *** WARNING *** if you are using a shared hosting the default of putting
  288. # the swap file under /tmp is not secure. Create a dir with access granted
  289. # only to Redis user and configure Redis to create the swap file there.
  290. vm-swap-file /tmp/redis.swap
  291. # With vm-max-memory 0 the system will swap everything it can. Not a good
  292. # default, just specify the max amount of RAM you can in bytes, but it's
  293. # better to leave some margin. For instance specify an amount of RAM
  294. # that's more or less between 60 and 80% of your free RAM.
  295. # 将所有大于vm-max-memory的数据存入虚拟内存,无论vm-max-memory设置多少,所有索引数据都是内存存储的(Redis的索引数据就是keys
  296. # 也就是说当vm-max-memory设置为0的时候,其实是所有value都存在于磁盘。默认值为0
  297. vm-max-memory 0
  298. # Redis swap文件分成了很多的page,一个对象可以保存在多个page上面,但一个page上不能被多个对象共享,vm-page-size是要根据存储的数据大小来设定的。
  299. # 建议如果存储很多小对象,page大小最后设置为3264bytes;如果存储很大的对象,则可以使用更大的page,如果不确定,就使用默认值
  300. vm-page-size 32
  301. # 设置swap文件中的page数量由于页表(一种表示页面空闲或使用的bitmap)是存放在内存中的,在磁盘上每8pages将消耗1byte的内存
  302. # swap空间总容量为 vm-page-size * vm-pages
  303. #
  304. # With the default of 32-bytes memory pages and 134217728 pages Redis will
  305. # use a 4 GB swap file, that will use 16 MB of RAM for the page table.
  306. #
  307. # It's better to use the smallest acceptable value for your application,
  308. # but the default is large in order to work in most conditions.
  309. vm-pages 134217728
  310. # Max number of VM I/O threads running at the same time.
  311. # This threads are used to read/write data from/to swap file, since they
  312. # also encode and decode objects from disk to memory or the reverse, a bigger
  313. # number of threads can help with big objects even if they can't help with
  314. # I/O itself as the physical device may not be able to couple with many
  315. # reads/writes operations at the same time.
  316. # 设置访问swap文件的I/O线程数,最后不要超过机器的核数,如果设置为0,那么所有对swap文件的操作都是串行的,可能会造成比较长时间的延迟,默认值为4
  317. vm-max-threads 4
  318. ############################### ADVANCED CONFIG ###############################
  319. # Hashes are encoded in a special way (much more memory efficient) when they
  320. # have at max a given numer of elements, and the biggest element does not
  321. # exceed a given threshold. You can configure this limits with the following
  322. # configuration directives.
  323. # 指定在超过一定的数量或者最大的元素超过某一临界值时,采用一种特殊的哈希算法
  324. hash-max-zipmap-entries 512
  325. hash-max-zipmap-value 64
  326. # Similarly to hashes, small lists are also encoded in a special way in order
  327. # to save a lot of space. The special representation is only used when
  328. # you are under the following limits:
  329. list-max-ziplist-entries 512
  330. list-max-ziplist-value 64
  331. # Sets have a special encoding in just one case: when a set is composed
  332. # of just strings that happens to be integers in radix 10 in the range
  333. # of 64 bit signed integers.
  334. # The following configuration setting sets the limit in the size of the
  335. # set in order to use this special memory saving encoding.
  336. set-max-intset-entries 512
  337. # Similarly to hashes and lists, sorted sets are also specially encoded in
  338. # order to save a lot of space. This encoding is only used when the length and
  339. # elements of a sorted set are below the following limits:
  340. zset-max-ziplist-entries 128
  341. zset-max-ziplist-value 64
  342. # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
  343. # order to help rehashing the main Redis hash table (the one mapping top-level
  344. # keys to values). The hash table implementation redis uses (see dict.c)
  345. # performs a lazy rehashing: the more operation you run into an hash table
  346. # that is rhashing, the more rehashing "steps" are performed, so if the
  347. # server is idle the rehashing is never complete and some more memory is used
  348. # by the hash table.
  349. #
  350. # The default is to use this millisecond 10 times every second in order to
  351. # active rehashing the main dictionaries, freeing memory when possible.
  352. #
  353. # If unsure:
  354. # use "activerehashing no" if you have hard latency requirements and it is
  355. # not a good thing in your environment that Redis can reply form time to time
  356. # to queries with 2 milliseconds delay.
  357. # 指定是否激活重置哈希,默认为开启
  358. activerehashing yes
  359. ################################## INCLUDES ###################################
  360. # 指定包含其他的配置文件,可以在同一主机上多个Redis实例之间使用同一份配置文件,而同时各实例又拥有自己的特定配置文件
  361. # include /path/to/local.conf
  362. # include /path/to/other.conf

使用配置文件:

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

注意:在docker中启动redis一定要把:daemonize 设置为 no,这个很重要,如果不是no docker会一直启动失败,原因是docker本身需要后台运行,而这个配置选项也是以守护进程启动,两者会冲突

命令说明:

  • -v /redis/redis.conf:/etc/redis/redis.conf** :

挂载持久化配置
/redis/redis.conf :是宿主机(服务器)你自己的redis.conf文件路径
/etc/redis/redis.conf : 容器内部的redis.conf文件路径,不用手动创建,容器启动时会把上边宿主机的redis.conf自动映射到改目录下. 这样在修改redis.conf文件时候就不用进入到容器内部去修改了

  • -v /home/docker/redis/data:/data

/home/docker/redis/data是宿主机中持久化文件的位置,/data是容器中持久化文件的位置

  • redis-server /etc/redis/redis.conf

指定用配置文件的方式启动redis

  • –appendonly yes

开启持久化

  1. 进入容器使用redis-cli命令

操作日志:

docker exec -it redis01 bash

redis -cli

127.0.0.1:6379> set msg '123'
OK
127.0.0.1:6379> get msg
"123"
127.0.0.1:6379>