autoscaler 0.4.1 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.md +11 -0
- data/README.md +1 -1
- data/examples/complex.rb +1 -1
- data/examples/simple.rb +1 -1
- data/lib/autoscaler/delayed_shutdown.rb +1 -1
- data/lib/autoscaler/sidekiq/celluloid_monitor.rb +1 -1
- data/lib/autoscaler/sidekiq/client.rb +25 -0
- data/lib/autoscaler/sidekiq/monitor_middleware_adapter.rb +1 -1
- data/lib/autoscaler/version.rb +1 -1
- data/spec/autoscaler/sidekiq/celluloid_monitor_spec.rb +9 -0
- data/spec/autoscaler/sidekiq/client_spec.rb +19 -4
- metadata +5 -23
- data/spec/redis_test.conf +0 -486
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,16 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 0.5.0
|
4
|
+
|
5
|
+
- Experimental: `Client#set_initial_workers` to start workers on main process startup; typically:
|
6
|
+
Autoscaler::Sidekiq::Client.add_to_chain(chain, 'default' => heroku).set_initial_workers
|
7
|
+
- Ensure that timeout is documented as being in seconds
|
8
|
+
- Convert gemspec to wildcard file selection
|
9
|
+
|
10
|
+
## 0.4.1
|
11
|
+
|
12
|
+
- Missing file from gemspec
|
13
|
+
|
3
14
|
## 0.4.0
|
4
15
|
|
5
16
|
- Experimental: The default scaling logic is contained in BinaryScalingStrategy. A strategy object can be passed instead of timeout to the server middleware.
|
data/README.md
CHANGED
@@ -30,7 +30,7 @@ Install the middleware in your `Sidekiq.configure_` blocks
|
|
30
30
|
|
31
31
|
Sidekiq.configure_server do |config|
|
32
32
|
config.server_middleware do |chain|
|
33
|
-
chain.add(Autoscaler::Sidekiq::Server, Autoscaler::HerokuScaler.new, 60)
|
33
|
+
chain.add(Autoscaler::Sidekiq::Server, Autoscaler::HerokuScaler.new, 60) # 60 second timeout
|
34
34
|
end
|
35
35
|
end
|
36
36
|
|
data/examples/complex.rb
CHANGED
@@ -31,7 +31,7 @@ Sidekiq.configure_server do |config|
|
|
31
31
|
config.server_middleware do |chain|
|
32
32
|
if heroku && ENV['HEROKU_PROCESS'] && heroku[ENV['HEROKU_PROCESS']]
|
33
33
|
p "Setting up auto-scaledown"
|
34
|
-
chain.add(Autoscaler::Sidekiq::Server, heroku[ENV['HEROKU_PROCESS']], 60, [ENV['HEROKU_PROCESS']])
|
34
|
+
chain.add(Autoscaler::Sidekiq::Server, heroku[ENV['HEROKU_PROCESS']], 60, [ENV['HEROKU_PROCESS']]) # 60 second timeout
|
35
35
|
else
|
36
36
|
p "Not scaleable"
|
37
37
|
end
|
data/examples/simple.rb
CHANGED
@@ -19,7 +19,7 @@ Sidekiq.configure_server do |config|
|
|
19
19
|
config.server_middleware do |chain|
|
20
20
|
if heroku
|
21
21
|
p "Setting up auto-scaledown"
|
22
|
-
chain.add(Autoscaler::Sidekiq::Server, heroku, 60)
|
22
|
+
chain.add(Autoscaler::Sidekiq::Server, heroku, 60) # 60 second timeout
|
23
23
|
else
|
24
24
|
p "Not scaleable"
|
25
25
|
end
|
@@ -2,7 +2,7 @@ module Autoscaler
|
|
2
2
|
# This is a sort of middleware that keeps the last worker up for a minimum amount of time
|
3
3
|
class DelayedShutdown
|
4
4
|
# @param [ScalingStrategy] strategy object that makes most decisions
|
5
|
-
# @param [Numeric] timeout
|
5
|
+
# @param [Numeric] timeout number of seconds to stay up after base strategy says zero
|
6
6
|
def initialize(strategy, timeout)
|
7
7
|
@strategy = strategy
|
8
8
|
@timeout = timeout
|
@@ -1,3 +1,6 @@
|
|
1
|
+
require 'autoscaler/binary_scaling_strategy'
|
2
|
+
require 'autoscaler/sidekiq/specified_queue_system'
|
3
|
+
|
1
4
|
module Autoscaler
|
2
5
|
module Sidekiq
|
3
6
|
# Sidekiq client middleware
|
@@ -18,6 +21,28 @@ module Autoscaler
|
|
18
21
|
|
19
22
|
yield
|
20
23
|
end
|
24
|
+
|
25
|
+
# Check for interrupted or scheduled work on startup.
|
26
|
+
# Typically you need to construct your own instance just
|
27
|
+
# to call this method, but see add_to_chain.
|
28
|
+
# @param [Strategy] strategy object that determines target workers
|
29
|
+
# @yieldparam [String] queue mostly for testing
|
30
|
+
# @yieldreturn [QueueSystem] mostly for testing
|
31
|
+
def set_initial_workers(strategy = nil, &system_factory)
|
32
|
+
strategy ||= BinaryScalingStrategy.new
|
33
|
+
system_factory ||= lambda {|queue| SpecifiedQueueSystem.new([queue])}
|
34
|
+
@scalers.each do |queue, scaler|
|
35
|
+
scaler.workers = strategy.call(system_factory.call(queue), 0)
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
# Convenience method to avoid having to name the class and parameter
|
40
|
+
# twice when calling set_initial_workers
|
41
|
+
# @return [Client] an instance of Client for set_initial_workers
|
42
|
+
def self.add_to_chain(chain, scalers)
|
43
|
+
chain.add self, scalers
|
44
|
+
new(scalers)
|
45
|
+
end
|
21
46
|
end
|
22
47
|
end
|
23
48
|
end
|
@@ -9,7 +9,7 @@ module Autoscaler
|
|
9
9
|
# Starts the monitor and notifies it of job events that may occur while it's sleeping
|
10
10
|
class MonitorMiddlewareAdapter
|
11
11
|
# @param [scaler] scaler object that actually performs scaling operations (e.g. {HerokuScaler})
|
12
|
-
# @param [Strategy,Numeric] timeout strategy object that determines target workers, or a timeout to be passed to {DelayedShutdown}+{BinaryScalingStrategy}
|
12
|
+
# @param [Strategy,Numeric] timeout strategy object that determines target workers, or a timeout in seconds to be passed to {DelayedShutdown}+{BinaryScalingStrategy}
|
13
13
|
# @param [Array[String]] specified_queues list of queues to monitor to determine if there is work left. Defaults to all sidekiq queues.
|
14
14
|
def initialize(scaler, timeout, specified_queues = nil)
|
15
15
|
unless monitor
|
data/lib/autoscaler/version.rb
CHANGED
@@ -27,4 +27,13 @@ describe Autoscaler::Sidekiq::CelluloidMonitor do
|
|
27
27
|
scaler.workers.should == 1
|
28
28
|
manager.terminate
|
29
29
|
end
|
30
|
+
|
31
|
+
it "will downscale with initial workers zero" do
|
32
|
+
system = TestSystem.new(0)
|
33
|
+
scaler = TestScaler.new(0)
|
34
|
+
manager = cut.new(scaler, lambda{|s,t| 0}, system)
|
35
|
+
Timeout.timeout(1) { manager.wait_for_downscale(0.5) }
|
36
|
+
scaler.workers.should == 0
|
37
|
+
manager.terminate
|
38
|
+
end
|
30
39
|
end
|
@@ -1,4 +1,5 @@
|
|
1
1
|
require 'spec_helper'
|
2
|
+
require 'test_system'
|
2
3
|
require 'autoscaler/sidekiq/client'
|
3
4
|
|
4
5
|
describe Autoscaler::Sidekiq::Client do
|
@@ -6,10 +7,24 @@ describe Autoscaler::Sidekiq::Client do
|
|
6
7
|
let(:scaler) {TestScaler.new(0)}
|
7
8
|
let(:client) {cut.new('queue' => scaler)}
|
8
9
|
|
9
|
-
|
10
|
-
|
11
|
-
|
10
|
+
describe 'call' do
|
11
|
+
it 'scales' do
|
12
|
+
client.call(Class, {}, 'queue') {}
|
13
|
+
scaler.workers.should == 1
|
14
|
+
end
|
15
|
+
|
16
|
+
it('yields') {client.call(Class, {}, 'queue') {:foo}.should == :foo}
|
12
17
|
end
|
13
18
|
|
14
|
-
|
19
|
+
describe 'initial workers' do
|
20
|
+
it 'works with default arguments' do
|
21
|
+
client.set_initial_workers
|
22
|
+
scaler.workers.should == 0
|
23
|
+
end
|
24
|
+
|
25
|
+
it 'scales when necessary' do
|
26
|
+
client.set_initial_workers {|q| TestSystem.new(1)}
|
27
|
+
scaler.workers.should == 1
|
28
|
+
end
|
29
|
+
end
|
15
30
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: autoscaler
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.0
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -10,7 +10,7 @@ authors:
|
|
10
10
|
autorequire:
|
11
11
|
bindir: bin
|
12
12
|
cert_chain: []
|
13
|
-
date: 2013-
|
13
|
+
date: 2013-08-21 00:00:00.000000000 Z
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
16
16
|
name: sidekiq
|
@@ -60,22 +60,6 @@ dependencies:
|
|
60
60
|
- - ! '>='
|
61
61
|
- !ruby/object:Gem::Version
|
62
62
|
version: '0'
|
63
|
-
- !ruby/object:Gem::Dependency
|
64
|
-
name: mast
|
65
|
-
requirement: !ruby/object:Gem::Requirement
|
66
|
-
none: false
|
67
|
-
requirements:
|
68
|
-
- - ! '>='
|
69
|
-
- !ruby/object:Gem::Version
|
70
|
-
version: '0'
|
71
|
-
type: :development
|
72
|
-
prerelease: false
|
73
|
-
version_requirements: !ruby/object:Gem::Requirement
|
74
|
-
none: false
|
75
|
-
requirements:
|
76
|
-
- - ! '>='
|
77
|
-
- !ruby/object:Gem::Version
|
78
|
-
version: '0'
|
79
63
|
- !ruby/object:Gem::Dependency
|
80
64
|
name: rspec
|
81
65
|
requirement: !ruby/object:Gem::Requirement
|
@@ -132,6 +116,8 @@ executables: []
|
|
132
116
|
extensions: []
|
133
117
|
extra_rdoc_files: []
|
134
118
|
files:
|
119
|
+
- CHANGELOG.md
|
120
|
+
- README.md
|
135
121
|
- lib/autoscaler/binary_scaling_strategy.rb
|
136
122
|
- lib/autoscaler/delayed_shutdown.rb
|
137
123
|
- lib/autoscaler/heroku_scaler.rb
|
@@ -147,8 +133,6 @@ files:
|
|
147
133
|
- lib/autoscaler/stub_scaler.rb
|
148
134
|
- lib/autoscaler/version.rb
|
149
135
|
- lib/autoscaler.rb
|
150
|
-
- README.md
|
151
|
-
- CHANGELOG.md
|
152
136
|
- examples/complex.rb
|
153
137
|
- examples/simple.rb
|
154
138
|
- Guardfile
|
@@ -162,7 +146,6 @@ files:
|
|
162
146
|
- spec/autoscaler/sidekiq/monitor_middleware_adapter_spec.rb
|
163
147
|
- spec/autoscaler/sidekiq/sleep_wait_server_spec.rb
|
164
148
|
- spec/autoscaler/sidekiq/specified_queue_system_spec.rb
|
165
|
-
- spec/redis_test.conf
|
166
149
|
- spec/spec_helper.rb
|
167
150
|
- spec/test_system.rb
|
168
151
|
homepage: ''
|
@@ -185,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
185
168
|
version: '0'
|
186
169
|
requirements: []
|
187
170
|
rubyforge_project: autoscaler
|
188
|
-
rubygems_version: 1.8.
|
171
|
+
rubygems_version: 1.8.25
|
189
172
|
signing_key:
|
190
173
|
specification_version: 3
|
191
174
|
summary: Start/stop Sidekiq workers on Heroku
|
@@ -201,7 +184,6 @@ test_files:
|
|
201
184
|
- spec/autoscaler/sidekiq/monitor_middleware_adapter_spec.rb
|
202
185
|
- spec/autoscaler/sidekiq/sleep_wait_server_spec.rb
|
203
186
|
- spec/autoscaler/sidekiq/specified_queue_system_spec.rb
|
204
|
-
- spec/redis_test.conf
|
205
187
|
- spec/spec_helper.rb
|
206
188
|
- spec/test_system.rb
|
207
189
|
has_rdoc:
|
data/spec/redis_test.conf
DELETED
@@ -1,486 +0,0 @@
|
|
1
|
-
# Redis configuration file example
|
2
|
-
|
3
|
-
# Note on units: when memory size is needed, it is possible to specifiy
|
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 no
|
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 /var/run/redis.pid
|
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 9736
|
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 60
|
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 stdout
|
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 1
|
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
|
-
#save 900 1
|
87
|
-
#save 300 10
|
88
|
-
#save 60 10000
|
89
|
-
|
90
|
-
# Compress string objects using LZF when dump .rdb databases?
|
91
|
-
# For default that's set to 'yes' as it's almost always a win.
|
92
|
-
# If you want to save some CPU in the saving child set it to 'no' but
|
93
|
-
# the dataset will likely be bigger if you have compressible values or keys.
|
94
|
-
rdbcompression yes
|
95
|
-
|
96
|
-
# The filename where to dump the DB
|
97
|
-
dbfilename autoscaler_redis_test.rdb
|
98
|
-
|
99
|
-
# The working directory.
|
100
|
-
#
|
101
|
-
# The DB will be written inside this directory, with the filename specified
|
102
|
-
# above using the 'dbfilename' configuration directive.
|
103
|
-
#
|
104
|
-
# Also the Append Only File will be created inside this directory.
|
105
|
-
#
|
106
|
-
# Note that you must specify a directory here, not a file name.
|
107
|
-
dir /tmp/
|
108
|
-
|
109
|
-
################################# REPLICATION #################################
|
110
|
-
|
111
|
-
# Master-Slave replication. Use slaveof to make a Redis instance a copy of
|
112
|
-
# another Redis server. Note that the configuration is local to the slave
|
113
|
-
# so for example it is possible to configure the slave to save the DB with a
|
114
|
-
# different interval, or to listen to another port, and so on.
|
115
|
-
#
|
116
|
-
# slaveof <masterip> <masterport>
|
117
|
-
|
118
|
-
# If the master is password protected (using the "requirepass" configuration
|
119
|
-
# directive below) it is possible to tell the slave to authenticate before
|
120
|
-
# starting the replication synchronization process, otherwise the master will
|
121
|
-
# refuse the slave request.
|
122
|
-
#
|
123
|
-
# masterauth <master-password>
|
124
|
-
|
125
|
-
# When a slave lost the connection with the master, or when the replication
|
126
|
-
# is still in progress, the slave can act in two different ways:
|
127
|
-
#
|
128
|
-
# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
|
129
|
-
# still reply to client requests, possibly with out of data data, or the
|
130
|
-
# data set may just be empty if this is the first synchronization.
|
131
|
-
#
|
132
|
-
# 2) if slave-serve-stale data is set to 'no' the slave will reply with
|
133
|
-
# an error "SYNC with master in progress" to all the kind of commands
|
134
|
-
# but to INFO and SLAVEOF.
|
135
|
-
#
|
136
|
-
slave-serve-stale-data yes
|
137
|
-
|
138
|
-
# Slaves send PINGs to server in a predefined interval. It's possible to change
|
139
|
-
# this interval with the repl_ping_slave_period option. The default value is 10
|
140
|
-
# seconds.
|
141
|
-
#
|
142
|
-
# repl-ping-slave-period 10
|
143
|
-
|
144
|
-
# The following option sets a timeout for both Bulk transfer I/O timeout and
|
145
|
-
# master data or ping response timeout. The default value is 60 seconds.
|
146
|
-
#
|
147
|
-
# It is important to make sure that this value is greater than the value
|
148
|
-
# specified for repl-ping-slave-period otherwise a timeout will be detected
|
149
|
-
# every time there is low traffic between the master and the slave.
|
150
|
-
#
|
151
|
-
# repl-timeout 60
|
152
|
-
|
153
|
-
################################## SECURITY ###################################
|
154
|
-
|
155
|
-
# Require clients to issue AUTH <PASSWORD> before processing any other
|
156
|
-
# commands. This might be useful in environments in which you do not trust
|
157
|
-
# others with access to the host running redis-server.
|
158
|
-
#
|
159
|
-
# This should stay commented out for backward compatibility and because most
|
160
|
-
# people do not need auth (e.g. they run their own servers).
|
161
|
-
#
|
162
|
-
# Warning: since Redis is pretty fast an outside user can try up to
|
163
|
-
# 150k passwords per second against a good box. This means that you should
|
164
|
-
# use a very strong password otherwise it will be very easy to break.
|
165
|
-
#
|
166
|
-
# requirepass foobared
|
167
|
-
|
168
|
-
# Command renaming.
|
169
|
-
#
|
170
|
-
# It is possilbe to change the name of dangerous commands in a shared
|
171
|
-
# environment. For instance the CONFIG command may be renamed into something
|
172
|
-
# of hard to guess so that it will be still available for internal-use
|
173
|
-
# tools but not available for general clients.
|
174
|
-
#
|
175
|
-
# Example:
|
176
|
-
#
|
177
|
-
# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
|
178
|
-
#
|
179
|
-
# It is also possilbe to completely kill a command renaming it into
|
180
|
-
# an empty string:
|
181
|
-
#
|
182
|
-
# rename-command CONFIG ""
|
183
|
-
|
184
|
-
################################### LIMITS ####################################
|
185
|
-
|
186
|
-
# Set the max number of connected clients at the same time. By default there
|
187
|
-
# is no limit, and it's up to the number of file descriptors the Redis process
|
188
|
-
# is able to open. The special value '0' means no limits.
|
189
|
-
# Once the limit is reached Redis will close all the new connections sending
|
190
|
-
# an error 'max number of clients reached'.
|
191
|
-
#
|
192
|
-
maxclients 10
|
193
|
-
|
194
|
-
# Don't use more memory than the specified amount of bytes.
|
195
|
-
# When the memory limit is reached Redis will try to remove keys with an
|
196
|
-
# EXPIRE set. It will try to start freeing keys that are going to expire
|
197
|
-
# in little time and preserve keys with a longer time to live.
|
198
|
-
# Redis will also try to remove objects from free lists if possible.
|
199
|
-
#
|
200
|
-
# If all this fails, Redis will start to reply with errors to commands
|
201
|
-
# that will use more memory, like SET, LPUSH, and so on, and will continue
|
202
|
-
# to reply to most read-only commands like GET.
|
203
|
-
#
|
204
|
-
# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
|
205
|
-
# 'state' server or cache, not as a real DB. When Redis is used as a real
|
206
|
-
# database the memory usage will grow over the weeks, it will be obvious if
|
207
|
-
# it is going to use too much memory in the long run, and you'll have the time
|
208
|
-
# to upgrade. With maxmemory after the limit is reached you'll start to get
|
209
|
-
# errors for write operations, and this may even lead to DB inconsistency.
|
210
|
-
#
|
211
|
-
# maxmemory <bytes>
|
212
|
-
|
213
|
-
# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
|
214
|
-
# is reached? You can select among five behavior:
|
215
|
-
#
|
216
|
-
# volatile-lru -> remove the key with an expire set using an LRU algorithm
|
217
|
-
# allkeys-lru -> remove any key accordingly to the LRU algorithm
|
218
|
-
# volatile-random -> remove a random key with an expire set
|
219
|
-
# allkeys->random -> remove a random key, any key
|
220
|
-
# volatile-ttl -> remove the key with the nearest expire time (minor TTL)
|
221
|
-
# noeviction -> don't expire at all, just return an error on write operations
|
222
|
-
#
|
223
|
-
# Note: with all the kind of policies, Redis will return an error on write
|
224
|
-
# operations, when there are not suitable keys for eviction.
|
225
|
-
#
|
226
|
-
# At the date of writing this commands are: set setnx setex append
|
227
|
-
# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
|
228
|
-
# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
|
229
|
-
# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
|
230
|
-
# getset mset msetnx exec sort
|
231
|
-
#
|
232
|
-
# The default is:
|
233
|
-
#
|
234
|
-
# maxmemory-policy volatile-lru
|
235
|
-
|
236
|
-
# LRU and minimal TTL algorithms are not precise algorithms but approximated
|
237
|
-
# algorithms (in order to save memory), so you can select as well the sample
|
238
|
-
# size to check. For instance for default Redis will check three keys and
|
239
|
-
# pick the one that was used less recently, you can change the sample size
|
240
|
-
# using the following configuration directive.
|
241
|
-
#
|
242
|
-
# maxmemory-samples 3
|
243
|
-
|
244
|
-
############################## APPEND ONLY MODE ###############################
|
245
|
-
|
246
|
-
# By default Redis asynchronously dumps the dataset on disk. If you can live
|
247
|
-
# with the idea that the latest records will be lost if something like a crash
|
248
|
-
# happens this is the preferred way to run Redis. If instead you care a lot
|
249
|
-
# about your data and don't want to that a single record can get lost you should
|
250
|
-
# enable the append only mode: when this mode is enabled Redis will append
|
251
|
-
# every write operation received in the file appendonly.aof. This file will
|
252
|
-
# be read on startup in order to rebuild the full dataset in memory.
|
253
|
-
#
|
254
|
-
# Note that you can have both the async dumps and the append only file if you
|
255
|
-
# like (you have to comment the "save" statements above to disable the dumps).
|
256
|
-
# Still if append only mode is enabled Redis will load the data from the
|
257
|
-
# log file at startup ignoring the dump.rdb file.
|
258
|
-
#
|
259
|
-
# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
|
260
|
-
# log file in background when it gets too big.
|
261
|
-
|
262
|
-
appendonly no
|
263
|
-
|
264
|
-
# The name of the append only file (default: "appendonly.aof")
|
265
|
-
# appendfilename appendonly.aof
|
266
|
-
|
267
|
-
# The fsync() call tells the Operating System to actually write data on disk
|
268
|
-
# instead to wait for more data in the output buffer. Some OS will really flush
|
269
|
-
# data on disk, some other OS will just try to do it ASAP.
|
270
|
-
#
|
271
|
-
# Redis supports three different modes:
|
272
|
-
#
|
273
|
-
# no: don't fsync, just let the OS flush the data when it wants. Faster.
|
274
|
-
# always: fsync after every write to the append only log . Slow, Safest.
|
275
|
-
# everysec: fsync only if one second passed since the last fsync. Compromise.
|
276
|
-
#
|
277
|
-
# The default is "everysec" that's usually the right compromise between
|
278
|
-
# speed and data safety. It's up to you to understand if you can relax this to
|
279
|
-
# "no" that will will let the operating system flush the output buffer when
|
280
|
-
# it wants, for better performances (but if you can live with the idea of
|
281
|
-
# some data loss consider the default persistence mode that's snapshotting),
|
282
|
-
# or on the contrary, use "always" that's very slow but a bit safer than
|
283
|
-
# everysec.
|
284
|
-
#
|
285
|
-
# If unsure, use "everysec".
|
286
|
-
|
287
|
-
# appendfsync always
|
288
|
-
appendfsync everysec
|
289
|
-
# appendfsync no
|
290
|
-
|
291
|
-
# When the AOF fsync policy is set to always or everysec, and a background
|
292
|
-
# saving process (a background save or AOF log background rewriting) is
|
293
|
-
# performing a lot of I/O against the disk, in some Linux configurations
|
294
|
-
# Redis may block too long on the fsync() call. Note that there is no fix for
|
295
|
-
# this currently, as even performing fsync in a different thread will block
|
296
|
-
# our synchronous write(2) call.
|
297
|
-
#
|
298
|
-
# In order to mitigate this problem it's possible to use the following option
|
299
|
-
# that will prevent fsync() from being called in the main process while a
|
300
|
-
# BGSAVE or BGREWRITEAOF is in progress.
|
301
|
-
#
|
302
|
-
# This means that while another child is saving the durability of Redis is
|
303
|
-
# the same as "appendfsync none", that in pratical terms means that it is
|
304
|
-
# possible to lost up to 30 seconds of log in the worst scenario (with the
|
305
|
-
# default Linux settings).
|
306
|
-
#
|
307
|
-
# If you have latency problems turn this to "yes". Otherwise leave it as
|
308
|
-
# "no" that is the safest pick from the point of view of durability.
|
309
|
-
no-appendfsync-on-rewrite no
|
310
|
-
|
311
|
-
# Automatic rewrite of the append only file.
|
312
|
-
# Redis is able to automatically rewrite the log file implicitly calling
|
313
|
-
# BGREWRITEAOF when the AOF log size will growth by the specified percentage.
|
314
|
-
#
|
315
|
-
# This is how it works: Redis remembers the size of the AOF file after the
|
316
|
-
# latest rewrite (or if no rewrite happened since the restart, the size of
|
317
|
-
# the AOF at startup is used).
|
318
|
-
#
|
319
|
-
# This base size is compared to the current size. If the current size is
|
320
|
-
# bigger than the specified percentage, the rewrite is triggered. Also
|
321
|
-
# you need to specify a minimal size for the AOF file to be rewritten, this
|
322
|
-
# is useful to avoid rewriting the AOF file even if the percentage increase
|
323
|
-
# is reached but it is still pretty small.
|
324
|
-
#
|
325
|
-
# Specify a precentage of zero in order to disable the automatic AOF
|
326
|
-
# rewrite feature.
|
327
|
-
|
328
|
-
auto-aof-rewrite-percentage 100
|
329
|
-
auto-aof-rewrite-min-size 64mb
|
330
|
-
|
331
|
-
################################## SLOW LOG ###################################
|
332
|
-
|
333
|
-
# The Redis Slow Log is a system to log queries that exceeded a specified
|
334
|
-
# execution time. The execution time does not include the I/O operations
|
335
|
-
# like talking with the client, sending the reply and so forth,
|
336
|
-
# but just the time needed to actually execute the command (this is the only
|
337
|
-
# stage of command execution where the thread is blocked and can not serve
|
338
|
-
# other requests in the meantime).
|
339
|
-
#
|
340
|
-
# You can configure the slow log with two parameters: one tells Redis
|
341
|
-
# what is the execution time, in microseconds, to exceed in order for the
|
342
|
-
# command to get logged, and the other parameter is the length of the
|
343
|
-
# slow log. When a new command is logged the oldest one is removed from the
|
344
|
-
# queue of logged commands.
|
345
|
-
|
346
|
-
# The following time is expressed in microseconds, so 1000000 is equivalent
|
347
|
-
# to one second. Note that a negative number disables the slow log, while
|
348
|
-
# a value of zero forces the logging of every command.
|
349
|
-
slowlog-log-slower-than 10000
|
350
|
-
|
351
|
-
# There is no limit to this length. Just be aware that it will consume memory.
|
352
|
-
# You can reclaim memory used by the slow log with SLOWLOG RESET.
|
353
|
-
slowlog-max-len 1024
|
354
|
-
|
355
|
-
################################ VIRTUAL MEMORY ###############################
|
356
|
-
|
357
|
-
### WARNING! Virtual Memory is deprecated in Redis 2.4
|
358
|
-
### The use of Virtual Memory is strongly discouraged.
|
359
|
-
|
360
|
-
# Virtual Memory allows Redis to work with datasets bigger than the actual
|
361
|
-
# amount of RAM needed to hold the whole dataset in memory.
|
362
|
-
# In order to do so very used keys are taken in memory while the other keys
|
363
|
-
# are swapped into a swap file, similarly to what operating systems do
|
364
|
-
# with memory pages.
|
365
|
-
#
|
366
|
-
# To enable VM just set 'vm-enabled' to yes, and set the following three
|
367
|
-
# VM parameters accordingly to your needs.
|
368
|
-
|
369
|
-
vm-enabled no
|
370
|
-
# vm-enabled yes
|
371
|
-
|
372
|
-
# This is the path of the Redis swap file. As you can guess, swap files
|
373
|
-
# can't be shared by different Redis instances, so make sure to use a swap
|
374
|
-
# file for every redis process you are running. Redis will complain if the
|
375
|
-
# swap file is already in use.
|
376
|
-
#
|
377
|
-
# The best kind of storage for the Redis swap file (that's accessed at random)
|
378
|
-
# is a Solid State Disk (SSD).
|
379
|
-
#
|
380
|
-
# *** WARNING *** if you are using a shared hosting the default of putting
|
381
|
-
# the swap file under /tmp is not secure. Create a dir with access granted
|
382
|
-
# only to Redis user and configure Redis to create the swap file there.
|
383
|
-
vm-swap-file /tmp/redis.swap
|
384
|
-
|
385
|
-
# vm-max-memory configures the VM to use at max the specified amount of
|
386
|
-
# RAM. Everything that deos not fit will be swapped on disk *if* possible, that
|
387
|
-
# is, if there is still enough contiguous space in the swap file.
|
388
|
-
#
|
389
|
-
# With vm-max-memory 0 the system will swap everything it can. Not a good
|
390
|
-
# default, just specify the max amount of RAM you can in bytes, but it's
|
391
|
-
# better to leave some margin. For instance specify an amount of RAM
|
392
|
-
# that's more or less between 60 and 80% of your free RAM.
|
393
|
-
vm-max-memory 0
|
394
|
-
|
395
|
-
# Redis swap files is split into pages. An object can be saved using multiple
|
396
|
-
# contiguous pages, but pages can't be shared between different objects.
|
397
|
-
# So if your page is too big, small objects swapped out on disk will waste
|
398
|
-
# a lot of space. If you page is too small, there is less space in the swap
|
399
|
-
# file (assuming you configured the same number of total swap file pages).
|
400
|
-
#
|
401
|
-
# If you use a lot of small objects, use a page size of 64 or 32 bytes.
|
402
|
-
# If you use a lot of big objects, use a bigger page size.
|
403
|
-
# If unsure, use the default :)
|
404
|
-
vm-page-size 32
|
405
|
-
|
406
|
-
# Number of total memory pages in the swap file.
|
407
|
-
# Given that the page table (a bitmap of free/used pages) is taken in memory,
|
408
|
-
# every 8 pages on disk will consume 1 byte of RAM.
|
409
|
-
#
|
410
|
-
# The total swap size is vm-page-size * vm-pages
|
411
|
-
#
|
412
|
-
# With the default of 32-bytes memory pages and 134217728 pages Redis will
|
413
|
-
# use a 4 GB swap file, that will use 16 MB of RAM for the page table.
|
414
|
-
#
|
415
|
-
# It's better to use the smallest acceptable value for your application,
|
416
|
-
# but the default is large in order to work in most conditions.
|
417
|
-
vm-pages 134217728
|
418
|
-
|
419
|
-
# Max number of VM I/O threads running at the same time.
|
420
|
-
# This threads are used to read/write data from/to swap file, since they
|
421
|
-
# also encode and decode objects from disk to memory or the reverse, a bigger
|
422
|
-
# number of threads can help with big objects even if they can't help with
|
423
|
-
# I/O itself as the physical device may not be able to couple with many
|
424
|
-
# reads/writes operations at the same time.
|
425
|
-
#
|
426
|
-
# The special value of 0 turn off threaded I/O and enables the blocking
|
427
|
-
# Virtual Memory implementation.
|
428
|
-
vm-max-threads 4
|
429
|
-
|
430
|
-
############################### ADVANCED CONFIG ###############################
|
431
|
-
|
432
|
-
# Hashes are encoded in a special way (much more memory efficient) when they
|
433
|
-
# have at max a given numer of elements, and the biggest element does not
|
434
|
-
# exceed a given threshold. You can configure this limits with the following
|
435
|
-
# configuration directives.
|
436
|
-
hash-max-zipmap-entries 512
|
437
|
-
hash-max-zipmap-value 64
|
438
|
-
|
439
|
-
# Similarly to hashes, small lists are also encoded in a special way in order
|
440
|
-
# to save a lot of space. The special representation is only used when
|
441
|
-
# you are under the following limits:
|
442
|
-
list-max-ziplist-entries 512
|
443
|
-
list-max-ziplist-value 64
|
444
|
-
|
445
|
-
# Sets have a special encoding in just one case: when a set is composed
|
446
|
-
# of just strings that happens to be integers in radix 10 in the range
|
447
|
-
# of 64 bit signed integers.
|
448
|
-
# The following configuration setting sets the limit in the size of the
|
449
|
-
# set in order to use this special memory saving encoding.
|
450
|
-
set-max-intset-entries 512
|
451
|
-
|
452
|
-
# Similarly to hashes and lists, sorted sets are also specially encoded in
|
453
|
-
# order to save a lot of space. This encoding is only used when the length and
|
454
|
-
# elements of a sorted set are below the following limits:
|
455
|
-
zset-max-ziplist-entries 128
|
456
|
-
zset-max-ziplist-value 64
|
457
|
-
|
458
|
-
# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
|
459
|
-
# order to help rehashing the main Redis hash table (the one mapping top-level
|
460
|
-
# keys to values). The hash table implementation redis uses (see dict.c)
|
461
|
-
# performs a lazy rehashing: the more operation you run into an hash table
|
462
|
-
# that is rhashing, the more rehashing "steps" are performed, so if the
|
463
|
-
# server is idle the rehashing is never complete and some more memory is used
|
464
|
-
# by the hash table.
|
465
|
-
#
|
466
|
-
# The default is to use this millisecond 10 times every second in order to
|
467
|
-
# active rehashing the main dictionaries, freeing memory when possible.
|
468
|
-
#
|
469
|
-
# If unsure:
|
470
|
-
# use "activerehashing no" if you have hard latency requirements and it is
|
471
|
-
# not a good thing in your environment that Redis can reply form time to time
|
472
|
-
# to queries with 2 milliseconds delay.
|
473
|
-
#
|
474
|
-
# use "activerehashing yes" if you don't have such hard requirements but
|
475
|
-
# want to free memory asap when possible.
|
476
|
-
activerehashing yes
|
477
|
-
|
478
|
-
################################## INCLUDES ###################################
|
479
|
-
|
480
|
-
# Include one or more other config files here. This is useful if you
|
481
|
-
# have a standard template that goes to all redis server but also need
|
482
|
-
# to customize a few per-server settings. Include files can include
|
483
|
-
# other files, so use this wisely.
|
484
|
-
#
|
485
|
-
# include /path/to/local.conf
|
486
|
-
# include /path/to/other.conf
|