diff --git a/doc/tutorials/cfg_list/Makefile b/doc/tutorials/cfg_list/Makefile index 12f7c0105d3..d03f4f92a0d 100644 --- a/doc/tutorials/cfg_list/Makefile +++ b/doc/tutorials/cfg_list/Makefile @@ -71,7 +71,7 @@ c_defs=-DNAME='\"kamailio\"' -DVERSION='\"5.1.0-dev3\"' -DARCH='\"x86_64\"' \ -DCFG_DIR='\"/usr/local/etc/kamailio/\"' \ -DRUN_DIR='\"/run/kamailio/\"' -DPKG_MALLOC -DSHM_MEM -DSHM_MMAP \ -DDNS_IP_HACK -DUSE_MCAST -DUSE_TCP -DDISABLE_NAGLE -DHAVE_RESOLV_RES \ - -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLACKLIST -DUSE_NAPTR \ + -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLOCKLIST -DUSE_NAPTR \ -DWITH_XAVP -DMEM_JOIN_FREE -DF_MALLOC -DQ_MALLOC -DTLSF_MALLOC \ -DDBG_SR_MEMORY -DUSE_TLS -DTLS_HOOKS -DUSE_CORE_STATS -DSTATISTICS \ -DMALLOC_STATS -DWITH_AS_SUPPORT -DUSE_SCTP -DFAST_LOCK -DADAPTIVE_WAIT \ diff --git a/doc/tutorials/counter_list/Makefile b/doc/tutorials/counter_list/Makefile index 83aab2e1b72..643bc27828c 100644 --- a/doc/tutorials/counter_list/Makefile +++ b/doc/tutorials/counter_list/Makefile @@ -65,7 +65,7 @@ c_defs=-DNAME='\"kamailio\"' -DVERSION='\"5.1.0-dev3\"' -DARCH='\"x86_64\"' \ -DCFG_DIR='\"/usr/local/etc/kamailio/\"' \ -DRUN_DIR='\"/run/kamailio/\"' -DPKG_MALLOC -DSHM_MEM -DSHM_MMAP \ -DDNS_IP_HACK -DUSE_MCAST -DUSE_TCP -DDISABLE_NAGLE -DHAVE_RESOLV_RES \ - -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLACKLIST -DUSE_NAPTR \ + -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLOCKLIST -DUSE_NAPTR \ -DWITH_XAVP -DMEM_JOIN_FREE -DF_MALLOC -DQ_MALLOC -DTLSF_MALLOC \ -DDBG_SR_MEMORY -DUSE_TLS -DTLS_HOOKS -DUSE_CORE_STATS -DSTATISTICS \ -DMALLOC_STATS -DWITH_AS_SUPPORT -DUSE_SCTP -DFAST_LOCK -DADAPTIVE_WAIT \ diff --git a/doc/tutorials/dst_blacklist.txt b/doc/tutorials/dst_blocklist.txt similarity index 63% rename from doc/tutorials/dst_blacklist.txt rename to doc/tutorials/dst_blocklist.txt index 8782978bb63..f5c3e2d52d1 100644 --- a/doc/tutorials/dst_blacklist.txt +++ b/doc/tutorials/dst_blocklist.txt @@ -1,32 +1,32 @@ -Destination blacklist Overview +Destination blocklist Overview ------------------------------ - The destination blacklist (dst_blacklist) is used to try to mark bad + The destination blocklist (dst_blocklist) is used to try to mark bad destinations and avoid possible future expensive send operation to them. - A destination is added to the blacklist when an attempt to send to it fails (e.g. + A destination is added to the blocklist when an attempt to send to it fails (e.g. timeout while trying to send or connect on TCP), or when a SIP timeout occurs while trying to forward statefully an INVITE (using tm) and the remote side doesn't send back any response. - The blacklist (if enabled) is checked before any send attempt. + The blocklist (if enabled) is checked before any send attempt. Drawbacks --------- - Using the destination blacklist will cause some performance degradation, + Using the destination blocklist will cause some performance degradation, especially on multi cpu machines. If you don't need it you can easily disable it, either in sip-router's config or at compile time. Disabling it at compile time is slightly better (but not in a "measurable" way) than disabling it at runtime, from the config file. - Whether the destination blacklist is a good solution for you depends a lot + Whether the destination blocklist is a good solution for you depends a lot on the setup. In general it is better to turn it on when: - sending to clients that don't respond is expensive (e.g. lots of clients use tcp and they have the habit of silently discarding tcp traffic from time to time) - stateful forwarding is used (tm) and lower memory usage is desired (a transaction will fail immediately if the destination is already - blacklisted by a previous transaction to the same destination that failed + blocklisted by a previous transaction to the same destination that failed due to timeout) - faster dns failover is desired, especially when stateful forwarding (tm) and UDP are used @@ -35,34 +35,34 @@ Drawbacks Config Variables ---------------- - use_dst_blacklist = on | off (default off) - enable the destination blacklist: - If on each failed send attempt will cause the destination to be blacklisted. - Before any send operation this blacklist will be checked and if a match is found the + use_dst_blocklist = on | off (default off) - enable the destination blocklist: + If on each failed send attempt will cause the destination to be blocklisted. + Before any send operation this blocklist will be checked and if a match is found the send is no longer attempted (an error is returned immediately). - Note: using the blacklist incurs a small performance penalty. + Note: using the blocklist incurs a small performance penalty. - dst_blacklist_mem = size in Kb (default 250 Kb) - maximum - shared memory amount used for keeping the blacklisted destinations. + dst_blocklist_mem = size in Kb (default 250 Kb) - maximum + shared memory amount used for keeping the blocklisted destinations. - dst_blacklist_expire = time in s (default 60 s) - how long time a - blacklisted destination will be kept in the blacklist (w/o any update). + dst_blocklist_expire = time in s (default 60 s) - how long time a + blocklisted destination will be kept in the blocklist (w/o any update). - dst_blacklist_gc_interval = time in s (default 60 s) - how often the + dst_blocklist_gc_interval = time in s (default 60 s) - how often the garbage collection will run (eliminating old, expired entries). - dst_blacklist_init = on | off (default on) - if off, the blacklist + dst_blocklist_init = on | off (default on) - if off, the blocklist is not initialized at startup and cannot be enabled at runtime, which saves some memory. Compile Time Options -------------------- - USE_DST_BLACKLIST - if defined the blacklist support will be compiled-in + USE_DST_BLOCKLIST - if defined the blocklist support will be compiled-in (default). Note: To remove a compile time option, edit the file Makefile.defs and remove - USE_DST_BLACKLIST from the list named DEFS. + USE_DST_BLOCKLIST from the list named DEFS. To add a compile time option, just add it to the make command line, e.g.: make proper; make all extra_defs=-DUSE_DNS_FAILOVER or for a permanent solution, edit Makefile.defs and add it to DEFS diff --git a/doc/tutorials/rpc_list/Makefile b/doc/tutorials/rpc_list/Makefile index 61117d44eb0..e7ad20e5b40 100644 --- a/doc/tutorials/rpc_list/Makefile +++ b/doc/tutorials/rpc_list/Makefile @@ -138,7 +138,7 @@ c_defsX=-DNAME='\"kamailio\"' -DVERSION='\"5.1.0-dev3\"' -DARCH='\"x86_64\"' \ -DCFG_DIR='\"/usr/local/etc/kamailio/\"' \ -DRUN_DIR='\"/run/kamailio/\"' -DPKG_MALLOC -DSHM_MEM -DSHM_MMAP \ -DDNS_IP_HACK -DUSE_MCAST -DUSE_TCP -DDISABLE_NAGLE -DHAVE_RESOLV_RES \ - -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLACKLIST -DUSE_NAPTR \ + -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLOCKLIST -DUSE_NAPTR \ -DWITH_XAVP -DMEM_JOIN_FREE -DF_MALLOC -DQ_MALLOC -DTLSF_MALLOC \ -DDBG_SR_MEMORY -DUSE_TLS -DTLS_HOOKS -DUSE_CORE_STATS -DSTATISTICS \ -DMALLOC_STATS -DWITH_AS_SUPPORT -DUSE_SCTP -DFAST_LOCK -DADAPTIVE_WAIT \ diff --git a/doc/tutorials/select_list/Makefile b/doc/tutorials/select_list/Makefile index 69587e4702e..48c1def8fef 100644 --- a/doc/tutorials/select_list/Makefile +++ b/doc/tutorials/select_list/Makefile @@ -67,7 +67,7 @@ c_defs=-DNAME='\"kamailio\"' -DVERSION='\"5.1.0-dev3\"' -DARCH='\"x86_64\"' \ -DCFG_DIR='\"/usr/local/etc/kamailio/\"' \ -DRUN_DIR='\"/run/kamailio/\"' -DPKG_MALLOC -DSHM_MEM -DSHM_MMAP \ -DDNS_IP_HACK -DUSE_MCAST -DUSE_TCP -DDISABLE_NAGLE -DHAVE_RESOLV_RES \ - -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLACKLIST -DUSE_NAPTR \ + -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLOCKLIST -DUSE_NAPTR \ -DWITH_XAVP -DMEM_JOIN_FREE -DF_MALLOC -DQ_MALLOC -DTLSF_MALLOC \ -DDBG_SR_MEMORY -DUSE_TLS -DTLS_HOOKS -DUSE_CORE_STATS -DSTATISTICS \ -DMALLOC_STATS -DWITH_AS_SUPPORT -DUSE_SCTP -DFAST_LOCK -DADAPTIVE_WAIT \