# Redis

Подключение к Redis, отказоустойчивая конфигурация с Redis Sentinel, пулы соединений и тайм-ауты сокетов. Redis используется для кэша, очередей обновлений интерфейса, блокировок и временных данных посетителей.

Как изменить параметры и применить изменения, описано в разделе [Параметры .env](https://webim.ru/kb/11.0/settings/env/).

## Подключение { #connection }

| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
| `REDIS_CACHE_LOCATION` | URL | Не задано | Да | Адрес подключения к Redis в формате `redis://[:<пароль>@]<хост>:<порт>/<номер базы>`. Для TLS-подключения используйте схему `rediss://`. Адрес используется для всех подключений **Webim** к Redis.<br>Пример: `redis://:<пароль>@redis.example.local:6379/1`. |
| `REDIS_SSL_CA_LOCATION` | Путь к файлу | Пусто | Нет | Путь к сертификату удостоверяющего центра (PEM) для проверки сертификата Redis при подключении по схеме `rediss://`. Если не задан, используется системное хранилище сертификатов. |
| `REDIS_SENTINEL_HOSTS` | Список через запятую | Пусто | Нет | Адреса узлов Redis Sentinel в формате `<хост>:<порт>`, например `sentinel1.example.local:26379,sentinel2.example.local:26379`. Если список задан, адрес основного узла Redis запрашивается у Sentinel, а хост и порт из `REDIS_CACHE_LOCATION` не используются; номер базы, учётные данные и схема берутся из `REDIS_CACHE_LOCATION`. При схеме `rediss://` TLS применяется и к узлам Sentinel. |
| `REDIS_SENTINEL_SERVICE` | Строка | `mymaster` | Нет | Имя группы основного узла, которую отслеживает Sentinel. |
| `REDIS_SENTINEL_PASSWORD` | Строка | Пусто | Нет | Пароль для подключения к узлам Sentinel, если он отличается от пароля Redis. |
| `REDIS_SENTINEL_MASTER_HOST_OVERRIDE` | Строка | Пусто | Нет | Только для разработки: подменяет адрес основного узла, полученный от Sentinel. При `DEBUG=False` **Webim** с этим параметром не запускается. |
| `REDIS_HEALTH_CHECK_INTERVAL` | Целое число, секунды | `30` | Нет | Если соединение простаивало дольше этого интервала, перед следующей командой проверяется его работоспособность. |
| `REDIS_TCP_KEEPIDLE` | Целое число, секунды | `60` | Нет | Время простоя TCP-соединения до первой проверки keepalive. |
| `REDIS_TCP_KEEPINTVL` | Целое число, секунды | `10` | Нет | Интервал между проверками keepalive. |
| `REDIS_TCP_KEEPCNT` | Целое число | `3` | Нет | Число неудачных проверок keepalive, после которого соединение считается разорванным. |

## Пулы соединений { #pools }

Пулы создаются в каждом процессе **Webim**. Общее число соединений к Redis — сумма по всем пулам и процессам; оно должно укладываться в лимит `maxclients` сервера Redis.

| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
| `REDIS_CACHE_MAX_CONNECTIONS` | Целое число | `6` | Нет | Максимальное число соединений основного кэша в процессе. |
| `REDIS_JSON_CACHE_MAX_CONNECTIONS` | Целое число | `6` | Нет | Максимальное число соединений кэша данных в формате JSON в процессе. |
| `REDIS_CACHE_SOCKET_CONNECT_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут подключения к Redis для кэша. |
| `REDIS_CACHE_SOCKET_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут ответа Redis на команду кэша. |
| `REDIS_CONNECTION_POOL_MAX_CONNECTIONS` | Целое число | `10` | Нет | Максимальное число соединений синхронного пула для очередей обновлений интерфейса. |
| `REDIS_CONNECTION_POOL_SOCKET_CONNECT_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут подключения синхронного пула. |
| `REDIS_CONNECTION_POOL_SOCKET_TIMEOUT` | Целое число, секунды | `40` | Нет | Тайм-аут ответа Redis в синхронном пуле. Должен быть больше длительности длинного опроса (30 секунд). |
| `ASYNC_REDIS_CACHE_MAX_CONNECTIONS` | Целое число | `512` | Нет | Максимальное число соединений асинхронного кэша в процессе. |
| `ASYNC_REDIS_CACHE_POOL_TIMEOUT` | Дробное число, секунды | `5.0` | Нет | Максимальное время ожидания свободного соединения асинхронного кэша. |
| `ASYNC_REDIS_CACHE_SOCKET_CONNECT_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут подключения асинхронного кэша. |
| `ASYNC_REDIS_CACHE_SOCKET_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут ответа Redis для асинхронного кэша. |
| `ASYNC_REDIS_CACHE_DEFAULT_TIMEOUT` | Целое число, секунды | `300` | Нет | Срок хранения записей асинхронного кэша, если для записи не задан собственный срок. |
| `ASYNC_JSON_CACHE_MAX_CONNECTIONS` | Целое число | `20` | Нет | Максимальное число соединений асинхронного кэша данных в формате JSON. |
| `ASYNC_JSON_CACHE_POOL_TIMEOUT` | Дробное число, секунды | `5.0` | Нет | Максимальное время ожидания свободного соединения асинхронного кэша данных в формате JSON. |
| `ASYNC_JSON_CACHE_SOCKET_CONNECT_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут подключения асинхронного кэша данных в формате JSON. |
| `ASYNC_JSON_CACHE_SOCKET_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут ответа Redis для асинхронного кэша данных в формате JSON. |
| `STREAM_REDIS_POOL_MAX_CONNECTIONS` | Целое число | `256` | Нет | Максимальное число соединений асинхронного пула для очередей обновлений интерфейса. На установках с небольшим числом процессов значение можно уменьшить. |
| `REDIS_STREAM_SOCKET_CONNECT_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут подключения пула очередей обновлений. Тайм-аут ответа для этого пула не задаётся: длинный опрос держит соединение до 30 секунд. |
| `STREAM_UPDATES_MAXLEN` | Целое число | `10000` | Нет | Максимальная длина очереди обновлений интерфейса одного сотрудника в Redis. Более старые записи удаляются. |
| `EPHEMERAL_REDIS_POOL_TIMEOUT` | Дробное число, секунды | `5.0` | Нет | Максимальное время ожидания соединения пула временных данных посетителей. |
| `EPHEMERAL_REDIS_SOCKET_CONNECT_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут подключения пула временных данных посетителей. |
| `EPHEMERAL_REDIS_SOCKET_TIMEOUT` | Целое число, секунды | `5` | Нет | Тайм-аут ответа Redis для пула временных данных посетителей. |

---

Источник: https://webim.ru/kb/11.0/settings/env/redis.html
