Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Commit

Permalink
Merge pull request #2084 from aiven/issue-1985-troubleshoot-redis-con…
Browse files Browse the repository at this point in the history
…nection-issues

redis: how to troubleshoot connection issues
  • Loading branch information
bridgetb authored Aug 28, 2023
2 parents 88169cd + 4960572 commit 10f36dc
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .github/vale/dicts/aiven.dic
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ rebalance
rebalances
rebalancing
Redis
redis_timeout
Redli
refcard
reindex
Expand Down Expand Up @@ -244,6 +245,7 @@ subprocesses
subtab
syslog
TaskManager
Tcpdump
Telegraf
Tenant
Terraform
Expand All @@ -269,6 +271,7 @@ VMs
VPC/MS
VNet
wget
Wireshark
Workbench
Worldmap
worldPing
Expand Down
9 changes: 7 additions & 2 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1295,7 +1295,12 @@ entries:
entries:
- file: docs/products/redis/reference/advanced-params
title: Advanced parameters

- file: docs/products/redis/troubleshooting
title: Troubleshooting
entries:
- file: docs/products/redis/troubleshooting/troubleshoot-redis-connection-issues
title: Troubleshoot connection issues

# -------- SUPPORT --------
- file: docs/platform/howto/list-support
title: Support
Expand All @@ -1305,7 +1310,7 @@ entries:
title: Upgrade your support tier
- file: docs/platform/concepts/service-level-agreement
- file: docs/platform/concepts/beta_services

# -------- COMMUNITY --------
- file: docs/community
title: Community
Expand Down
3 changes: 3 additions & 0 deletions docs/products/redis/troubleshooting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Troubleshooting common issues
=============================
.. tableofcontents::
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Troubleshoot Redis®* connection issues
######################################

Discover troubleshooting techniques for your Redis®* service and check out how to resolve common connection issues.

Important notes
---------------
By default :doc:`Aiven for Redis® uses SSL connections</docs/products/redis/howto/manage-ssl-connectivity>` and these connections are closed automatically after 12 hours. This is not a parameter that can be changed. Aiven also sets the ``redis_timeout`` advanced parameter to 300 seconds by default.

Some Redis®* connections are closed intermittently
--------------------------------------------------
When experiencing connection issues with your Redis®* service, here are some common things to check:
- Some Redis®* clients do not support SSL connections. It is recommended to check the documentation for the Redis®* client being used to ensure SSL connections are supported.
- If you are noticing older connections terminating, you should check to see what the value is configured for the :doc:`redis_timeout advanced parameter</docs/products/redis/reference/advanced-params>`. This parameter controls the timeout value for idle connections. Once the timeout is reached, the connection is terminated.

Methods for troubleshooting connections
---------------------------------------

A great way to troubleshoot connection issues is to arrange for a packet capture to take place. This can be achieved with tools like `Tcpdump <https://www.tcpdump.org/>`_ and `Wireshark <https://www.wireshark.org/>`_. This allows you to see if connections are making it outside your network to the Aiven for Redis®* instance.

Another tool you can use to help diagnose connection issues is the Socket Statistics CLI tool which dumps socket statistics.

0 comments on commit 10f36dc

Please sign in to comment.