1 # Example sentinel.conf2
3 # port
4 # The port that this sentinel instance will run on5 port 26379
6 protected-mode no7
8 # sentinel announce-ip
9 # sentinel announce-port
10 #11 # The above two configuration directives are useful inenvironments where,12 # because of NAT, Sentinel is reachable from outside via a non-local address.13 #14 # When announce-ip is provided, the Sentinel will claim the specified IP address15 # in HELLO messages used to gossip its presence, instead of auto-detecting the16 # local address as it usually does.17 #18 # Similarly when announce-port is provided and is valid and non-zero, Sentinel19 # will announce the specified TCP port.20 #21 # The two options don't need to be used together, if only announce-ip is
22 # provided, the Sentinel will announce the specified IP and the server port23 # as specified by the "port" option. If only announce-port is provided, the24 # Sentinel will announce the auto-detected local IP and the specified port.25 #26 # Example:27 #28 # sentinel announce-ip 1.2.3.4
29
30 # dir
31 # Every long running process should have a well-defined working directory.32 # For Redis Sentinel to chdir to /tmp at startup is the simplest thing33 # for the process to don't interfere with administrative tasks such as
34 # unmounting filesystems.35 dir "/tmp"
36
37 # sentinel monitor
38 #39 # Tells Sentinel to monitor this master, and to consider it inO_DOWN40 # (Objectively Down) state only if at least sentinels agree.41 #42 # Note that whatever is the ODOWN quorum, a Sentinel will require to43 # be elected by the majority of the known Sentinels inorder to44 # start a failover, so no failover can be performed inminority.45 #46 # Slaves are auto-discovered, so you don't need to specify slaves in
47 # any way. Sentinel itself will rewrite this configuration fileadding48 # the slaves using additional configuration options.49 # Also note that the configuration fileis rewritten when a50 # slave is promoted to master.51 #52 # Note: master name should not include special characters or spaces.53 # The valid charset is A-z 0-9 and the three characters ".-_".54 sentinel myid 920ad7dac87a4c853bbdf6417578e53ce261bdec55
56 # sentinel auth-pass
57 #58 # Set the password to use to authenticate with the master and slaves.59 # Useful if there is a password set inthe Redis instances to monitor.60 #61 # Note that the master password is also used forslaves, so it is not62 # possible to set a different password inmasters and slaves instances63 # ifyou want to be able to monitor these instances with Sentinel.64 #65 # However you can have Redis instances without the authentication enabled66 # mixed with Redis instances requiring the authentication (as longas the67 # password set is the same forall the instances requiring the password) as68 # the AUTH command will have no effect inRedis instances with authentication69 # switched off.70 #71 # Example:72 #73 sentinel monitor mymaster 192.168.91.233 6379 1
74
75 # sentinel down-after-milliseconds
76 #77 # Number of milliseconds the master (or any attached slave or sentinel) should78 # be unreachable (as in, not acceptable reply to PING, continuously, forthe79 # specified period) in order to consider it inS_DOWN state (Subjectively80 # Down).81 #82 # Default is 30seconds.83 sentinel failover-timeout mymaster 30000
84
85 sentinel auth-pass mymaster 123456
86 #87 # How many slaves we can reconfigure to point to the new slave simultaneously88 # during the failover. Use a low number ifyou use the slaves to serve query89 # to avoid that all the slaves will be unreachable at about the same90 # time whileperforming the synchronization with the master.91 #sentinel config-epoch mymaster 0
92
93 #sentinel leader-epoch mymaster 21
94 #95 # Specifies the failover timeout in milliseconds. It is used inmany ways:96 #97 # - The time needed to re-start a failover after a previous failover was98 # already tried against the same master by a given Sentinel, is two99 # times the failover timeout.100 #101 # - The time needed fora slave replicating to a wrong master according102 # to a Sentinel current configuration, to be forced to replicate103 # with the right master, is exactly the failover timeout (counting since104 # the moment a Sentinel detected the misconfiguration).105 #106 # - The time needed to cancel a failover that is already inprogress but107 # did not produced any configuration change (SLAVEOF NO ONE yet not108 # acknowledged by the promoted slave).109 #110 # - The maximum time a failover in progress waits forall the slaves to be111 # reconfigured as slaves of the new master. However even after this time
112 # the slaves will be reconfigured by the Sentinels anyway, but not with113 # the exact parallel-syncs progression as specified.114 #115 # Default is 3minutes.116 sentinel config-epoch mymaster 1
117 #sentinel known-slave mymaster 192.168.91.233 6379
118
119 # SCRIPTS EXECUTION120 #121 # sentinel notification-script and sentinel reconfig-script are used inorder122 # to configure scripts that are called to notify the system administrator123 # or to reconfigure clients after a failover. The scripts are executed124 # with the following rules forerror handling:125 #126 # If script exits with "1"the execution is retried later (up to a maximum127 # number of times currently set to 10).128 #129 # If script exits with "2"(or an higher value) the script execution is130 # not retried.131 #132 # If script terminates because it receives a signal the behavior is the same133 # as exit code 1.134 #135 # A script has a maximum running time of 60seconds. After this limit is136 # reached the script is terminated with a SIGKILL and the execution retried.137
138 # NOTIFICATION SCRIPT139 #140 # sentinel notification-script
141 #142 # Call the specified notification script forany sentinel event that is143 # generated in the WARNING level (for instance -sdown, -odown, and so forth).144 # This script should notify the system administrator via email, SMS, or any145 # other messaging system, that there is something wrong with the monitored146 # Redis systems.147 #148 # The script is called with just two arguments: the first is the event type149 # and the second the event description.150 #151 # The script must exist and be executable in order for sentinel to start if
152 # this option is provided.153 #154 # Example:155 #156 # sentinel notification-script mymaster /var/redis/notify.sh
157
158 # CLIENTS RECONFIGURATION SCRIPT159 #160 # sentinel client-reconfig-script
161 #162 # When the master changed because of a failover a script can be called in
163 # order to perform application-specific tasks to notify the clients that the164 # configuration has changed and the master is at a different address.165 #166 # The following arguments are passed to the script:167 #168 #
169 #170 # is currently always "failover"
171 # is either "leader" or "observer"
172 #173 # The arguments from-ip, from-port, to-ip, to-port are used to communicate174 # the old address of the master and the new address of the elected slave175 # (now a master).176 #177 # This script should be resistant to multiple invocations.178 #179 # Example:180 #181 # sentinel client-reconfig-script mymaster /var/redis/reconfig.sh
182
183 # Generated by CONFIG REWRITE184 #sentinel current-epoch 21
185
186 sentinel leader-epoch mymaster 1
187 sentinel known-slave mymaster 192.168.91.234 6379
188 sentinel current-epoch 1