]> git.saurik.com Git - redis.git/blob - utils/redis.conf.tpl
New tests related to scripts max execution time.
[redis.git] / utils / redis.conf.tpl
1 # Redis configuration file example
2
3 # Note on units: when memory size is needed, it is possible to specify
4 # it in the usual form of 1k 5GB 4M and so forth:
5 #
6 # 1k => 1000 bytes
7 # 1kb => 1024 bytes
8 # 1m => 1000000 bytes
9 # 1mb => 1024*1024 bytes
10 # 1g => 1000000000 bytes
11 # 1gb => 1024*1024*1024 bytes
12 #
13 # units are case insensitive so 1GB 1Gb 1gB are all the same.
14
15 # By default Redis does not run as a daemon. Use 'yes' if you need it.
16 # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
17 daemonize yes
18
19 # When running daemonized, Redis writes a pid file in /var/run/redis.pid by
20 # default. You can specify a custom pid file location here.
21 pidfile $PIDFILE
22
23 # Accept connections on the specified port, default is 6379.
24 # If port 0 is specified Redis will not listen on a TCP socket.
25 port $REDIS_PORT
26
27 # If you want you can bind a single interface, if the bind option is not
28 # specified all the interfaces will listen for incoming connections.
29 #
30 # bind 127.0.0.1
31
32 # Specify the path for the unix socket that will be used to listen for
33 # incoming connections. There is no default, so Redis will not listen
34 # on a unix socket when not specified.
35 #
36 # unixsocket /tmp/redis.sock
37 # unixsocketperm 755
38
39 # Close the connection after a client is idle for N seconds (0 to disable)
40 timeout 0
41
42 # Set server verbosity to 'debug'
43 # it can be one of:
44 # debug (a lot of information, useful for development/testing)
45 # verbose (many rarely useful info, but not a mess like the debug level)
46 # notice (moderately verbose, what you want in production probably)
47 # warning (only very important / critical messages are logged)
48 loglevel notice
49
50 # Specify the log file name. Also 'stdout' can be used to force
51 # Redis to log on the standard output. Note that if you use standard
52 # output for logging but daemonize, logs will be sent to /dev/null
53 logfile $REDIS_LOG_FILE
54
55 # To enable logging to the system logger, just set 'syslog-enabled' to yes,
56 # and optionally update the other syslog parameters to suit your needs.
57 # syslog-enabled no
58
59 # Specify the syslog identity.
60 # syslog-ident redis
61
62 # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
63 # syslog-facility local0
64
65 # Set the number of databases. The default database is DB 0, you can select
66 # a different one on a per-connection basis using SELECT <dbid> where
67 # dbid is a number between 0 and 'databases'-1
68 databases 16
69
70 ################################ SNAPSHOTTING #################################
71 #
72 # Save the DB on disk:
73 #
74 # save <seconds> <changes>
75 #
76 # Will save the DB if both the given number of seconds and the given
77 # number of write operations against the DB occurred.
78 #
79 # In the example below the behaviour will be to save:
80 # after 900 sec (15 min) if at least 1 key changed
81 # after 300 sec (5 min) if at least 10 keys changed
82 # after 60 sec if at least 10000 keys changed
83 #
84 # Note: you can disable saving at all commenting all the "save" lines.
85 #
86 # It is also possible to remove all the previously configured save
87 # points by adding a save directive with a single empty string argument
88 # like in the following example:
89 #
90 # save ""
91
92 save 900 1
93 save 300 10
94 save 60 10000
95
96 # By default Redis will stop accepting writes if RDB snapshots are enabled
97 # (at least one save point) and the latest background save failed.
98 # This will make the user aware (in an hard way) that data is not persisting
99 # on disk properly, otherwise chances are that no one will notice and some
100 # distater will happen.
101 #
102 # If the background saving process will start working again Redis will
103 # automatically allow writes again.
104 #
105 # However if you have setup your proper monitoring of the Redis server
106 # and persistence, you may want to disable this feature so that Redis will
107 # continue to work as usually even if there are problems with disk,
108 # permissions, and so forth.
109 stop-writes-on-bgsave-error yes
110
111 # Compress string objects using LZF when dump .rdb databases?
112 # For default that's set to 'yes' as it's almost always a win.
113 # If you want to save some CPU in the saving child set it to 'no' but
114 # the dataset will likely be bigger if you have compressible values or keys.
115 rdbcompression yes
116
117 # The filename where to dump the DB
118 dbfilename dump.rdb
119
120 # The working directory.
121 #
122 # The DB will be written inside this directory, with the filename specified
123 # above using the 'dbfilename' configuration directive.
124 #
125 # Also the Append Only File will be created inside this directory.
126 #
127 # Note that you must specify a directory here, not a file name.
128 dir $REDIS_DATA_DIR
129
130 ################################# REPLICATION #################################
131
132 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
133 # another Redis server. Note that the configuration is local to the slave
134 # so for example it is possible to configure the slave to save the DB with a
135 # different interval, or to listen to another port, and so on.
136 #
137 # slaveof <masterip> <masterport>
138
139 # If the master is password protected (using the "requirepass" configuration
140 # directive below) it is possible to tell the slave to authenticate before
141 # starting the replication synchronization process, otherwise the master will
142 # refuse the slave request.
143 #
144 # masterauth <master-password>
145
146 # When a slave lost the connection with the master, or when the replication
147 # is still in progress, the slave can act in two different ways:
148 #
149 # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
150 # still reply to client requests, possibly with out of date data, or the
151 # data set may just be empty if this is the first synchronization.
152 #
153 # 2) if slave-serve-stale data is set to 'no' the slave will reply with
154 # an error "SYNC with master in progress" to all the kind of commands
155 # but to INFO and SLAVEOF.
156 #
157 slave-serve-stale-data yes
158
159 # Slaves send PINGs to server in a predefined interval. It's possible to change
160 # this interval with the repl_ping_slave_period option. The default value is 10
161 # seconds.
162 #
163 # repl-ping-slave-period 10
164
165 # The following option sets a timeout for both Bulk transfer I/O timeout and
166 # master data or ping response timeout. The default value is 60 seconds.
167 #
168 # It is important to make sure that this value is greater than the value
169 # specified for repl-ping-slave-period otherwise a timeout will be detected
170 # every time there is low traffic between the master and the slave.
171 #
172 # repl-timeout 60
173
174 ################################## SECURITY ###################################
175
176 # Require clients to issue AUTH <PASSWORD> before processing any other
177 # commands. This might be useful in environments in which you do not trust
178 # others with access to the host running redis-server.
179 #
180 # This should stay commented out for backward compatibility and because most
181 # people do not need auth (e.g. they run their own servers).
182 #
183 # Warning: since Redis is pretty fast an outside user can try up to
184 # 150k passwords per second against a good box. This means that you should
185 # use a very strong password otherwise it will be very easy to break.
186 #
187 # requirepass foobared
188
189 # Command renaming.
190 #
191 # It is possible to change the name of dangerous commands in a shared
192 # environment. For instance the CONFIG command may be renamed into something
193 # of hard to guess so that it will be still available for internal-use
194 # tools but not available for general clients.
195 #
196 # Example:
197 #
198 # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
199 #
200 # It is also possible to completely kill a command renaming it into
201 # an empty string:
202 #
203 # rename-command CONFIG ""
204
205 ################################### LIMITS ####################################
206
207 # Set the max number of connected clients at the same time. By default
208 # this limit is set to 10000 clients, however if the Redis server is not
209 # able ot configure the process file limit to allow for the specified limit
210 # the max number of allowed clients is set to the current file limit
211 # minus 32 (as Redis reserves a few file descriptors for internal uses).
212 #
213 # Once the limit is reached Redis will close all the new connections sending
214 # an error 'max number of clients reached'.
215 #
216 # maxclients 10000
217
218 # Don't use more memory than the specified amount of bytes.
219 # When the memory limit is reached Redis will try to remove keys
220 # accordingly to the eviction policy selected (see maxmemmory-policy).
221 #
222 # If Redis can't remove keys according to the policy, or if the policy is
223 # set to 'noeviction', Redis will start to reply with errors to commands
224 # that would use more memory, like SET, LPUSH, and so on, and will continue
225 # to reply to read-only commands like GET.
226 #
227 # This option is usually useful when using Redis as an LRU cache, or to set
228 # an hard memory limit for an instance (using the 'noeviction' policy).
229 #
230 # WARNING: If you have slaves attached to an instance with maxmemory on,
231 # the size of the output buffers needed to feed the slaves are subtracted
232 # from the used memory count, so that network problems / resyncs will
233 # not trigger a loop where keys are evicted, and in turn the output
234 # buffer of slaves is full with DELs of keys evicted triggering the deletion
235 # of more keys, and so forth until the database is completely emptied.
236 #
237 # In short... if you have slaves attached it is suggested that you set a lower
238 # limit for maxmemory so that there is some free RAM on the system for slave
239 # output buffers (but this is not needed if the policy is 'noeviction').
240 #
241 # maxmemory <bytes>
242
243 # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
244 # is reached? You can select among five behavior:
245 #
246 # volatile-lru -> remove the key with an expire set using an LRU algorithm
247 # allkeys-lru -> remove any key accordingly to the LRU algorithm
248 # volatile-random -> remove a random key with an expire set
249 # allkeys-random -> remove a random key, any key
250 # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
251 # noeviction -> don't expire at all, just return an error on write operations
252 #
253 # Note: with all the kind of policies, Redis will return an error on write
254 # operations, when there are not suitable keys for eviction.
255 #
256 # At the date of writing this commands are: set setnx setex append
257 # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
258 # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
259 # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
260 # getset mset msetnx exec sort
261 #
262 # The default is:
263 #
264 # maxmemory-policy volatile-lru
265
266 # LRU and minimal TTL algorithms are not precise algorithms but approximated
267 # algorithms (in order to save memory), so you can select as well the sample
268 # size to check. For instance for default Redis will check three keys and
269 # pick the one that was used less recently, you can change the sample size
270 # using the following configuration directive.
271 #
272 # maxmemory-samples 3
273
274 ############################## APPEND ONLY MODE ###############################
275
276 # By default Redis asynchronously dumps the dataset on disk. If you can live
277 # with the idea that the latest records will be lost if something like a crash
278 # happens this is the preferred way to run Redis. If instead you care a lot
279 # about your data and don't want to that a single record can get lost you should
280 # enable the append only mode: when this mode is enabled Redis will append
281 # every write operation received in the file appendonly.aof. This file will
282 # be read on startup in order to rebuild the full dataset in memory.
283 #
284 # Note that you can have both the async dumps and the append only file if you
285 # like (you have to comment the "save" statements above to disable the dumps).
286 # Still if append only mode is enabled Redis will load the data from the
287 # log file at startup ignoring the dump.rdb file.
288 #
289 # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
290 # log file in background when it gets too big.
291
292 appendonly no
293
294 # The name of the append only file (default: "appendonly.aof")
295 # appendfilename appendonly.aof
296
297 # The fsync() call tells the Operating System to actually write data on disk
298 # instead to wait for more data in the output buffer. Some OS will really flush
299 # data on disk, some other OS will just try to do it ASAP.
300 #
301 # Redis supports three different modes:
302 #
303 # no: don't fsync, just let the OS flush the data when it wants. Faster.
304 # always: fsync after every write to the append only log . Slow, Safest.
305 # everysec: fsync only if one second passed since the last fsync. Compromise.
306 #
307 # The default is "everysec" that's usually the right compromise between
308 # speed and data safety. It's up to you to understand if you can relax this to
309 # "no" that will let the operating system flush the output buffer when
310 # it wants, for better performances (but if you can live with the idea of
311 # some data loss consider the default persistence mode that's snapshotting),
312 # or on the contrary, use "always" that's very slow but a bit safer than
313 # everysec.
314 #
315 # If unsure, use "everysec".
316
317 # appendfsync always
318 appendfsync everysec
319 # appendfsync no
320
321 # When the AOF fsync policy is set to always or everysec, and a background
322 # saving process (a background save or AOF log background rewriting) is
323 # performing a lot of I/O against the disk, in some Linux configurations
324 # Redis may block too long on the fsync() call. Note that there is no fix for
325 # this currently, as even performing fsync in a different thread will block
326 # our synchronous write(2) call.
327 #
328 # In order to mitigate this problem it's possible to use the following option
329 # that will prevent fsync() from being called in the main process while a
330 # BGSAVE or BGREWRITEAOF is in progress.
331 #
332 # This means that while another child is saving the durability of Redis is
333 # the same as "appendfsync none", that in practical terms means that it is
334 # possible to lost up to 30 seconds of log in the worst scenario (with the
335 # default Linux settings).
336 #
337 # If you have latency problems turn this to "yes". Otherwise leave it as
338 # "no" that is the safest pick from the point of view of durability.
339 no-appendfsync-on-rewrite no
340
341 # Automatic rewrite of the append only file.
342 # Redis is able to automatically rewrite the log file implicitly calling
343 # BGREWRITEAOF when the AOF log size will growth by the specified percentage.
344 #
345 # This is how it works: Redis remembers the size of the AOF file after the
346 # latest rewrite (or if no rewrite happened since the restart, the size of
347 # the AOF at startup is used).
348 #
349 # This base size is compared to the current size. If the current size is
350 # bigger than the specified percentage, the rewrite is triggered. Also
351 # you need to specify a minimal size for the AOF file to be rewritten, this
352 # is useful to avoid rewriting the AOF file even if the percentage increase
353 # is reached but it is still pretty small.
354 #
355 # Specify a percentage of zero in order to disable the automatic AOF
356 # rewrite feature.
357
358 auto-aof-rewrite-percentage 100
359 auto-aof-rewrite-min-size 64mb
360
361 ################################ LUA SCRIPTING ###############################
362
363 # Max execution time of a Lua script in milliseconds.
364 #
365 # If the maximum execution time is reached Redis will log that a script is
366 # still in execution after the maximum allowed time and will start to
367 # reply to queries with an error.
368 #
369 # When a long running script exceed the maximum execution time only the
370 # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
371 # used to stop a script that did not yet called write commands. The second
372 # is the only way to shut down the server in the case a write commands was
373 # already issue by the script but the user don't want to wait for the natural
374 # termination of the script.
375 #
376 # Set it to 0 or a negative value for unlimited execution without warnings.
377 lua-time-limit 5000
378
379 ################################## SLOW LOG ###################################
380
381 # The Redis Slow Log is a system to log queries that exceeded a specified
382 # execution time. The execution time does not include the I/O operations
383 # like talking with the client, sending the reply and so forth,
384 # but just the time needed to actually execute the command (this is the only
385 # stage of command execution where the thread is blocked and can not serve
386 # other requests in the meantime).
387 #
388 # You can configure the slow log with two parameters: one tells Redis
389 # what is the execution time, in microseconds, to exceed in order for the
390 # command to get logged, and the other parameter is the length of the
391 # slow log. When a new command is logged the oldest one is removed from the
392 # queue of logged commands.
393
394 # The following time is expressed in microseconds, so 1000000 is equivalent
395 # to one second. Note that a negative number disables the slow log, while
396 # a value of zero forces the logging of every command.
397 slowlog-log-slower-than 10000
398
399 # There is no limit to this length. Just be aware that it will consume memory.
400 # You can reclaim memory used by the slow log with SLOWLOG RESET.
401 slowlog-max-len 1024
402
403 ############################### ADVANCED CONFIG ###############################
404
405 # Hashes are encoded using a memory efficient data structure when they have a
406 # small number of entries, and the biggest entry does not exceed a given
407 # threshold. These thresholds can be configured using the following directives.
408 hash-max-ziplist-entries 512
409 hash-max-ziplist-value 64
410
411 # Similarly to hashes, small lists are also encoded in a special way in order
412 # to save a lot of space. The special representation is only used when
413 # you are under the following limits:
414 list-max-ziplist-entries 512
415 list-max-ziplist-value 64
416
417 # Sets have a special encoding in just one case: when a set is composed
418 # of just strings that happens to be integers in radix 10 in the range
419 # of 64 bit signed integers.
420 # The following configuration setting sets the limit in the size of the
421 # set in order to use this special memory saving encoding.
422 set-max-intset-entries 512
423
424 # Similarly to hashes and lists, sorted sets are also specially encoded in
425 # order to save a lot of space. This encoding is only used when the length and
426 # elements of a sorted set are below the following limits:
427 zset-max-ziplist-entries 128
428 zset-max-ziplist-value 64
429
430 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
431 # order to help rehashing the main Redis hash table (the one mapping top-level
432 # keys to values). The hash table implementation Redis uses (see dict.c)
433 # performs a lazy rehashing: the more operation you run into an hash table
434 # that is rehashing, the more rehashing "steps" are performed, so if the
435 # server is idle the rehashing is never complete and some more memory is used
436 # by the hash table.
437 #
438 # The default is to use this millisecond 10 times every second in order to
439 # active rehashing the main dictionaries, freeing memory when possible.
440 #
441 # If unsure:
442 # use "activerehashing no" if you have hard latency requirements and it is
443 # not a good thing in your environment that Redis can reply form time to time
444 # to queries with 2 milliseconds delay.
445 #
446 # use "activerehashing yes" if you don't have such hard requirements but
447 # want to free memory asap when possible.
448 activerehashing yes
449
450 # The client output buffer limits can be used to force disconnection of clients
451 # that are not reading data from the server fast enough for some reason (a
452 # common reason is that a Pub/Sub client can't consume messages as fast as the
453 # publisher can produce them).
454 #
455 # The limit can be set differently for the three different classes of clients:
456 #
457 # normal -> normal clients
458 # slave -> slave clients and MONITOR clients
459 # pubsub -> clients subcribed to at least one pubsub channel or pattern
460 #
461 # The syntax of every client-output-buffer-limit directive is the following:
462 #
463 # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
464 #
465 # A client is immediately disconnected once the hard limit is reached, or if
466 # the soft limit is reached and remains reached for the specified number of
467 # seconds (continuously).
468 # So for instance if the hard limit is 32 megabytes and the soft limit is
469 # 16 megabytes / 10 seconds, the client will get disconnected immediately
470 # if the size of the output buffers reach 32 megabytes, but will also get
471 # disconnected if the client reaches 16 megabytes and continuously overcomes
472 # the limit for 10 seconds.
473 #
474 # By default normal clients are not limited because they don't receive data
475 # without asking (in a push way), but just after a request, so only
476 # asynchronous clients may create a scenario where data is requested faster
477 # than it can read.
478 #
479 # Instead there is a default limit for pubsub and slave clients, since
480 # subscribers and slaves receive data in a push fashion.
481 #
482 # Both the hard or the soft limit can be disabled just setting it to zero.
483 client-output-buffer-limit normal 0 0 0
484 client-output-buffer-limit slave 256mb 64mb 60
485 client-output-buffer-limit pubsub 32mb 8mb 60
486
487 ################################## INCLUDES ###################################
488
489 # Include one or more other config files here. This is useful if you
490 # have a standard template that goes to all Redis server but also need
491 # to customize a few per-server settings. Include files can include
492 # other files, so use this wisely.
493 #
494 # include /path/to/local.conf
495 # include /path/to/other.conf