instructure-redis-store 1.0.0.1.instructure1
Sign up to get free protection for your applications and to get access to all the features.
- data/.travis.yml +7 -0
- data/CHANGELOG +311 -0
- data/Gemfile +34 -0
- data/MIT-LICENSE +20 -0
- data/README.md +239 -0
- data/Rakefile +60 -0
- data/VERSION +1 -0
- data/lib/action_controller/session/redis_session_store.rb +81 -0
- data/lib/active_support/cache/redis_store.rb +254 -0
- data/lib/cache/merb/redis_store.rb +79 -0
- data/lib/cache/sinatra/redis_store.rb +131 -0
- data/lib/i18n/backend/redis.rb +67 -0
- data/lib/rack/cache/redis_entitystore.rb +48 -0
- data/lib/rack/cache/redis_metastore.rb +40 -0
- data/lib/rack/session/merb.rb +32 -0
- data/lib/rack/session/redis.rb +88 -0
- data/lib/redis-store.rb +45 -0
- data/lib/redis/distributed_store.rb +39 -0
- data/lib/redis/factory.rb +46 -0
- data/lib/redis/store.rb +39 -0
- data/lib/redis/store/interface.rb +17 -0
- data/lib/redis/store/marshalling.rb +51 -0
- data/lib/redis/store/namespace.rb +62 -0
- data/lib/redis/store/ttl.rb +37 -0
- data/lib/redis/store/version.rb +12 -0
- data/spec/action_controller/session/redis_session_store_spec.rb +126 -0
- data/spec/active_support/cache/redis_store_spec.rb +426 -0
- data/spec/cache/merb/redis_store_spec.rb +143 -0
- data/spec/cache/sinatra/redis_store_spec.rb +192 -0
- data/spec/config/node-one.conf +417 -0
- data/spec/config/node-two.conf +417 -0
- data/spec/config/redis.conf +417 -0
- data/spec/i18n/backend/redis_spec.rb +72 -0
- data/spec/rack/cache/entitystore/pony.jpg +0 -0
- data/spec/rack/cache/entitystore/redis_spec.rb +124 -0
- data/spec/rack/cache/metastore/redis_spec.rb +259 -0
- data/spec/rack/session/redis_spec.rb +234 -0
- data/spec/redis/distributed_store_spec.rb +55 -0
- data/spec/redis/factory_spec.rb +110 -0
- data/spec/redis/store/interface_spec.rb +23 -0
- data/spec/redis/store/marshalling_spec.rb +119 -0
- data/spec/redis/store/namespace_spec.rb +76 -0
- data/spec/redis/store/version_spec.rb +7 -0
- data/spec/redis/store_spec.rb +13 -0
- data/spec/spec_helper.rb +43 -0
- data/tasks/redis.tasks.rb +235 -0
- metadata +249 -0
@@ -0,0 +1,143 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
module Merb
|
4
|
+
module Cache
|
5
|
+
describe "Merb::Cache::RedisStore" do
|
6
|
+
before(:each) do
|
7
|
+
@store = Merb::Cache::RedisStore.new
|
8
|
+
@dstore = Merb::Cache::RedisStore.new :servers => ["redis://127.0.0.1:6380/1", "redis://127.0.0.1:6381/1"]
|
9
|
+
@rabbit = OpenStruct.new :name => "bunny"
|
10
|
+
@white_rabbit = OpenStruct.new :color => "white"
|
11
|
+
with_store_management do |store|
|
12
|
+
store.write "rabbit", @rabbit
|
13
|
+
store.delete "rub-a-dub"
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
it "should accept connection params" do
|
18
|
+
redis = instantiate_store
|
19
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 0"
|
20
|
+
|
21
|
+
redis = instantiate_store "redis://127.0.0.1"
|
22
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 0"
|
23
|
+
|
24
|
+
redis = instantiate_store "redis://127.0.0.1:6380"
|
25
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6380 against DB 0"
|
26
|
+
|
27
|
+
redis = instantiate_store "redis://127.0.0.1:6380/13"
|
28
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6380 against DB 13"
|
29
|
+
|
30
|
+
redis = instantiate_store "redis://127.0.0.1:6380/13/theplaylist"
|
31
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6380 against DB 13 with namespace theplaylist"
|
32
|
+
end
|
33
|
+
|
34
|
+
it "should instantiate a ring" do
|
35
|
+
store = instantiate_store
|
36
|
+
store.should be_kind_of(Redis::Store)
|
37
|
+
store = instantiate_store ["redis://127.0.0.1:6379/0", "redis://127.0.0.1:6379/1"]
|
38
|
+
store.should be_kind_of(Redis::DistributedStore)
|
39
|
+
end
|
40
|
+
|
41
|
+
it "should verify if writable" do
|
42
|
+
with_store_management do |store|
|
43
|
+
store.writable?("rabbit").should be_true
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
it "should read the data" do
|
48
|
+
with_store_management do |store|
|
49
|
+
store.read("rabbit").should === @rabbit
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
it "should read raw data" do
|
54
|
+
with_store_management do |store|
|
55
|
+
store.read("rabbit", {}, :raw => true).should == Marshal.dump(@rabbit)
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
it "should write the data" do
|
60
|
+
with_store_management do |store|
|
61
|
+
store.write "rabbit", @white_rabbit
|
62
|
+
store.read("rabbit").should === @white_rabbit
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
it "should write raw data" do
|
67
|
+
with_store_management do |store|
|
68
|
+
store.write "rabbit", @white_rabbit, {}, :raw => true
|
69
|
+
store.read("rabbit", {}, :raw => true).should == %(#<OpenStruct color="white">)
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
it "should write the data with expiration time" do
|
74
|
+
with_store_management do |store|
|
75
|
+
store.write "rabbit", @white_rabbit, {}, :expires_in => 1.second
|
76
|
+
store.read("rabbit").should === @white_rabbit ; sleep 2
|
77
|
+
store.read("rabbit").should be_nil
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
it "should not write data if :unless_exist option is true" do
|
82
|
+
with_store_management do |store|
|
83
|
+
store.write "rabbit", @white_rabbit, {}, :unless_exist => true
|
84
|
+
store.read("rabbit").should === @rabbit
|
85
|
+
end
|
86
|
+
end
|
87
|
+
|
88
|
+
it "should write all the data" do
|
89
|
+
with_store_management do |store|
|
90
|
+
store.write_all "rabbit", @white_rabbit
|
91
|
+
store.read("rabbit").should === @white_rabbit
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
it "should fetch data" do
|
96
|
+
with_store_management do |store|
|
97
|
+
store.fetch("rabbit").should == @rabbit
|
98
|
+
store.fetch("rub-a-dub").should be_nil
|
99
|
+
store.fetch("rub-a-dub") { "Flora de Cana" }.should == "Flora de Cana"
|
100
|
+
store.fetch("rub-a-dub").should === "Flora de Cana"
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
it "should verify existence" do
|
105
|
+
with_store_management do |store|
|
106
|
+
store.exists?("rabbit").should be_true
|
107
|
+
store.exists?("rab-a-dub").should be_false
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
it "should delete data" do
|
112
|
+
with_store_management do |store|
|
113
|
+
store.delete "rabbit"
|
114
|
+
store.read("rabbit").should be_nil
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
it "should delete all the data" do
|
119
|
+
with_store_management do |store|
|
120
|
+
store.delete_all
|
121
|
+
store.instance_variable_get(:@data).keys("*").flatten.should be_empty
|
122
|
+
end
|
123
|
+
end
|
124
|
+
|
125
|
+
it "should delete all the data with bang method" do
|
126
|
+
with_store_management do |store|
|
127
|
+
store.delete_all!
|
128
|
+
store.instance_variable_get(:@data).keys("*").flatten.should be_empty
|
129
|
+
end
|
130
|
+
end
|
131
|
+
|
132
|
+
private
|
133
|
+
def instantiate_store(addresses = nil)
|
134
|
+
Merb::Cache::RedisStore.new(:servers => [addresses].flatten).instance_variable_get(:@data)
|
135
|
+
end
|
136
|
+
|
137
|
+
def with_store_management
|
138
|
+
yield @store
|
139
|
+
yield @dstore
|
140
|
+
end
|
141
|
+
end
|
142
|
+
end
|
143
|
+
end
|
@@ -0,0 +1,192 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
class App
|
4
|
+
def initialize
|
5
|
+
@values = {}
|
6
|
+
end
|
7
|
+
|
8
|
+
def set(key, value)
|
9
|
+
@values[key] = value
|
10
|
+
end
|
11
|
+
|
12
|
+
def get(key)
|
13
|
+
@values[key]
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
module Sinatra
|
18
|
+
module Cache
|
19
|
+
describe "Sinatra::Cache::RedisStore" do
|
20
|
+
before(:each) do
|
21
|
+
@store = Sinatra::Cache::RedisStore.new
|
22
|
+
@dstore = Sinatra::Cache::RedisStore.new "redis://127.0.0.1:6380/1", "redis://127.0.0.1:6381/1"
|
23
|
+
@rabbit = OpenStruct.new :name => "bunny"
|
24
|
+
@white_rabbit = OpenStruct.new :color => "white"
|
25
|
+
with_store_management do |store|
|
26
|
+
store.write "rabbit", @rabbit
|
27
|
+
store.delete "counter"
|
28
|
+
store.delete "rub-a-dub"
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
it "should register as extension" do
|
33
|
+
app = App.new
|
34
|
+
Sinatra::Cache.register(app)
|
35
|
+
store = app.get(:cache)
|
36
|
+
store.should be_kind_of(RedisStore)
|
37
|
+
end
|
38
|
+
|
39
|
+
it "should accept connection params" do
|
40
|
+
redis = instantiate_store
|
41
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 0"
|
42
|
+
|
43
|
+
redis = instantiate_store "redis://127.0.0.1"
|
44
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6379 against DB 0"
|
45
|
+
|
46
|
+
redis = instantiate_store "redis://127.0.0.1:6380"
|
47
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6380 against DB 0"
|
48
|
+
|
49
|
+
redis = instantiate_store "redis://127.0.0.1:6380/13"
|
50
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6380 against DB 13"
|
51
|
+
|
52
|
+
redis = instantiate_store "redis://127.0.0.1:6380/13/theplaylist"
|
53
|
+
redis.to_s.should == "Redis Client connected to 127.0.0.1:6380 against DB 13 with namespace theplaylist"
|
54
|
+
end
|
55
|
+
|
56
|
+
it "should instantiate a ring" do
|
57
|
+
store = instantiate_store
|
58
|
+
store.should be_kind_of(Redis::Store)
|
59
|
+
store = instantiate_store ["redis://127.0.0.1:6379/0", "redis://127.0.0.1:6379/1"]
|
60
|
+
store.should be_kind_of(Redis::DistributedStore)
|
61
|
+
end
|
62
|
+
|
63
|
+
it "should read the data" do
|
64
|
+
with_store_management do |store|
|
65
|
+
store.read("rabbit").should === @rabbit
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
it "should write the data" do
|
70
|
+
with_store_management do |store|
|
71
|
+
store.write "rabbit", @white_rabbit
|
72
|
+
store.read("rabbit").should === @white_rabbit
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
it "should write the data with expiration time" do
|
77
|
+
with_store_management do |store|
|
78
|
+
store.write "rabbit", @white_rabbit, :expires_in => 1.second
|
79
|
+
store.read("rabbit").should === @white_rabbit ; sleep 2
|
80
|
+
store.read("rabbit").should be_nil
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
it "should not write data if :unless_exist option is true" do
|
85
|
+
with_store_management do |store|
|
86
|
+
store.write "rabbit", @white_rabbit, :unless_exist => true
|
87
|
+
store.read("rabbit").should === @rabbit
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
it "should read raw data" do
|
92
|
+
with_store_management do |store|
|
93
|
+
store.read("rabbit", :raw => true).should == Marshal.dump(@rabbit)
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
it "should write raw data" do
|
98
|
+
with_store_management do |store|
|
99
|
+
store.write "rabbit", @white_rabbit, :raw => true
|
100
|
+
store.read("rabbit", :raw => true).should == %(#<OpenStruct color="white">)
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
it "should delete data" do
|
105
|
+
with_store_management do |store|
|
106
|
+
store.delete "rabbit"
|
107
|
+
store.read("rabbit").should be_nil
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
it "should delete matched data" do
|
112
|
+
with_store_management do |store|
|
113
|
+
store.delete_matched "rabb*"
|
114
|
+
store.read("rabbit").should be_nil
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
it "should verify existence of an object in the store" do
|
119
|
+
with_store_management do |store|
|
120
|
+
store.exist?("rabbit").should be_true
|
121
|
+
store.exist?("rab-a-dub").should be_false
|
122
|
+
end
|
123
|
+
end
|
124
|
+
|
125
|
+
it "should increment a key" do
|
126
|
+
with_store_management do |store|
|
127
|
+
3.times { store.increment "counter" }
|
128
|
+
store.read("counter", :raw => true).to_i.should == 3
|
129
|
+
end
|
130
|
+
end
|
131
|
+
|
132
|
+
it "should decrement a key" do
|
133
|
+
with_store_management do |store|
|
134
|
+
3.times { store.increment "counter" }
|
135
|
+
2.times { store.decrement "counter" }
|
136
|
+
store.read("counter", :raw => true).to_i.should == 1
|
137
|
+
end
|
138
|
+
end
|
139
|
+
|
140
|
+
it "should increment a key by given value" do
|
141
|
+
with_store_management do |store|
|
142
|
+
store.increment "counter", 3
|
143
|
+
store.read("counter", :raw => true).to_i.should == 3
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
it "should decrement a key by given value" do
|
148
|
+
with_store_management do |store|
|
149
|
+
3.times { store.increment "counter" }
|
150
|
+
store.decrement "counter", 2
|
151
|
+
store.read("counter", :raw => true).to_i.should == 1
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
155
|
+
it "should clear the store" do
|
156
|
+
with_store_management do |store|
|
157
|
+
store.clear
|
158
|
+
store.instance_variable_get(:@data).keys("*").flatten.should be_empty
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
162
|
+
it "should return store stats" do
|
163
|
+
with_store_management do |store|
|
164
|
+
store.stats.should_not be_empty
|
165
|
+
end
|
166
|
+
end
|
167
|
+
|
168
|
+
it "should fetch data" do
|
169
|
+
with_store_management do |store|
|
170
|
+
store.fetch("rabbit").should == @rabbit
|
171
|
+
store.fetch("rub-a-dub").should be_nil
|
172
|
+
store.fetch("rub-a-dub") { "Flora de Cana" }.should == "Flora de Cana"
|
173
|
+
store.fetch("rub-a-dub").should === "Flora de Cana"
|
174
|
+
store.fetch("rabbit", :force => true).should be_nil # force cache miss
|
175
|
+
store.fetch("rabbit", :force => true, :expires_in => 1.second) { @white_rabbit }
|
176
|
+
store.fetch("rabbit").should === @white_rabbit ; sleep 2
|
177
|
+
store.fetch("rabbit").should be_nil
|
178
|
+
end
|
179
|
+
end
|
180
|
+
|
181
|
+
private
|
182
|
+
def instantiate_store(addresses = nil)
|
183
|
+
Sinatra::Cache::RedisStore.new(addresses).instance_variable_get(:@data)
|
184
|
+
end
|
185
|
+
|
186
|
+
def with_store_management
|
187
|
+
yield @store
|
188
|
+
yield @dstore
|
189
|
+
end
|
190
|
+
end
|
191
|
+
end
|
192
|
+
end
|
@@ -0,0 +1,417 @@
|
|
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 6380
|
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
|
+
|
38
|
+
# Close the connection after a client is idle for N seconds (0 to disable)
|
39
|
+
timeout 300
|
40
|
+
|
41
|
+
# Set server verbosity to 'debug'
|
42
|
+
# it can be one of:
|
43
|
+
# debug (a lot of information, useful for development/testing)
|
44
|
+
# verbose (many rarely useful info, but not a mess like the debug level)
|
45
|
+
# notice (moderately verbose, what you want in production probably)
|
46
|
+
# warning (only very important / critical messages are logged)
|
47
|
+
loglevel verbose
|
48
|
+
|
49
|
+
# Specify the log file name. Also 'stdout' can be used to force
|
50
|
+
# Redis to log on the standard output. Note that if you use standard
|
51
|
+
# output for logging but daemonize, logs will be sent to /dev/null
|
52
|
+
logfile stdout
|
53
|
+
|
54
|
+
# To enable logging to the system logger, just set 'syslog-enabled' to yes,
|
55
|
+
# and optionally update the other syslog parameters to suit your needs.
|
56
|
+
# syslog-enabled no
|
57
|
+
|
58
|
+
# Specify the syslog identity.
|
59
|
+
# syslog-ident redis
|
60
|
+
|
61
|
+
# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
|
62
|
+
# syslog-facility local0
|
63
|
+
|
64
|
+
# Set the number of databases. The default database is DB 0, you can select
|
65
|
+
# a different one on a per-connection basis using SELECT <dbid> where
|
66
|
+
# dbid is a number between 0 and 'databases'-1
|
67
|
+
databases 16
|
68
|
+
|
69
|
+
################################ SNAPSHOTTING #################################
|
70
|
+
#
|
71
|
+
# Save the DB on disk:
|
72
|
+
#
|
73
|
+
# save <seconds> <changes>
|
74
|
+
#
|
75
|
+
# Will save the DB if both the given number of seconds and the given
|
76
|
+
# number of write operations against the DB occurred.
|
77
|
+
#
|
78
|
+
# In the example below the behaviour will be to save:
|
79
|
+
# after 900 sec (15 min) if at least 1 key changed
|
80
|
+
# after 300 sec (5 min) if at least 10 keys changed
|
81
|
+
# after 60 sec if at least 10000 keys changed
|
82
|
+
#
|
83
|
+
# Note: you can disable saving at all commenting all the "save" lines.
|
84
|
+
|
85
|
+
save 900 1
|
86
|
+
save 300 10
|
87
|
+
save 60 10000
|
88
|
+
|
89
|
+
# Compress string objects using LZF when dump .rdb databases?
|
90
|
+
# For default that's set to 'yes' as it's almost always a win.
|
91
|
+
# If you want to save some CPU in the saving child set it to 'no' but
|
92
|
+
# the dataset will likely be bigger if you have compressible values or keys.
|
93
|
+
rdbcompression yes
|
94
|
+
|
95
|
+
# The filename where to dump the DB
|
96
|
+
dbfilename tmp/node-one-dump.rdb
|
97
|
+
|
98
|
+
# The working directory.
|
99
|
+
#
|
100
|
+
# The DB will be written inside this directory, with the filename specified
|
101
|
+
# above using the 'dbfilename' configuration directive.
|
102
|
+
#
|
103
|
+
# Also the Append Only File will be created inside this directory.
|
104
|
+
#
|
105
|
+
# Note that you must specify a directory here, not a file name.
|
106
|
+
dir ./
|
107
|
+
|
108
|
+
################################# REPLICATION #################################
|
109
|
+
|
110
|
+
# Master-Slave replication. Use slaveof to make a Redis instance a copy of
|
111
|
+
# another Redis server. Note that the configuration is local to the slave
|
112
|
+
# so for example it is possible to configure the slave to save the DB with a
|
113
|
+
# different interval, or to listen to another port, and so on.
|
114
|
+
#
|
115
|
+
# slaveof <masterip> <masterport>
|
116
|
+
|
117
|
+
# If the master is password protected (using the "requirepass" configuration
|
118
|
+
# directive below) it is possible to tell the slave to authenticate before
|
119
|
+
# starting the replication synchronization process, otherwise the master will
|
120
|
+
# refuse the slave request.
|
121
|
+
#
|
122
|
+
# masterauth <master-password>
|
123
|
+
|
124
|
+
# When a slave lost the connection with the master, or when the replication
|
125
|
+
# is still in progress, the slave can act in two different ways:
|
126
|
+
#
|
127
|
+
# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
|
128
|
+
# still reply to client requests, possibly with out of data data, or the
|
129
|
+
# data set may just be empty if this is the first synchronization.
|
130
|
+
#
|
131
|
+
# 2) if slave-serve-stale data is set to 'no' the slave will reply with
|
132
|
+
# an error "SYNC with master in progress" to all the kind of commands
|
133
|
+
# but to INFO and SLAVEOF.
|
134
|
+
#
|
135
|
+
slave-serve-stale-data yes
|
136
|
+
|
137
|
+
################################## SECURITY ###################################
|
138
|
+
|
139
|
+
# Require clients to issue AUTH <PASSWORD> before processing any other
|
140
|
+
# commands. This might be useful in environments in which you do not trust
|
141
|
+
# others with access to the host running redis-server.
|
142
|
+
#
|
143
|
+
# This should stay commented out for backward compatibility and because most
|
144
|
+
# people do not need auth (e.g. they run their own servers).
|
145
|
+
#
|
146
|
+
# Warning: since Redis is pretty fast an outside user can try up to
|
147
|
+
# 150k passwords per second against a good box. This means that you should
|
148
|
+
# use a very strong password otherwise it will be very easy to break.
|
149
|
+
#
|
150
|
+
# requirepass foobared
|
151
|
+
|
152
|
+
# Command renaming.
|
153
|
+
#
|
154
|
+
# It is possilbe to change the name of dangerous commands in a shared
|
155
|
+
# environment. For instance the CONFIG command may be renamed into something
|
156
|
+
# of hard to guess so that it will be still available for internal-use
|
157
|
+
# tools but not available for general clients.
|
158
|
+
#
|
159
|
+
# Example:
|
160
|
+
#
|
161
|
+
# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
|
162
|
+
#
|
163
|
+
# It is also possilbe to completely kill a command renaming it into
|
164
|
+
# an empty string:
|
165
|
+
#
|
166
|
+
# rename-command CONFIG ""
|
167
|
+
|
168
|
+
################################### LIMITS ####################################
|
169
|
+
|
170
|
+
# Set the max number of connected clients at the same time. By default there
|
171
|
+
# is no limit, and it's up to the number of file descriptors the Redis process
|
172
|
+
# is able to open. The special value '0' means no limits.
|
173
|
+
# Once the limit is reached Redis will close all the new connections sending
|
174
|
+
# an error 'max number of clients reached'.
|
175
|
+
#
|
176
|
+
# maxclients 128
|
177
|
+
|
178
|
+
# Don't use more memory than the specified amount of bytes.
|
179
|
+
# When the memory limit is reached Redis will try to remove keys with an
|
180
|
+
# EXPIRE set. It will try to start freeing keys that are going to expire
|
181
|
+
# in little time and preserve keys with a longer time to live.
|
182
|
+
# Redis will also try to remove objects from free lists if possible.
|
183
|
+
#
|
184
|
+
# If all this fails, Redis will start to reply with errors to commands
|
185
|
+
# that will use more memory, like SET, LPUSH, and so on, and will continue
|
186
|
+
# to reply to most read-only commands like GET.
|
187
|
+
#
|
188
|
+
# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
|
189
|
+
# 'state' server or cache, not as a real DB. When Redis is used as a real
|
190
|
+
# database the memory usage will grow over the weeks, it will be obvious if
|
191
|
+
# it is going to use too much memory in the long run, and you'll have the time
|
192
|
+
# to upgrade. With maxmemory after the limit is reached you'll start to get
|
193
|
+
# errors for write operations, and this may even lead to DB inconsistency.
|
194
|
+
#
|
195
|
+
# maxmemory <bytes>
|
196
|
+
|
197
|
+
# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
|
198
|
+
# is reached? You can select among five behavior:
|
199
|
+
#
|
200
|
+
# volatile-lru -> remove the key with an expire set using an LRU algorithm
|
201
|
+
# allkeys-lru -> remove any key accordingly to the LRU algorithm
|
202
|
+
# volatile-random -> remove a random key with an expire set
|
203
|
+
# allkeys->random -> remove a random key, any key
|
204
|
+
# volatile-ttl -> remove the key with the nearest expire time (minor TTL)
|
205
|
+
# noeviction -> don't expire at all, just return an error on write operations
|
206
|
+
#
|
207
|
+
# Note: with all the kind of policies, Redis will return an error on write
|
208
|
+
# operations, when there are not suitable keys for eviction.
|
209
|
+
#
|
210
|
+
# At the date of writing this commands are: set setnx setex append
|
211
|
+
# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
|
212
|
+
# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
|
213
|
+
# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
|
214
|
+
# getset mset msetnx exec sort
|
215
|
+
#
|
216
|
+
# The default is:
|
217
|
+
#
|
218
|
+
# maxmemory-policy volatile-lru
|
219
|
+
|
220
|
+
# LRU and minimal TTL algorithms are not precise algorithms but approximated
|
221
|
+
# algorithms (in order to save memory), so you can select as well the sample
|
222
|
+
# size to check. For instance for default Redis will check three keys and
|
223
|
+
# pick the one that was used less recently, you can change the sample size
|
224
|
+
# using the following configuration directive.
|
225
|
+
#
|
226
|
+
# maxmemory-samples 3
|
227
|
+
|
228
|
+
############################## APPEND ONLY MODE ###############################
|
229
|
+
|
230
|
+
# By default Redis asynchronously dumps the dataset on disk. If you can live
|
231
|
+
# with the idea that the latest records will be lost if something like a crash
|
232
|
+
# happens this is the preferred way to run Redis. If instead you care a lot
|
233
|
+
# about your data and don't want to that a single record can get lost you should
|
234
|
+
# enable the append only mode: when this mode is enabled Redis will append
|
235
|
+
# every write operation received in the file appendonly.aof. This file will
|
236
|
+
# be read on startup in order to rebuild the full dataset in memory.
|
237
|
+
#
|
238
|
+
# Note that you can have both the async dumps and the append only file if you
|
239
|
+
# like (you have to comment the "save" statements above to disable the dumps).
|
240
|
+
# Still if append only mode is enabled Redis will load the data from the
|
241
|
+
# log file at startup ignoring the dump.rdb file.
|
242
|
+
#
|
243
|
+
# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
|
244
|
+
# log file in background when it gets too big.
|
245
|
+
|
246
|
+
appendonly no
|
247
|
+
|
248
|
+
# The name of the append only file (default: "appendonly.aof")
|
249
|
+
# appendfilename appendonly.aof
|
250
|
+
|
251
|
+
# The fsync() call tells the Operating System to actually write data on disk
|
252
|
+
# instead to wait for more data in the output buffer. Some OS will really flush
|
253
|
+
# data on disk, some other OS will just try to do it ASAP.
|
254
|
+
#
|
255
|
+
# Redis supports three different modes:
|
256
|
+
#
|
257
|
+
# no: don't fsync, just let the OS flush the data when it wants. Faster.
|
258
|
+
# always: fsync after every write to the append only log . Slow, Safest.
|
259
|
+
# everysec: fsync only if one second passed since the last fsync. Compromise.
|
260
|
+
#
|
261
|
+
# The default is "everysec" that's usually the right compromise between
|
262
|
+
# speed and data safety. It's up to you to understand if you can relax this to
|
263
|
+
# "no" that will will let the operating system flush the output buffer when
|
264
|
+
# it wants, for better performances (but if you can live with the idea of
|
265
|
+
# some data loss consider the default persistence mode that's snapshotting),
|
266
|
+
# or on the contrary, use "always" that's very slow but a bit safer than
|
267
|
+
# everysec.
|
268
|
+
#
|
269
|
+
# If unsure, use "everysec".
|
270
|
+
|
271
|
+
# appendfsync always
|
272
|
+
appendfsync everysec
|
273
|
+
# appendfsync no
|
274
|
+
|
275
|
+
# When the AOF fsync policy is set to always or everysec, and a background
|
276
|
+
# saving process (a background save or AOF log background rewriting) is
|
277
|
+
# performing a lot of I/O against the disk, in some Linux configurations
|
278
|
+
# Redis may block too long on the fsync() call. Note that there is no fix for
|
279
|
+
# this currently, as even performing fsync in a different thread will block
|
280
|
+
# our synchronous write(2) call.
|
281
|
+
#
|
282
|
+
# In order to mitigate this problem it's possible to use the following option
|
283
|
+
# that will prevent fsync() from being called in the main process while a
|
284
|
+
# BGSAVE or BGREWRITEAOF is in progress.
|
285
|
+
#
|
286
|
+
# This means that while another child is saving the durability of Redis is
|
287
|
+
# the same as "appendfsync none", that in pratical terms means that it is
|
288
|
+
# possible to lost up to 30 seconds of log in the worst scenario (with the
|
289
|
+
# default Linux settings).
|
290
|
+
#
|
291
|
+
# If you have latency problems turn this to "yes". Otherwise leave it as
|
292
|
+
# "no" that is the safest pick from the point of view of durability.
|
293
|
+
no-appendfsync-on-rewrite no
|
294
|
+
|
295
|
+
################################ VIRTUAL MEMORY ###############################
|
296
|
+
|
297
|
+
# Virtual Memory allows Redis to work with datasets bigger than the actual
|
298
|
+
# amount of RAM needed to hold the whole dataset in memory.
|
299
|
+
# In order to do so very used keys are taken in memory while the other keys
|
300
|
+
# are swapped into a swap file, similarly to what operating systems do
|
301
|
+
# with memory pages.
|
302
|
+
#
|
303
|
+
# To enable VM just set 'vm-enabled' to yes, and set the following three
|
304
|
+
# VM parameters accordingly to your needs.
|
305
|
+
|
306
|
+
vm-enabled no
|
307
|
+
# vm-enabled yes
|
308
|
+
|
309
|
+
# This is the path of the Redis swap file. As you can guess, swap files
|
310
|
+
# can't be shared by different Redis instances, so make sure to use a swap
|
311
|
+
# file for every redis process you are running. Redis will complain if the
|
312
|
+
# swap file is already in use.
|
313
|
+
#
|
314
|
+
# The best kind of storage for the Redis swap file (that's accessed at random)
|
315
|
+
# is a Solid State Disk (SSD).
|
316
|
+
#
|
317
|
+
# *** WARNING *** if you are using a shared hosting the default of putting
|
318
|
+
# the swap file under /tmp is not secure. Create a dir with access granted
|
319
|
+
# only to Redis user and configure Redis to create the swap file there.
|
320
|
+
vm-swap-file /tmp/redis.swap
|
321
|
+
|
322
|
+
# vm-max-memory configures the VM to use at max the specified amount of
|
323
|
+
# RAM. Everything that deos not fit will be swapped on disk *if* possible, that
|
324
|
+
# is, if there is still enough contiguous space in the swap file.
|
325
|
+
#
|
326
|
+
# With vm-max-memory 0 the system will swap everything it can. Not a good
|
327
|
+
# default, just specify the max amount of RAM you can in bytes, but it's
|
328
|
+
# better to leave some margin. For instance specify an amount of RAM
|
329
|
+
# that's more or less between 60 and 80% of your free RAM.
|
330
|
+
vm-max-memory 0
|
331
|
+
|
332
|
+
# Redis swap files is split into pages. An object can be saved using multiple
|
333
|
+
# contiguous pages, but pages can't be shared between different objects.
|
334
|
+
# So if your page is too big, small objects swapped out on disk will waste
|
335
|
+
# a lot of space. If you page is too small, there is less space in the swap
|
336
|
+
# file (assuming you configured the same number of total swap file pages).
|
337
|
+
#
|
338
|
+
# If you use a lot of small objects, use a page size of 64 or 32 bytes.
|
339
|
+
# If you use a lot of big objects, use a bigger page size.
|
340
|
+
# If unsure, use the default :)
|
341
|
+
vm-page-size 32
|
342
|
+
|
343
|
+
# Number of total memory pages in the swap file.
|
344
|
+
# Given that the page table (a bitmap of free/used pages) is taken in memory,
|
345
|
+
# every 8 pages on disk will consume 1 byte of RAM.
|
346
|
+
#
|
347
|
+
# The total swap size is vm-page-size * vm-pages
|
348
|
+
#
|
349
|
+
# With the default of 32-bytes memory pages and 134217728 pages Redis will
|
350
|
+
# use a 4 GB swap file, that will use 16 MB of RAM for the page table.
|
351
|
+
#
|
352
|
+
# It's better to use the smallest acceptable value for your application,
|
353
|
+
# but the default is large in order to work in most conditions.
|
354
|
+
vm-pages 134217728
|
355
|
+
|
356
|
+
# Max number of VM I/O threads running at the same time.
|
357
|
+
# This threads are used to read/write data from/to swap file, since they
|
358
|
+
# also encode and decode objects from disk to memory or the reverse, a bigger
|
359
|
+
# number of threads can help with big objects even if they can't help with
|
360
|
+
# I/O itself as the physical device may not be able to couple with many
|
361
|
+
# reads/writes operations at the same time.
|
362
|
+
#
|
363
|
+
# The special value of 0 turn off threaded I/O and enables the blocking
|
364
|
+
# Virtual Memory implementation.
|
365
|
+
vm-max-threads 4
|
366
|
+
|
367
|
+
############################### ADVANCED CONFIG ###############################
|
368
|
+
|
369
|
+
# Hashes are encoded in a special way (much more memory efficient) when they
|
370
|
+
# have at max a given numer of elements, and the biggest element does not
|
371
|
+
# exceed a given threshold. You can configure this limits with the following
|
372
|
+
# configuration directives.
|
373
|
+
hash-max-zipmap-entries 512
|
374
|
+
hash-max-zipmap-value 64
|
375
|
+
|
376
|
+
# Similarly to hashes, small lists are also encoded in a special way in order
|
377
|
+
# to save a lot of space. The special representation is only used when
|
378
|
+
# you are under the following limits:
|
379
|
+
list-max-ziplist-entries 512
|
380
|
+
list-max-ziplist-value 64
|
381
|
+
|
382
|
+
# Sets have a special encoding in just one case: when a set is composed
|
383
|
+
# of just strings that happens to be integers in radix 10 in the range
|
384
|
+
# of 64 bit signed integers.
|
385
|
+
# The following configuration setting sets the limit in the size of the
|
386
|
+
# set in order to use this special memory saving encoding.
|
387
|
+
set-max-intset-entries 512
|
388
|
+
|
389
|
+
# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
|
390
|
+
# order to help rehashing the main Redis hash table (the one mapping top-level
|
391
|
+
# keys to values). The hash table implementation redis uses (see dict.c)
|
392
|
+
# performs a lazy rehashing: the more operation you run into an hash table
|
393
|
+
# that is rhashing, the more rehashing "steps" are performed, so if the
|
394
|
+
# server is idle the rehashing is never complete and some more memory is used
|
395
|
+
# by the hash table.
|
396
|
+
#
|
397
|
+
# The default is to use this millisecond 10 times every second in order to
|
398
|
+
# active rehashing the main dictionaries, freeing memory when possible.
|
399
|
+
#
|
400
|
+
# If unsure:
|
401
|
+
# use "activerehashing no" if you have hard latency requirements and it is
|
402
|
+
# not a good thing in your environment that Redis can reply form time to time
|
403
|
+
# to queries with 2 milliseconds delay.
|
404
|
+
#
|
405
|
+
# use "activerehashing yes" if you don't have such hard requirements but
|
406
|
+
# want to free memory asap when possible.
|
407
|
+
activerehashing yes
|
408
|
+
|
409
|
+
################################## INCLUDES ###################################
|
410
|
+
|
411
|
+
# Include one or more other config files here. This is useful if you
|
412
|
+
# have a standard template that goes to all redis server but also need
|
413
|
+
# to customize a few per-server settings. Include files can include
|
414
|
+
# other files, so use this wisely.
|
415
|
+
#
|
416
|
+
# include /path/to/local.conf
|
417
|
+
# include /path/to/other.conf
|