[GEODE-9557] Consistenly state in the documentation the situations where conserve-sockets should not be set to true

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: docs
• Assignee: Dave Barnes
• Reporter: Alberto Gomez
• Created: 27/Aug/21 11:17
• Updated: 07/Sep/21 18:02

Description

According to the current Geode documentation, in order to avoid hangs or distributed locks, it is not recommended to set conserve-sockets to true under the following conditions:

• "When you have transactions operating on EMPTY, NORMAL or PARTITION regions, make sure that `conserve-sockets` is set to false to avoid distributed deadlocks." (see geode-docs/managing/monitor_tune/performance_controls_controlling_socket_use.html.md.erb).
• On members that participate in a WAN deployment: "To avoid hangs related to WAN messaging, always use the default setting of <code class="ph codeph">conserve-sockets=false</code> for <%=vars.product_name%> members that participate in a WAN deployment." (see geode-docs/topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html.md.erb, geode-docs/managing/monitor_tune/sockets_and_gateways.html.md.erb and geode-docs/reference/topics/gemfire_properties.html.md.erb)

The following Geode documentation files have references to the conserve-sockets property:

• geode-docs/topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html.md.erb
• geode-docs/managing/monitor_tune/slow_messages.html.md.erb
• geode-docs/managing/monitor_tune/performance_controls_controlling_socket_use.html.md.erb
• geode-docs/managing/monitor_tune/sockets_and_gateways.html.md.erb
• geode-docs/managing/monitor_tune/socket_communication_have_enough_sockets.html.md.erb
• geode-docs/managing/logging/logging_categories.html.md.erb
• geode-docs/basic_config/gemfire_properties/setting_distributed_properties.html.md.erb
• geode-docs/configuring/running/firewalls_ports.html.md.erb
• geode-docs/developing/events/how_cache_events_work.html.md.erb
• geode-docs/reference/topics/memory_requirements_for_cache_data.html.md.erb
• geode-docs/reference/topics/gemfire_properties.html.md.erb

The situations where conserve-sockets should not be set to true must be described together (in the same place) and not in different documentation pages in order to avoid someone missing one of them for not reading all the documentation pages.

Also, it would be desirable that the situations are described in just one documentation page to avoid duplication and future documentation consistency problems and have the rest of pages mentioning conserve-sockets refer to that page containing the full details of the property.