Sentinel: scripts execution engine improved.

[redis.git] / sentinel.conf

diff --git a/sentinel.conf b/sentinel.conf
index 381d51fd184ea8d1f854188ef65dce3d6e21f6f1..45c34401de386ad9631a1d23dc0a70ca67e196fe 100644 (file)
--- a/sentinel.conf
+++ b/sentinel.conf
@@ -1,13 +1,20 @@
 # Example sentinel.conf
 
-# sentinel monitor <name> <ip> <port> quorum. Tells Sentinel to monitor this
-# slave, and to consider it in O_DOWN (Objectively Down) state only if at
-# least <quorum> sentinels agree.
+# port <sentinel-port>
+# The port that this sentinel instance will run on
+port 26379
+
+# sentinel monitor <master-name> <ip> <redis-port> <quorum>
+#
+# Tells Sentinel to monitor this slave, and to consider it in O_DOWN
+# (Objectively Down) state only if at least <quorum> sentinels agree.
 #
 # Note: master name should not include special characters or spaces.
 # The valid charset is A-z 0-9 and the three characters ".-_".
 sentinel monitor mymaster 127.0.0.1 6379 2
 
+# sentinel down-after-milliseconds <master-name> <milliseconds>
+#
 # Number of milliseconds the master (or any attached slave or sentinel) should
 # be unreachable (as in, not acceptable reply to PING, continuously, for the
 # specified period) in order to consider it in S_DOWN state (Subjectively
@@ -16,15 +23,21 @@ sentinel monitor mymaster 127.0.0.1 6379 2
 # Default is 30 seconds.
 sentinel down-after-milliseconds mymaster 30000
 
+# sentinel can-failover <master-name> <yes|no>
+#
 # Specify if this Sentinel can start the failover for this master.
 sentinel can-failover mymaster yes
 
+# sentinel parallel-syncs <master-name> <numslaves>
+#
 # How many slaves we can reconfigure to point to the new slave simultaneously
 # during the failover. Use a low number if you use the slaves to serve query
 # to avoid that all the slaves will be unreachable at about the same
 # time while performing the synchronization with the master.
 sentinel parallel-syncs mymaster 1
 
+# sentinel failover-timeout <master-name> <milliseconds>
+#
 # Specifies the failover timeout in milliseconds. When this time has elapsed
 # without any progress in the failover process, it is considered concluded by
 # the sentinel even if not all the attached slaves were correctly configured
@@ -39,3 +52,22 @@ sentinel parallel-syncs mymaster 1
 # Default is 15 minutes.
 sentinel failover-timeout mymaster 900000
 
+# sentinel notification-script <master-name> <script-path>
+# 
+# Call the specified notification script for any sentienl event that is
+# generated in the WARNING level (for instance -sdown, -odown, and so forth).
+# This script should notify the system administrator via email, SMS, or any
+# other messaging system, that there is something wrong with the monitored
+# Redis systems.
+#
+# The script is called with just two arguments: the first is the event type
+# and the second the event description.
+#
+# The script must exist and be executable in order for sentinel to start if
+# this option is provided.
+#
+# Example:
+#
+# sentinel notification-script mymaster /var/redis/notify.sh
+
+