pax_global_header00006660000000000000000000000064131565723440014524gustar00rootroot0000000000000052 comment=533df6e1f134b20b76d9d9f300ec65475eff1d2b asgi_redis-1.4.3/000077500000000000000000000000001315657234400136425ustar00rootroot00000000000000asgi_redis-1.4.3/.gitignore000066400000000000000000000000561315657234400156330ustar00rootroot00000000000000*.egg-info dist/ build/ *.pyc /.tox .DS_Store asgi_redis-1.4.3/.travis.yml000066400000000000000000000007151315657234400157560ustar00rootroot00000000000000sudo: false dist: trusty language: python python: - "2.7" - "3.4" - "3.5" - "3.6" services: - redis-server cache: directories: - $HOME/.cache/pip/wheels install: - pip install -U pip wheel setuptools - pip install 'git+https://github.com/django/channels.git#egg=channels-benchmark&subdirectory=testproject' - pip install -e .[tests] - pip freeze script: py.test # TODO: setup test coverage tracking service. # after_success: # - codecov asgi_redis-1.4.3/CHANGELOG.txt000066400000000000000000000072221315657234400156750ustar00rootroot000000000000001.4.3 (2017-09-14) ------------------ * The internal class layout of the channel layers has been adjusted, but the public API remains the same. * Fixed compatability with newer releases of redis-py. 1.4.2 (2017-06-20) ------------------ * receive() no longer blocks indefinitely, just for a while. * Built-in lua scripts have their SHA pre-set to avoid a guaranteed cache miss on their first usage. 1.4.1 (2017-06-15) ------------------ * A keyspace leak has been fixed where message body keys were not deleted after receive, and instead left to expire. 1.4.0 (2017-05-18) ------------------ * Sharded mode support is now more robust with send/receive deterministically moving around the shard ring rather than picking random connections. This means there is no longer a slight chance of messages being missed when there are not significantly more readers on a channel than shards. Tests have also been updated so they run fully on sharded mode thanks to this. * Sentinel support has been considerably improved, with connection caching (via sentinal_refresh_interval), and automatic service discovery. * The Twisted backend now picks up the Redis password if one is configured. 1.3.0 (2017-04-07) ------------------ * Change format of connection arguments to be a single dict called ``connection_kwargs`` rather than individual options, as they change by connection type. You will need to change your settings if you have any of socket_connect_timeout, socket_timeout, socket_keepalive or socket_keepalive_options set to move them into a ``connection_kwargs`` dict. 1.2.1 (2017-04-02) ------------------ * Error with sending to multi-process channels with the same message fixed 1.2.0 (2017-04-01) ------------------ * Process-specific channel behaviour changed to match new spec * Redis Sentinel channel layer added 1.1.0 (2017-03-18) ------------------ * Support for the ASGI statistics extension * Distribution of items over multiple servers using consistent hashing is improved * Handles timeout exceptions in newer redis-py library versions correctly * Support for configuring the socket_connect_timeout, socket_timeout, socket_keepalive and socket_keepalive_options options that are passed to redis-py. 1.0.0 (2016-11-05) ------------------ * Renamed "receive_many" to "receive" * Improved (more explicit) error handling for Redis errors/old versions * Bad hosts (string not lost) configuration now errors explicitly 0.14.1 (2016-08-24) ------------------- * Removed unused reverse channels-to-groups mapping keys as they were not cleaned up proactively and quickly filled up databases. 0.14.0 (2016-07-16) ------------------- * Implemented group_channels method. 0.13.0 (2016-06-09) ------------------- * Added local-and-remote backend option (uses asgi_ipc) 0.12.0 (2016-05-25) ------------------- * Added symmetric encryption for messages and at-rest data with key rotation. 0.11.0 (2016-05-07) ------------------- * Implement backpressure with per-channel and default capacities. 0.10.0 (2016-03-27) ------------------- * Group expiry code re-added and fixed. 0.9.1 (2016-03-23) ------------------ * Remove old group expiry code that was killing groups after 60 seconds. 0.9.0 (2016-03-21) ------------------ * Connections now pooled per backend shard * Random portion of channel names now 12 characters * Implements new ASGI single-response-channel pattern spec 0.8.3 (2016-02-28) ------------------ * Nonblocking receive_many now uses Lua script rather than for loop. 0.8.2 (2016-02-22) ------------------ * Nonblocking receive_many now works, but is inefficient * Python 3 fixes 0.8.1 (2016-02-22) ------------------ * Fixed packaging issues asgi_redis-1.4.3/Dockerfile000066400000000000000000000005451315657234400156400ustar00rootroot00000000000000FROM ubuntu:16.04 RUN DEBIAN_FRONTEND=noninteractive apt-get update && \ apt-get -yqq install \ git \ build-essential python-pip software-properties-common \ python-dev python3-dev \ libffi-dev libxml2-dev libxslt-dev libssl-dev RUN pip install -U pip && pip install tox ENV DOCKER_TEST_ENV true ADD . /src WORKDIR /src CMD ["tox"] asgi_redis-1.4.3/LICENSE000066400000000000000000000030201315657234400146420ustar00rootroot00000000000000Copyright (c) Django Software Foundation and individual contributors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of Django nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. asgi_redis-1.4.3/Makefile000066400000000000000000000005061315657234400153030ustar00rootroot00000000000000.PHONY: release all: release: ifndef version $(error Please supply a version) endif @echo Releasing version $(version) ifeq (,$(findstring $(version),$(shell git log --oneline -1))) $(error Last commit does not match version) endif git tag $(version) git push git push --tags python setup.py sdist bdist_wheel upload asgi_redis-1.4.3/README.rst000066400000000000000000000210671315657234400153370ustar00rootroot00000000000000asgi_redis ========== .. image:: https://api.travis-ci.org/django/asgi_redis.svg :target: https://travis-ci.org/django/asgi_redis .. image:: https://img.shields.io/pypi/v/asgi_redis.svg :target: https://pypi.python.org/pypi/asgi_redis An ASGI channel layer that uses Redis as its backing store, and supports both a single-server and sharded configurations, as well as group support. Usage ----- You'll need to instantiate the channel layer with at least ``hosts``, and other options if you need them. Example: .. code-block:: python channel_layer = RedisChannelLayer( host="redis", db=4, channel_capacity={ "http.request": 200, "http.response*": 10, } ) ``hosts`` ~~~~~~~~~ The server(s) to connect to, as either URIs or ``(host, port)`` tuples. Defaults to ``['localhost', 6379]``. Pass multiple hosts to enable sharding, but note that changing the host list will lose some sharded data. ``prefix`` ~~~~~~~~~~ Prefix to add to all Redis keys. Defaults to ``asgi:``. If you're running two or more entirely separate channel layers through the same Redis instance, make sure they have different prefixes. All servers talking to the same layer should have the same prefix, though. ``expiry`` ~~~~~~~~~~ Message expiry in seconds. Defaults to ``60``. You generally shouldn't need to change this, but you may want to turn it down if you have peaky traffic you wish to drop, or up if you have peaky traffic you want to backlog until you get to it. ``group_expiry`` ~~~~~~~~~~~~~~~~ Group expiry in seconds. Defaults to ``86400``. Interface servers will drop connections after this amount of time; it's recommended you reduce it for a healthier system that encourages disconnections. ``capacity`` ~~~~~~~~~~~~ Default channel capacity. Defaults to ``100``. Once a channel is at capacity, it will refuse more messages. How this affects different parts of the system varies; a HTTP server will refuse connections, for example, while Django sending a response will just wait until there's space. ``channel_capacity`` ~~~~~~~~~~~~~~~~~~~~ Per-channel capacity configuration. This lets you tweak the channel capacity based on the channel name, and supports both globbing and regular expressions. It should be a dict mapping channel name pattern to desired capacity; if the dict key is a string, it's intepreted as a glob, while if it's a compiled ``re`` object, it's treated as a regular expression. This example sets ``http.request`` to 200, all ``http.response!`` channels to 10, and all ``websocket.send!`` channels to 20: .. code-block:: python channel_capacity={ "http.request": 200, "http.response!*": 10, re.compile(r"^websocket.send\!.+"): 20, } If you want to enforce a matching order, use an ``OrderedDict`` as the argument; channels will then be matched in the order the dict provides them. ``symmetric_encryption_keys`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Pass this to enable the optional symmetric encryption mode of the backend. To use it, make sure you have the ``cryptography`` package installed, or specify the ``cryptography`` extra when you install ``asgi_redis``:: pip install asgi_redis[cryptography] ``symmetric_encryption_keys`` should be a list of strings, with each string being an encryption key. The first key is always used for encryption; all are considered for decryption, so you can rotate keys without downtime - just add a new key at the start and move the old one down, then remove the old one after the message expiry time has passed. Data is encrypted both on the wire and at rest in Redis, though we advise you also route your Redis connections over TLS for higher security; the Redis protocol is still unencrypted, and the channel and group key names could potentially contain metadata patterns of use to attackers. Keys **should have at least 32 bytes of entropy** - they are passed through the SHA256 hash function before being used as an encryption key. Any string will work, but the shorter the string, the easier the encryption is to break. If you're using Django, you may also wish to set this to your site's ``SECRET_KEY`` setting via the ``CHANNEL_LAYERS`` setting: .. code-block:: python CHANNEL_LAYERS = { "default": { "BACKEND": "asgi_redis.RedisChannelLayer", "ROUTING": "my_project.routing.channel_routing", "CONFIG": { "hosts": ["redis://:password@127.0.0.1:6379/0"], "symmetric_encryption_keys": [SECRET_KEY], }, }, } ``connection_kwargs`` --------------------- Optional extra arguments to pass to the ``redis-py`` connection class. Options include ``socket_connect_timeout``, ``socket_timeout``, ``socket_keepalive``, and ``socket_keepalive_options``. See the `redis-py documentation `_ for more. Local-and-Remote Mode --------------------- A "local and remote" mode is also supported, where the Redis channel layer works in conjunction with a machine-local channel layer (``asgi_ipc``) in order to route all normal channels over the local layer, while routing all single-reader and process-specific channels over the Redis layer. This allows traffic on things like ``http.request`` and ``websocket.receive`` to stay in the local layer and not go through Redis, while still allowing Group send and sends to arbitrary channels terminated on other machines to work correctly. It will improve performance and decrease the load on your Redis cluster, but **it requires all normal channels are consumed on the same machine**. In practice, this means you MUST run workers that consume every channel your application has code to handle on the same machine as your HTTP or WebSocket terminator. If you fail to do this, requests to that machine will get routed into only the local queue and hang as nothing is reading them. To use it, just use the ``asgi_redis.RedisLocalChannelLayer`` class in your configuration instead of ``RedisChannelLayer`` and make sure you have the ``asgi_ipc`` package installed; no other change is needed. Sentinel Mode ------------- "Sentinel" mode is also supported, where the Redis channel layer will connect to a redis sentinel cluster to find the present Redis master before writing or reading data. Sentinel mode supports sharding, but does not support multiple Sentinel clusters. To run sharding of keys across multiple Redis clusters, use a single sentinel cluster, but have that sentinel cluster monitor multiple "services". Then in the configuration for the RedisSentinelChannelLayer, add a list of the service names. You can also leave the list of services blank, and the layer will pull all services that are configured on the sentinel master. Redis Sentinel mode does not support URL-style connection strings, just tuple-based ones. Configuration for Sentinel mode looks like this: .. code-block:: python CHANNEL_LAYERS = { "default": { "BACKEND": "asgi_redis.RedisSentinelChannelLayer", "CONFIG": { "hosts": [("10.0.0.1", 26739), ("10.0.0.2", 26379), ("10.0.0.3", 26379)], "services": ["shard1", "shard2", "shard3"], }, }, } The "shard1", "shard2", etc entries correspond to the name of the service configured in your redis `sentinel.conf` file. For example, if your `sentinel.conf` says ``sentinel monitor local 127.0.0.1 6379 1`` then you would want to include "local" as a service in the `RedisSentinelChannelLayer` configuration. You may also pass a ``sentinel_refresh_interval`` value in the ``CONFIG``, which will enable caching of the Sentinel results for the specified number of seconds. This is recommended to reduce the need to query Sentinel every time; even a low value of 5 seconds will significantly reduce overhead. Dependencies ------------ Redis >= 2.6 is required for `asgi_redis`. It supports Python 2.7, 3.4, 3.5 and 3.6. Contributing ------------ Please refer to the `main Channels contributing docs `_. That also contains advice on how to set up the development environment and run the tests. Maintenance and Security ------------------------ To report security issues, please contact security@djangoproject.com. For GPG signatures and more security process information, see https://docs.djangoproject.com/en/dev/internals/security/. To report bugs or request new features, please open a new GitHub issue. This repository is part of the Channels project. For the shepherd and maintenance team, please see the `main Channels readme `_. asgi_redis-1.4.3/asgi_redis/000077500000000000000000000000001315657234400157535ustar00rootroot00000000000000asgi_redis-1.4.3/asgi_redis/__init__.py000066400000000000000000000002251315657234400200630ustar00rootroot00000000000000from .core import RedisChannelLayer from .local import RedisLocalChannelLayer from .sentinel import RedisSentinelChannelLayer __version__ = '1.4.3' asgi_redis-1.4.3/asgi_redis/core.py000066400000000000000000000605601315657234400172640ustar00rootroot00000000000000from __future__ import unicode_literals import base64 import binascii import hashlib import itertools import msgpack import random import redis import six import string import time import uuid try: import txredisapi except ImportError: pass from asgiref.base_layer import BaseChannelLayer from .twisted_utils import defer class UnsupportedRedis(Exception): pass class BaseRedisChannelLayer(BaseChannelLayer): blpop_timeout = 5 global_statistics_expiry = 86400 channel_statistics_expiry = 3600 global_stats_key = '#global#' # needs to be invalid as a channel name def __init__( self, expiry=60, hosts=None, prefix="asgi:", group_expiry=86400, capacity=100, channel_capacity=None, symmetric_encryption_keys=None, stats_prefix="asgi-meta:", connection_kwargs=None, ): super(BaseRedisChannelLayer, self).__init__( expiry=expiry, group_expiry=group_expiry, capacity=capacity, channel_capacity=channel_capacity, ) assert isinstance(prefix, six.text_type), "Prefix must be unicode" socket_timeout = connection_kwargs and connection_kwargs.get("socket_timeout", None) if socket_timeout and socket_timeout < self.blpop_timeout: raise ValueError("The socket timeout must be at least %s seconds" % self.blpop_timeout) self.prefix = prefix self.stats_prefix = stats_prefix # Decide on a unique client prefix to use in ! sections # TODO: ensure uniqueness better, e.g. Redis keys with SETNX self.client_prefix = "".join(random.choice(string.ascii_letters) for i in range(8)) self._setup_encryption(symmetric_encryption_keys) ### Setup ### def _setup_encryption(self, symmetric_encryption_keys): # See if we can do encryption if they asked if symmetric_encryption_keys: if isinstance(symmetric_encryption_keys, six.string_types): raise ValueError("symmetric_encryption_keys must be a list of possible keys") try: from cryptography.fernet import MultiFernet except ImportError: raise ValueError("Cannot run with encryption without 'cryptography' installed.") sub_fernets = [self.make_fernet(key) for key in symmetric_encryption_keys] self.crypter = MultiFernet(sub_fernets) else: self.crypter = None def _register_scripts(self): connection = self.connection(None) self.chansend = connection.register_script(self.lua_chansend) self.lpopmany = connection.register_script(self.lua_lpopmany) self.delprefix = connection.register_script(self.lua_delprefix) self.incrstatcounters = connection.register_script(self.lua_incrstatcounters) ### ASGI API ### extensions = ["groups", "flush", "statistics"] try: import txredisapi except ImportError: pass else: extensions.append("twisted") def send(self, channel, message): # Typecheck assert isinstance(message, dict), "message is not a dict" assert self.valid_channel_name(channel), "Channel name not valid" # Make sure the message does not contain reserved keys assert "__asgi_channel__" not in message # If it's a process-local channel, strip off local part and stick full name in message if "!" in channel: message = dict(message.items()) message['__asgi_channel__'] = channel channel = self.non_local_name(channel) # Write out message into expiring key (avoids big items in list) # TODO: Use extended set, drop support for older redis? message_key = self.prefix + uuid.uuid4().hex channel_key = self.prefix + channel # Pick a connection to the right server - consistent for response # channels, random for normal channels if "!" in channel or "?" in channel: index = self.consistent_hash(channel) connection = self.connection(index) else: index = next(self._send_index_generator) connection = self.connection(index) # Use the Lua function to do the set-and-push try: self.chansend( keys=[message_key, channel_key], args=[self.serialize(message), self.expiry, self.get_capacity(channel)], client=connection, ) self._incr_statistics_counter( stat_name=self.STAT_MESSAGES_COUNT, channel=channel, connection=connection, ) except redis.exceptions.ResponseError as e: # The Lua script handles capacity checking and sends the "full" error back if e.args[0] == "full": self._incr_statistics_counter( stat_name=self.STAT_CHANNEL_FULL, channel=channel, connection=connection, ) raise self.ChannelFull elif "unknown command" in e.args[0]: raise UnsupportedRedis( "Redis returned an error (%s). Please ensure you're running a " " version of redis that is supported by asgi_redis." % e.args[0]) else: # Let any other exception bubble up raise def receive(self, channels, block=False): # List name get indexes = self._receive_list_names(channels) # Short circuit if no channels if indexes is None: return None, None # Get a message from one of our channels while True: got_expired_content = False # Try each index:channels pair at least once or until a result is returned for index, list_names in indexes.items(): # Shuffle list_names to avoid the first ones starving others of workers random.shuffle(list_names) # Open a connection connection = self.connection(index) # Pop off any waiting message if block: result = connection.blpop(list_names, timeout=self.blpop_timeout) else: result = self.lpopmany(keys=list_names, client=connection) if result: content = connection.get(result[1]) connection.delete(result[1]) if content is None: # If the content key expired, keep going. got_expired_content = True continue # Return the channel it's from and the message channel = result[0][len(self.prefix):].decode("utf8") message = self.deserialize(content) # If there is a full channel name stored in the message, unpack it. if "__asgi_channel__" in message: channel = message['__asgi_channel__'] del message['__asgi_channel__'] return channel, message # If we only got expired content, try again if got_expired_content: continue else: return None, None def _receive_list_names(self, channels): """ Inner logic of receive; takes channels, groups by shard, and returns {connection_index: list_names ...} if a query is needed or None for a vacuously empty response. """ # Short circuit if no channels if not channels: return None # Check channel names are valid channels = list(channels) assert all( self.valid_channel_name(channel, receive=True) for channel in channels ), "One or more channel names invalid" # Work out what servers to listen on for the given channels indexes = {} index = next(self._receive_index_generator) for channel in channels: if "!" in channel or "?" in channel: indexes.setdefault(self.consistent_hash(channel), []).append( self.prefix + channel, ) else: indexes.setdefault(index, []).append( self.prefix + channel, ) return indexes def new_channel(self, pattern): assert isinstance(pattern, six.text_type) # Keep making channel names till one isn't present. while True: random_string = "".join(random.choice(string.ascii_letters) for i in range(12)) assert pattern.endswith("?") new_name = pattern + random_string # Get right connection index = self.consistent_hash(new_name) connection = self.connection(index) # Check to see if it's in the connected Redis. # This fails to stop collisions for sharding where the channel is # non-single-listener, but that seems very unlikely. key = self.prefix + new_name if not connection.exists(key): return new_name ### ASGI Group extension ### def group_add(self, group, channel): """ Adds the channel to the named group for at least 'expiry' seconds (expiry defaults to message expiry if not provided). """ assert self.valid_group_name(group), "Group name not valid" assert self.valid_channel_name(channel), "Channel name not valid" group_key = self._group_key(group) connection = self.connection(self.consistent_hash(group)) # Add to group sorted set with creation time as timestamp connection.zadd( group_key, **{channel: time.time()} ) # Set both expiration to be group_expiry, since everything in # it at this point is guaranteed to expire before that connection.expire(group_key, self.group_expiry) def group_discard(self, group, channel): """ Removes the channel from the named group if it is in the group; does nothing otherwise (does not error) """ assert self.valid_group_name(group), "Group name not valid" assert self.valid_channel_name(channel), "Channel name not valid" key = self._group_key(group) self.connection(self.consistent_hash(group)).zrem( key, channel, ) def group_channels(self, group): """ Returns all channels in the group as an iterable. """ key = self._group_key(group) connection = self.connection(self.consistent_hash(group)) # Discard old channels based on group_expiry connection.zremrangebyscore(key, 0, int(time.time()) - self.group_expiry) # Return current lot return [x.decode("utf8") for x in connection.zrange( key, 0, -1, )] def send_group(self, group, message): """ Sends a message to the entire group. """ assert self.valid_group_name(group), "Group name not valid" # TODO: More efficient implementation (lua script per shard?) for channel in self.group_channels(group): try: self.send(channel, message) except self.ChannelFull: pass def _group_key(self, group): return ("%s:group:%s" % (self.prefix, group)).encode("utf8") ### Twisted extension ### @defer.inlineCallbacks def receive_twisted(self, channels): """ Twisted-native implementation of receive. """ # List name get indexes = self._receive_list_names(channels) # Short circuit if no channels if indexes is None: defer.returnValue((None, None)) # Get a message from one of our channels while True: got_expired_content = False # Try each index:channels pair at least once or until a result is returned for index, list_names in indexes.items(): # Shuffle list_names to avoid the first ones starving others of workers random.shuffle(list_names) # Get a sync connection for conn details sync_connection = self.connection(index) twisted_connection = yield txredisapi.ConnectionPool( host=sync_connection.connection_pool.connection_kwargs['host'], port=sync_connection.connection_pool.connection_kwargs['port'], dbid=sync_connection.connection_pool.connection_kwargs['db'], password=sync_connection.connection_pool.connection_kwargs['password'], ) try: # Pop off any waiting message result = yield twisted_connection.blpop(list_names, timeout=self.blpop_timeout) if result: content = yield twisted_connection.get(result[1]) # If the content key expired, keep going. if content is None: got_expired_content = True continue # Return the channel it's from and the message channel = result[0][len(self.prefix):] message = self.deserialize(content) # If there is a full channel name stored in the message, unpack it. if "__asgi_channel__" in message: channel = message['__asgi_channel__'] del message['__asgi_channel__'] defer.returnValue((channel, message)) finally: yield twisted_connection.disconnect() # If we only got expired content, try again if got_expired_content: continue else: defer.returnValue((None, None)) ### statistics extension ### STAT_MESSAGES_COUNT = 'messages_count' STAT_MESSAGES_PENDING = 'messages_pending' STAT_MESSAGES_MAX_AGE = 'messages_max_age' STAT_CHANNEL_FULL = 'channel_full_count' def _count_global_stats(self, connection_list): statistics = { self.STAT_MESSAGES_COUNT: 0, self.STAT_CHANNEL_FULL: 0, } prefix = self.stats_prefix + self.global_stats_key for connection in connection_list: messages_count, channel_full_count = connection.mget( ':'.join((prefix, self.STAT_MESSAGES_COUNT)), ':'.join((prefix, self.STAT_CHANNEL_FULL)), ) statistics[self.STAT_MESSAGES_COUNT] += int(messages_count or 0) statistics[self.STAT_CHANNEL_FULL] += int(channel_full_count or 0) return statistics def _count_channel_stats(self, channel, connections): statistics = { self.STAT_MESSAGES_COUNT: 0, self.STAT_MESSAGES_PENDING: 0, self.STAT_MESSAGES_MAX_AGE: 0, self.STAT_CHANNEL_FULL: 0, } prefix = self.stats_prefix + channel channel_key = self.prefix + channel for connection in connections: messages_count, channel_full_count = connection.mget( ':'.join((prefix, self.STAT_MESSAGES_COUNT)), ':'.join((prefix, self.STAT_CHANNEL_FULL)), ) statistics[self.STAT_MESSAGES_COUNT] += int(messages_count or 0) statistics[self.STAT_CHANNEL_FULL] += int(channel_full_count or 0) statistics[self.STAT_MESSAGES_PENDING] += connection.llen(channel_key) oldest_message = connection.lindex(channel_key, 0) if oldest_message: messages_age = self.expiry - connection.ttl(oldest_message) statistics[self.STAT_MESSAGES_MAX_AGE] = max(statistics[self.STAT_MESSAGES_MAX_AGE], messages_age) return statistics def _incr_statistics_counter(self, stat_name, channel, connection): """ helper function to intrement counter stats in one go """ self.incrstatcounters( keys=[ "{prefix}{channel}:{stat_name}".format( prefix=self.stats_prefix, channel=channel, stat_name=stat_name, ), "{prefix}{global_key}:{stat_name}".format( prefix=self.stats_prefix, global_key=self.global_stats_key, stat_name=stat_name, ) ], args=[self.channel_statistics_expiry, self.global_statistics_expiry], client=connection, ) ### Serialization ### def serialize(self, message): """ Serializes message to a byte string. """ value = msgpack.packb(message, use_bin_type=True) if self.crypter: value = self.crypter.encrypt(value) return value def deserialize(self, message): """ Deserializes from a byte string. """ if self.crypter: message = self.crypter.decrypt(message, self.expiry + 10) return msgpack.unpackb(message, encoding="utf8") ### Redis Lua scripts ### # Single-command channel send. Returns error if over capacity. # Keys: message, channel_list # Args: content, expiry, capacity lua_chansend = """ if redis.call('llen', KEYS[2]) >= tonumber(ARGV[3]) then return redis.error_reply("full") end redis.call('set', KEYS[1], ARGV[1]) redis.call('expire', KEYS[1], ARGV[2]) redis.call('rpush', KEYS[2], KEYS[1]) redis.call('expire', KEYS[2], ARGV[2] + 1) """ # Single-command to increment counter stats. # Keys: channel_stat, global_stat # Args: channel_stat_expiry, global_stat_expiry lua_incrstatcounters = """ redis.call('incr', KEYS[1]) redis.call('expire', KEYS[1], ARGV[1]) redis.call('incr', KEYS[2]) redis.call('expire', KEYS[2], ARGV[2]) """ lua_lpopmany = """ for keyCount = 1, #KEYS do local result = redis.call('LPOP', KEYS[keyCount]) if result then return {KEYS[keyCount], result} end end return {nil, nil} """ lua_delprefix = """ local keys = redis.call('keys', ARGV[1]) for i=1,#keys,5000 do redis.call('del', unpack(keys, i, math.min(i+4999, #keys))) end """ ### Internal functions ### def consistent_hash(self, value): """ Maps the value to a node value between 0 and 4095 using CRC, then down to one of the ring nodes. """ if isinstance(value, six.text_type): value = value.encode("utf8") bigval = binascii.crc32(value) & 0xfff ring_divisor = 4096 / float(self.ring_size) return int(bigval / ring_divisor) def make_fernet(self, key): """ Given a single encryption key, returns a Fernet instance using it. """ from cryptography.fernet import Fernet if isinstance(key, six.text_type): key = key.encode("utf8") formatted_key = base64.urlsafe_b64encode(hashlib.sha256(key).digest()) return Fernet(formatted_key) class RedisChannelLayer(BaseRedisChannelLayer): """ Redis channel layer. It routes all messages into remote Redis server. Support for sharding among different Redis installations and message encryption are provided. Both synchronous and asynchronous (via Twisted) approaches are implemented. """ def __init__( self, expiry=60, hosts=None, prefix="asgi:", group_expiry=86400, capacity=100, channel_capacity=None, symmetric_encryption_keys=None, stats_prefix="asgi-meta:", connection_kwargs=None, ): super(RedisChannelLayer, self).__init__( expiry=expiry, hosts=hosts, prefix=prefix, group_expiry=group_expiry, capacity=capacity, channel_capacity=channel_capacity, symmetric_encryption_keys=symmetric_encryption_keys, stats_prefix=stats_prefix, connection_kwargs=connection_kwargs, ) self.hosts = self._setup_hosts(hosts) # Precalculate some values for ring selection self.ring_size = len(self.hosts) # Create connections ahead of time (they won't call out just yet, but # we want to connection-pool them later) self._connection_list = self._generate_connections( self.hosts, redis_kwargs=connection_kwargs or {}, ) self._receive_index_generator = itertools.cycle(range(len(self.hosts))) self._send_index_generator = itertools.cycle(range(len(self.hosts))) self._register_scripts() ### Setup ### def _setup_hosts(self, hosts): # Make sure they provided some hosts, or provide a default final_hosts = list() if not hosts: hosts = [("localhost", 6379)] if isinstance(hosts, six.string_types): # user accidentally used one host string instead of providing a list of hosts raise ValueError('ASGI Redis hosts must be specified as an iterable list of hosts.') for entry in hosts: if isinstance(entry, six.string_types): final_hosts.append(entry) else: final_hosts.append("redis://%s:%d/0" % (entry[0], entry[1])) return final_hosts def _generate_connections(self, hosts, redis_kwargs): return [ redis.Redis.from_url(host, **redis_kwargs) for host in hosts ] ### Connection handling #### def connection(self, index): """ Returns the correct connection for the current thread. Pass key to use a server based on consistent hashing of the key value; pass None to use a random server instead. """ # If index is explicitly None, pick a random server if index is None: index = self.random_index() # Catch bad indexes if not 0 <= index < self.ring_size: raise ValueError("There are only %s hosts - you asked for %s!" % (self.ring_size, index)) return self._connection_list[index] def random_index(self): return random.randint(0, len(self.hosts) - 1) ### Flush extension ### def flush(self): """ Deletes all messages and groups on all shards. """ for connection in self._connection_list: self.delprefix(keys=[], args=[self.prefix + "*"], client=connection) self.delprefix(keys=[], args=[self.stats_prefix + "*"], client=connection) ### Statistics extension ### def global_statistics(self): """ Returns dictionary of statistics across all channels on all shards. Return value is a dictionary with following fields: * messages_count, the number of messages processed since server start * channel_full_count, the number of times ChannelFull exception has been risen since server start This implementation does not provide calculated per second values. Due perfomance concerns, does not provide aggregated messages_pending and messages_max_age, these are only avaliable per channel. """ return self._count_global_stats(self._connection_list) def channel_statistics(self, channel): """ Returns dictionary of statistics for specified channel. Return value is a dictionary with following fields: * messages_count, the number of messages processed since server start * messages_pending, the current number of messages waiting * messages_max_age, how long the oldest message has been waiting, in seconds * channel_full_count, the number of times ChannelFull exception has been risen since server start This implementation does not provide calculated per second values """ if "!" in channel or "?" in channel: connections = [self.connection(self.consistent_hash(channel))] else: # if we don't know where it is, we have to check in all shards connections = self._connection_list return self._count_channel_stats(channel, connections) def __str__(self): return "%s(hosts=%s)" % (self.__class__.__name__, self.hosts) asgi_redis-1.4.3/asgi_redis/local.py000066400000000000000000000056641315657234400174320ustar00rootroot00000000000000from __future__ import unicode_literals from asgi_redis import RedisChannelLayer class RedisLocalChannelLayer(RedisChannelLayer): """ Variant of the Redis channel layer that also uses a local-machine channel layer instance to route all non-machine-specific messages to a local machine, while using the Redis backend for all machine-specific messages and group management/sends. This allows the majority of traffic to go over the local layer for things like http.request and websocket.receive, while still allowing Groups to broadcast to all connected clients and keeping reply_channel names valid across all workers. """ def __init__(self, expiry=60, prefix="asgi:", group_expiry=86400, capacity=100, channel_capacity=None, **kwargs): # Initialise the base class super(RedisLocalChannelLayer, self).__init__( prefix = prefix, expiry = expiry, group_expiry = group_expiry, capacity = capacity, channel_capacity = channel_capacity, **kwargs ) # Set up our local transport layer as well try: from asgi_ipc import IPCChannelLayer except ImportError: raise ValueError("You must install asgi_ipc to use the local variant") self.local_layer = IPCChannelLayer( prefix = prefix.replace(":", ""), expiry = expiry, group_expiry = group_expiry, capacity = capacity, channel_capacity = channel_capacity, ) ### ASGI API ### def send(self, channel, message): # If the channel is "normal", use IPC layer, otherwise use Redis layer if "!" in channel or "?" in channel: return super(RedisLocalChannelLayer, self).send(channel, message) else: return self.local_layer.send(channel, message) def receive(self, channels, block=False): # Work out what kinds of channels are in there num_remote = len([channel for channel in channels if "!" in channel or "?" in channel]) num_local = len(channels) - num_remote # If they mixed types, force nonblock mode and query both backends, local first if num_local and num_remote: result = self.local_layer.receive(channels, block=False) if result[0] is not None: return result return super(RedisLocalChannelLayer, self).receive(channels, block=block) # If they just did one type, pass off to that backend elif num_local: return self.local_layer.receive(channels, block=block) else: return super(RedisLocalChannelLayer, self).receive(channels, block=block) # new_channel always goes to Redis as it's always remote channels. # Group APIs always go to Redis too. def flush(self): # Dispatch flush to both super(RedisLocalChannelLayer, self).flush() self.local_layer.flush() asgi_redis-1.4.3/asgi_redis/sentinel.py000066400000000000000000000160071315657234400201520ustar00rootroot00000000000000from __future__ import unicode_literals import itertools import random import redis from redis.sentinel import Sentinel import six import time from asgi_redis.core import BaseRedisChannelLayer random.seed() class RedisSentinelChannelLayer(BaseRedisChannelLayer): """ Variant of the Redis channel layer that supports the Redis Sentinel HA protocol. Supports sharding, but assumes that there is only one sentinel cluster with multiple redis services monitored by that cluster. So, this will only connect to a single cluster of Sentinel servers, but will suppport sharding by asking that sentinel cluster for different services. Also, any redis connection options (socket timeout, socket keepalive, etc) will be assumed to be identical across redis server, and across all services. "hosts" in this arrangement, is used to list the redis sentinel hosts. As such, it only supports the tuple method of specifying hosts, as that's all the redis sentinel python library supports at the moment. "services" is the list of redis services monitored by the sentinel system that redis keys will be distributed across. If services is empty, this will fetch all services from Sentinel at initialization. """ def __init__( self, expiry=60, hosts=None, prefix="asgi:", group_expiry=86400, capacity=100, channel_capacity=None, symmetric_encryption_keys=None, stats_prefix="asgi-meta:", connection_kwargs=None, services=None, sentinel_refresh_interval=0, ): super(RedisSentinelChannelLayer, self).__init__( expiry=expiry, hosts=hosts, prefix=prefix, group_expiry=group_expiry, capacity=capacity, channel_capacity=channel_capacity, symmetric_encryption_keys=symmetric_encryption_keys, stats_prefix=stats_prefix, connection_kwargs=connection_kwargs, ) # Master connection caching self.sentinel_refresh_interval = sentinel_refresh_interval self._last_sentinel_refresh = 0 self._master_connections = {} connection_kwargs = connection_kwargs or {} self._sentinel = Sentinel(self._setup_hosts(hosts), **connection_kwargs) if services: self._validate_service_names(services) self.services = services else: self.services = self._get_service_names() # Precalculate some values for ring selection self.ring_size = len(self.services) self._receive_index_generator = itertools.cycle(range(len(self.services))) self._send_index_generator = itertools.cycle(range(len(self.services))) self._register_scripts() ### Setup ### def _setup_hosts(self, hosts): # Override to only accept tuples, since the redis.sentinel.Sentinel does not accept URLs if not hosts: hosts = [("localhost", 26379)] final_hosts = list() if isinstance(hosts, six.string_types): # user accidentally used one host string instead of providing a list of hosts raise ValueError("ASGI Redis hosts must be specified as an iterable list of hosts.") for entry in hosts: if isinstance(entry, six.string_types): raise ValueError("Sentinel Redis host entries must be specified as tuples, not strings.") else: final_hosts.append(entry) return final_hosts def _validate_service_names(self, services): if isinstance(services, six.string_types): raise ValueError("Sentinel service types must be specified as an iterable list of strings") for entry in services: if not isinstance(entry, six.string_types): raise ValueError("Sentinel service types must be specified as strings.") def _get_service_names(self): """ Get a list of service names from Sentinel. Tries Sentinel hosts until one succeeds; if none succeed, raises a ConnectionError. """ master_info = None connection_errors = [] for sentinel in self._sentinel.sentinels: # Unfortunately, redis.sentinel.Sentinel does not support sentinel_masters, so we have to step # through all of its connections manually try: master_info = sentinel.sentinel_masters() break except (redis.ConnectionError, redis.TimeoutError) as e: connection_errors.append("Failed to connect to {}: {}".format(sentinel, e)) continue if master_info is None: raise redis.ConnectionError( "Could not get master info from sentinel\n{}.".format("\n".join(connection_errors))) return list(master_info.keys()) ### Connection handling #### def _master_for(self, service_name): if self.sentinel_refresh_interval <= 0: return self._sentinel.master_for(service_name) else: if (time.time() - self._last_sentinel_refresh) > self.sentinel_refresh_interval: self._populate_masters() return self._master_connections[service_name] def _populate_masters(self): self._master_connections = {service: self._sentinel.master_for(service) for service in self.services} self._last_sentinel_refresh = time.time() def connection(self, index): # return the master for the given index # If index is explicitly None, pick a random server if index is None: index = self.random_index() # Catch bad indexes if not 0 <= index < self.ring_size: raise ValueError("There are only %s hosts - you asked for %s!" % (self.ring_size, index)) service_name = self.services[index] return self._master_for(service_name) def random_index(self): return random.randint(0, len(self.services) - 1) ### Flush extension ### def flush(self): """ Deletes all messages and groups on all shards. """ for service_name in self.services: connection = self._master_for(service_name) self.delprefix(keys=[], args=[self.prefix + "*"], client=connection) self.delprefix(keys=[], args=[self.stats_prefix + "*"], client=connection) ### Statistics extension ### def global_statistics(self): connection_list = [self._master_for(service_name) for service_name in self.services] return self._count_global_stats(connection_list) def channel_statistics(self, channel): if "!" in channel or "?" in channel: connections = [self.connection(self.consistent_hash(channel))] else: # if we don't know where it is, we have to check in all shards connections = [self._master_for(service_name) for service_name in self.services] return self._count_channel_stats(channel, connections) def __str__(self): return "%s(services==%s)" % (self.__class__.__name__, self.services) asgi_redis-1.4.3/asgi_redis/twisted_utils.py000066400000000000000000000011071315657234400212270ustar00rootroot00000000000000from __future__ import unicode_literals try: from twisted.internet import defer except ImportError: class defer(object): """ Fake "defer" object that allows us to use decorators in the main class file but that errors when it's attempted to be invoked. Used so you can import the client without Twisted but can't run without it. """ @staticmethod def inlineCallbacks(func): def inner(*args, **kwargs): raise NotImplementedError("Twisted is not installed") return inner asgi_redis-1.4.3/docker-compose.yml000066400000000000000000000011241315657234400172750ustar00rootroot00000000000000redis-master-1: build: testing/redis redis-slave-1: build: testing/redis command: redis-server --slaveof redis-master-1 6379 links: - redis-master-1 redis-master-2: build: testing/redis redis-slave-2: build: testing/redis command: redis-server --slaveof redis-master-2 6379 links: - redis-master-2 sentinel: build: testing/sentinel links: - redis-master-1 - redis-master-2 - redis-slave-1 - redis-slave-2 test: build: . links: - redis-master-1 - redis-master-2 - redis-slave-1 - redis-slave-2 - sentinel volumes: - .:/src asgi_redis-1.4.3/pytest.ini000066400000000000000000000001621315657234400156720ustar00rootroot00000000000000[pytest] DJANGO_SETTINGS_MODULE = testproject.settings.channels_redis django_find_project = false addopts = -v -s asgi_redis-1.4.3/setup.cfg000066400000000000000000000000321315657234400154560ustar00rootroot00000000000000[bdist_wheel] universal=1 asgi_redis-1.4.3/setup.py000066400000000000000000000026521315657234400153610ustar00rootroot00000000000000from os.path import dirname, join from setuptools import find_packages, setup def get_version(): for line in open(join(dirname(__file__), 'asgi_redis', '__init__.py')): if line.startswith('__version__'): version_str = line.split('=')[-1].strip() version = version_str.replace('"', '').replace("'", '') return version # We use the README as the long_description readme = open(join(dirname(__file__), 'README.rst')).read() crypto_requires = ['cryptography>=1.3.0'] twisted_requires = ['twisted>=17.1', 'txredisapi'] test_requires = crypto_requires + [ 'pytest>=3.0', 'pytest-django>=3.0', 'asgi_ipc', 'channels>=1.1.0', 'requests>=2.12', 'websocket_client>=0.40', ] setup( name='asgi_redis', version=get_version(), url='http://github.com/django/asgi_redis/', author='Django Software Foundation', author_email='foundation@djangoproject.com', description='Redis-backed ASGI channel layer implementation', long_description=readme, license='BSD', zip_safe=False, packages=find_packages(exclude=['tests']), include_package_data=True, install_requires=[ 'six', 'redis~=2.10.6', 'msgpack-python', 'asgiref~=1.1.2', ], extras_require={ 'cryptography': crypto_requires, 'twisted': twisted_requires, 'tests': crypto_requires + twisted_requires + test_requires, }, ) asgi_redis-1.4.3/testing/000077500000000000000000000000001315657234400153175ustar00rootroot00000000000000asgi_redis-1.4.3/testing/redis/000077500000000000000000000000001315657234400164255ustar00rootroot00000000000000asgi_redis-1.4.3/testing/redis/Dockerfile000066400000000000000000000001711315657234400204160ustar00rootroot00000000000000FROM redis:3 COPY redis.conf /usr/local/etc/redis/redis.conf CMD [ "redis-server", "/usr/local/etc/redis/redis.conf" ] asgi_redis-1.4.3/testing/redis/redis.conf000066400000000000000000001211351315657234400204050ustar00rootroot00000000000000# Redis configuration file example. # # Note that in order to read the configuration file, Redis must be # started with the file path as first argument: # # ./redis-server /path/to/redis.conf # Note on units: when memory size is needed, it is possible to specify # it in the usual form of 1k 5GB 4M and so forth: # # 1k => 1000 bytes # 1kb => 1024 bytes # 1m => 1000000 bytes # 1mb => 1024*1024 bytes # 1g => 1000000000 bytes # 1gb => 1024*1024*1024 bytes # # units are case insensitive so 1GB 1Gb 1gB are all the same. ################################## INCLUDES ################################### # Include one or more other config files here. This is useful if you # have a standard template that goes to all Redis servers but also need # to customize a few per-server settings. Include files can include # other files, so use this wisely. # # Notice option "include" won't be rewritten by command "CONFIG REWRITE" # from admin or Redis Sentinel. Since Redis always uses the last processed # line as value of a configuration directive, you'd better put includes # at the beginning of this file to avoid overwriting config change at runtime. # # If instead you are interested in using includes to override configuration # options, it is better to use include as the last line. # # include /path/to/local.conf # include /path/to/other.conf ################################ GENERAL ##################################### # By default Redis does not run as a daemon. Use 'yes' if you need it. # Note that Redis will write a pid file in /var/run/redis.pid when daemonized. daemonize no # When running daemonized, Redis writes a pid file in /var/run/redis.pid by # default. You can specify a custom pid file location here. pidfile /var/run/redis.pid # Accept connections on the specified port, default is 6379. # If port 0 is specified Redis will not listen on a TCP socket. port 6379 # TCP listen() backlog. # # In high requests-per-second environments you need an high backlog in order # to avoid slow clients connections issues. Note that the Linux kernel # will silently truncate it to the value of /proc/sys/net/core/somaxconn so # make sure to raise both the value of somaxconn and tcp_max_syn_backlog # in order to get the desired effect. tcp-backlog 511 # By default Redis listens for connections from all the network interfaces # available on the server. It is possible to listen to just one or multiple # interfaces using the "bind" configuration directive, followed by one or # more IP addresses. # # Examples: # # bind 192.168.1.100 10.0.0.1 # bind 127.0.0.1 # Specify the path for the Unix socket that will be used to listen for # incoming connections. There is no default, so Redis will not listen # on a unix socket when not specified. # # unixsocket /tmp/redis.sock # unixsocketperm 700 # Close the connection after a client is idle for N seconds (0 to disable) timeout 0 # TCP keepalive. # # If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence # of communication. This is useful for two reasons: # # 1) Detect dead peers. # 2) Take the connection alive from the point of view of network # equipment in the middle. # # On Linux, the specified value (in seconds) is the period used to send ACKs. # Note that to close the connection the double of the time is needed. # On other kernels the period depends on the kernel configuration. # # A reasonable value for this option is 60 seconds. tcp-keepalive 0 # Specify the server verbosity level. # This can be one of: # debug (a lot of information, useful for development/testing) # verbose (many rarely useful info, but not a mess like the debug level) # notice (moderately verbose, what you want in production probably) # warning (only very important / critical messages are logged) loglevel notice # Specify the log file name. Also the empty string can be used to force # Redis to log on the standard output. Note that if you use standard # output for logging but daemonize, logs will be sent to /dev/null logfile "" # To enable logging to the system logger, just set 'syslog-enabled' to yes, # and optionally update the other syslog parameters to suit your needs. # syslog-enabled no # Specify the syslog identity. # syslog-ident redis # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. # syslog-facility local0 # Set the number of databases. The default database is DB 0, you can select # a different one on a per-connection basis using SELECT where # dbid is a number between 0 and 'databases'-1 databases 16 ################################ SNAPSHOTTING ################################ # # Save the DB on disk: # # save # # Will save the DB if both the given number of seconds and the given # number of write operations against the DB occurred. # # In the example below the behaviour will be to save: # after 900 sec (15 min) if at least 1 key changed # after 300 sec (5 min) if at least 10 keys changed # after 60 sec if at least 10000 keys changed # # Note: you can disable saving completely by commenting out all "save" lines. # # It is also possible to remove all the previously configured save # points by adding a save directive with a single empty string argument # like in the following example: # # save "" # save 900 1 # save 300 10 # save 60 10000 # By default Redis will stop accepting writes if RDB snapshots are enabled # (at least one save point) and the latest background save failed. # This will make the user aware (in a hard way) that data is not persisting # on disk properly, otherwise chances are that no one will notice and some # disaster will happen. # # If the background saving process will start working again Redis will # automatically allow writes again. # # However if you have setup your proper monitoring of the Redis server # and persistence, you may want to disable this feature so that Redis will # continue to work as usual even if there are problems with disk, # permissions, and so forth. stop-writes-on-bgsave-error yes # Compress string objects using LZF when dump .rdb databases? # For default that's set to 'yes' as it's almost always a win. # If you want to save some CPU in the saving child set it to 'no' but # the dataset will likely be bigger if you have compressible values or keys. rdbcompression yes # Since version 5 of RDB a CRC64 checksum is placed at the end of the file. # This makes the format more resistant to corruption but there is a performance # hit to pay (around 10%) when saving and loading RDB files, so you can disable it # for maximum performances. # # RDB files created with checksum disabled have a checksum of zero that will # tell the loading code to skip the check. rdbchecksum yes # The filename where to dump the DB dbfilename dump.rdb # The working directory. # # The DB will be written inside this directory, with the filename specified # above using the 'dbfilename' configuration directive. # # The Append Only File will also be created inside this directory. # # Note that you must specify a directory here, not a file name. dir ./ ################################# REPLICATION ################################# # Master-Slave replication. Use slaveof to make a Redis instance a copy of # another Redis server. A few things to understand ASAP about Redis replication. # # 1) Redis replication is asynchronous, but you can configure a master to # stop accepting writes if it appears to be not connected with at least # a given number of slaves. # 2) Redis slaves are able to perform a partial resynchronization with the # master if the replication link is lost for a relatively small amount of # time. You may want to configure the replication backlog size (see the next # sections of this file) with a sensible value depending on your needs. # 3) Replication is automatic and does not need user intervention. After a # network partition slaves automatically try to reconnect to masters # and resynchronize with them. # # slaveof # If the master is password protected (using the "requirepass" configuration # directive below) it is possible to tell the slave to authenticate before # starting the replication synchronization process, otherwise the master will # refuse the slave request. # # masterauth # When a slave loses its connection with the master, or when the replication # is still in progress, the slave can act in two different ways: # # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will # still reply to client requests, possibly with out of date data, or the # data set may just be empty if this is the first synchronization. # # 2) if slave-serve-stale-data is set to 'no' the slave will reply with # an error "SYNC with master in progress" to all the kind of commands # but to INFO and SLAVEOF. # slave-serve-stale-data yes # You can configure a slave instance to accept writes or not. Writing against # a slave instance may be useful to store some ephemeral data (because data # written on a slave will be easily deleted after resync with the master) but # may also cause problems if clients are writing to it because of a # misconfiguration. # # Since Redis 2.6 by default slaves are read-only. # # Note: read only slaves are not designed to be exposed to untrusted clients # on the internet. It's just a protection layer against misuse of the instance. # Still a read only slave exports by default all the administrative commands # such as CONFIG, DEBUG, and so forth. To a limited extent you can improve # security of read only slaves using 'rename-command' to shadow all the # administrative / dangerous commands. slave-read-only yes # Replication SYNC strategy: disk or socket. # # ------------------------------------------------------- # WARNING: DISKLESS REPLICATION IS EXPERIMENTAL CURRENTLY # ------------------------------------------------------- # # New slaves and reconnecting slaves that are not able to continue the replication # process just receiving differences, need to do what is called a "full # synchronization". An RDB file is transmitted from the master to the slaves. # The transmission can happen in two different ways: # # 1) Disk-backed: The Redis master creates a new process that writes the RDB # file on disk. Later the file is transferred by the parent # process to the slaves incrementally. # 2) Diskless: The Redis master creates a new process that directly writes the # RDB file to slave sockets, without touching the disk at all. # # With disk-backed replication, while the RDB file is generated, more slaves # can be queued and served with the RDB file as soon as the current child producing # the RDB file finishes its work. With diskless replication instead once # the transfer starts, new slaves arriving will be queued and a new transfer # will start when the current one terminates. # # When diskless replication is used, the master waits a configurable amount of # time (in seconds) before starting the transfer in the hope that multiple slaves # will arrive and the transfer can be parallelized. # # With slow disks and fast (large bandwidth) networks, diskless replication # works better. repl-diskless-sync no # When diskless replication is enabled, it is possible to configure the delay # the server waits in order to spawn the child that transfers the RDB via socket # to the slaves. # # This is important since once the transfer starts, it is not possible to serve # new slaves arriving, that will be queued for the next RDB transfer, so the server # waits a delay in order to let more slaves arrive. # # The delay is specified in seconds, and by default is 5 seconds. To disable # it entirely just set it to 0 seconds and the transfer will start ASAP. repl-diskless-sync-delay 5 # Slaves send PINGs to server in a predefined interval. It's possible to change # this interval with the repl_ping_slave_period option. The default value is 10 # seconds. # # repl-ping-slave-period 10 # The following option sets the replication timeout for: # # 1) Bulk transfer I/O during SYNC, from the point of view of slave. # 2) Master timeout from the point of view of slaves (data, pings). # 3) Slave timeout from the point of view of masters (REPLCONF ACK pings). # # It is important to make sure that this value is greater than the value # specified for repl-ping-slave-period otherwise a timeout will be detected # every time there is low traffic between the master and the slave. # # repl-timeout 60 # Disable TCP_NODELAY on the slave socket after SYNC? # # If you select "yes" Redis will use a smaller number of TCP packets and # less bandwidth to send data to slaves. But this can add a delay for # the data to appear on the slave side, up to 40 milliseconds with # Linux kernels using a default configuration. # # If you select "no" the delay for data to appear on the slave side will # be reduced but more bandwidth will be used for replication. # # By default we optimize for low latency, but in very high traffic conditions # or when the master and slaves are many hops away, turning this to "yes" may # be a good idea. repl-disable-tcp-nodelay no # Set the replication backlog size. The backlog is a buffer that accumulates # slave data when slaves are disconnected for some time, so that when a slave # wants to reconnect again, often a full resync is not needed, but a partial # resync is enough, just passing the portion of data the slave missed while # disconnected. # # The bigger the replication backlog, the longer the time the slave can be # disconnected and later be able to perform a partial resynchronization. # # The backlog is only allocated once there is at least a slave connected. # # repl-backlog-size 1mb # After a master has no longer connected slaves for some time, the backlog # will be freed. The following option configures the amount of seconds that # need to elapse, starting from the time the last slave disconnected, for # the backlog buffer to be freed. # # A value of 0 means to never release the backlog. # # repl-backlog-ttl 3600 # The slave priority is an integer number published by Redis in the INFO output. # It is used by Redis Sentinel in order to select a slave to promote into a # master if the master is no longer working correctly. # # A slave with a low priority number is considered better for promotion, so # for instance if there are three slaves with priority 10, 100, 25 Sentinel will # pick the one with priority 10, that is the lowest. # # However a special priority of 0 marks the slave as not able to perform the # role of master, so a slave with priority of 0 will never be selected by # Redis Sentinel for promotion. # # By default the priority is 100. slave-priority 100 # It is possible for a master to stop accepting writes if there are less than # N slaves connected, having a lag less or equal than M seconds. # # The N slaves need to be in "online" state. # # The lag in seconds, that must be <= the specified value, is calculated from # the last ping received from the slave, that is usually sent every second. # # This option does not GUARANTEE that N replicas will accept the write, but # will limit the window of exposure for lost writes in case not enough slaves # are available, to the specified number of seconds. # # For example to require at least 3 slaves with a lag <= 10 seconds use: # # min-slaves-to-write 3 # min-slaves-max-lag 10 # # Setting one or the other to 0 disables the feature. # # By default min-slaves-to-write is set to 0 (feature disabled) and # min-slaves-max-lag is set to 10. ################################## SECURITY ################################### # Require clients to issue AUTH before processing any other # commands. This might be useful in environments in which you do not trust # others with access to the host running redis-server. # # This should stay commented out for backward compatibility and because most # people do not need auth (e.g. they run their own servers). # # Warning: since Redis is pretty fast an outside user can try up to # 150k passwords per second against a good box. This means that you should # use a very strong password otherwise it will be very easy to break. # # requirepass foobared # Command renaming. # # It is possible to change the name of dangerous commands in a shared # environment. For instance the CONFIG command may be renamed into something # hard to guess so that it will still be available for internal-use tools # but not available for general clients. # # Example: # # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 # # It is also possible to completely kill a command by renaming it into # an empty string: # # rename-command CONFIG "" # # Please note that changing the name of commands that are logged into the # AOF file or transmitted to slaves may cause problems. ################################### LIMITS #################################### # Set the max number of connected clients at the same time. By default # this limit is set to 10000 clients, however if the Redis server is not # able to configure the process file limit to allow for the specified limit # the max number of allowed clients is set to the current file limit # minus 32 (as Redis reserves a few file descriptors for internal uses). # # Once the limit is reached Redis will close all the new connections sending # an error 'max number of clients reached'. # # maxclients 10000 # Don't use more memory than the specified amount of bytes. # When the memory limit is reached Redis will try to remove keys # according to the eviction policy selected (see maxmemory-policy). # # If Redis can't remove keys according to the policy, or if the policy is # set to 'noeviction', Redis will start to reply with errors to commands # that would use more memory, like SET, LPUSH, and so on, and will continue # to reply to read-only commands like GET. # # This option is usually useful when using Redis as an LRU cache, or to set # a hard memory limit for an instance (using the 'noeviction' policy). # # WARNING: If you have slaves attached to an instance with maxmemory on, # the size of the output buffers needed to feed the slaves are subtracted # from the used memory count, so that network problems / resyncs will # not trigger a loop where keys are evicted, and in turn the output # buffer of slaves is full with DELs of keys evicted triggering the deletion # of more keys, and so forth until the database is completely emptied. # # In short... if you have slaves attached it is suggested that you set a lower # limit for maxmemory so that there is some free RAM on the system for slave # output buffers (but this is not needed if the policy is 'noeviction'). # # maxmemory # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory # is reached. You can select among five behaviors: # # volatile-lru -> remove the key with an expire set using an LRU algorithm # allkeys-lru -> remove any key according to the LRU algorithm # volatile-random -> remove a random key with an expire set # allkeys-random -> remove a random key, any key # volatile-ttl -> remove the key with the nearest expire time (minor TTL) # noeviction -> don't expire at all, just return an error on write operations # # Note: with any of the above policies, Redis will return an error on write # operations, when there are no suitable keys for eviction. # # At the date of writing these commands are: set setnx setex append # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby # getset mset msetnx exec sort # # The default is: # # maxmemory-policy noeviction # LRU and minimal TTL algorithms are not precise algorithms but approximated # algorithms (in order to save memory), so you can tune it for speed or # accuracy. For default Redis will check five keys and pick the one that was # used less recently, you can change the sample size using the following # configuration directive. # # The default of 5 produces good enough results. 10 Approximates very closely # true LRU but costs a bit more CPU. 3 is very fast but not very accurate. # # maxmemory-samples 5 ############################## APPEND ONLY MODE ############################### # By default Redis asynchronously dumps the dataset on disk. This mode is # good enough in many applications, but an issue with the Redis process or # a power outage may result into a few minutes of writes lost (depending on # the configured save points). # # The Append Only File is an alternative persistence mode that provides # much better durability. For instance using the default data fsync policy # (see later in the config file) Redis can lose just one second of writes in a # dramatic event like a server power outage, or a single write if something # wrong with the Redis process itself happens, but the operating system is # still running correctly. # # AOF and RDB persistence can be enabled at the same time without problems. # If the AOF is enabled on startup Redis will load the AOF, that is the file # with the better durability guarantees. # # Please check http://redis.io/topics/persistence for more information. appendonly no # The name of the append only file (default: "appendonly.aof") appendfilename "appendonly.aof" # The fsync() call tells the Operating System to actually write data on disk # instead of waiting for more data in the output buffer. Some OS will really flush # data on disk, some other OS will just try to do it ASAP. # # Redis supports three different modes: # # no: don't fsync, just let the OS flush the data when it wants. Faster. # always: fsync after every write to the append only log. Slow, Safest. # everysec: fsync only one time every second. Compromise. # # The default is "everysec", as that's usually the right compromise between # speed and data safety. It's up to you to understand if you can relax this to # "no" that will let the operating system flush the output buffer when # it wants, for better performances (but if you can live with the idea of # some data loss consider the default persistence mode that's snapshotting), # or on the contrary, use "always" that's very slow but a bit safer than # everysec. # # More details please check the following article: # http://antirez.com/post/redis-persistence-demystified.html # # If unsure, use "everysec". # appendfsync always appendfsync everysec # appendfsync no # When the AOF fsync policy is set to always or everysec, and a background # saving process (a background save or AOF log background rewriting) is # performing a lot of I/O against the disk, in some Linux configurations # Redis may block too long on the fsync() call. Note that there is no fix for # this currently, as even performing fsync in a different thread will block # our synchronous write(2) call. # # In order to mitigate this problem it's possible to use the following option # that will prevent fsync() from being called in the main process while a # BGSAVE or BGREWRITEAOF is in progress. # # This means that while another child is saving, the durability of Redis is # the same as "appendfsync none". In practical terms, this means that it is # possible to lose up to 30 seconds of log in the worst scenario (with the # default Linux settings). # # If you have latency problems turn this to "yes". Otherwise leave it as # "no" that is the safest pick from the point of view of durability. no-appendfsync-on-rewrite no # Automatic rewrite of the append only file. # Redis is able to automatically rewrite the log file implicitly calling # BGREWRITEAOF when the AOF log size grows by the specified percentage. # # This is how it works: Redis remembers the size of the AOF file after the # latest rewrite (if no rewrite has happened since the restart, the size of # the AOF at startup is used). # # This base size is compared to the current size. If the current size is # bigger than the specified percentage, the rewrite is triggered. Also # you need to specify a minimal size for the AOF file to be rewritten, this # is useful to avoid rewriting the AOF file even if the percentage increase # is reached but it is still pretty small. # # Specify a percentage of zero in order to disable the automatic AOF # rewrite feature. auto-aof-rewrite-percentage 100 auto-aof-rewrite-min-size 64mb # An AOF file may be found to be truncated at the end during the Redis # startup process, when the AOF data gets loaded back into memory. # This may happen when the system where Redis is running # crashes, especially when an ext4 filesystem is mounted without the # data=ordered option (however this can't happen when Redis itself # crashes or aborts but the operating system still works correctly). # # Redis can either exit with an error when this happens, or load as much # data as possible (the default now) and start if the AOF file is found # to be truncated at the end. The following option controls this behavior. # # If aof-load-truncated is set to yes, a truncated AOF file is loaded and # the Redis server starts emitting a log to inform the user of the event. # Otherwise if the option is set to no, the server aborts with an error # and refuses to start. When the option is set to no, the user requires # to fix the AOF file using the "redis-check-aof" utility before to restart # the server. # # Note that if the AOF file will be found to be corrupted in the middle # the server will still exit with an error. This option only applies when # Redis will try to read more data from the AOF file but not enough bytes # will be found. aof-load-truncated yes ################################ LUA SCRIPTING ############################### # Max execution time of a Lua script in milliseconds. # # If the maximum execution time is reached Redis will log that a script is # still in execution after the maximum allowed time and will start to # reply to queries with an error. # # When a long running script exceeds the maximum execution time only the # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be # used to stop a script that did not yet called write commands. The second # is the only way to shut down the server in the case a write command was # already issued by the script but the user doesn't want to wait for the natural # termination of the script. # # Set it to 0 or a negative value for unlimited execution without warnings. lua-time-limit 5000 ################################ REDIS CLUSTER ############################### # # ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # WARNING EXPERIMENTAL: Redis Cluster is considered to be stable code, however # in order to mark it as "mature" we need to wait for a non trivial percentage # of users to deploy it in production. # ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # # Normal Redis instances can't be part of a Redis Cluster; only nodes that are # started as cluster nodes can. In order to start a Redis instance as a # cluster node enable the cluster support uncommenting the following: # # cluster-enabled yes # Every cluster node has a cluster configuration file. This file is not # intended to be edited by hand. It is created and updated by Redis nodes. # Every Redis Cluster node requires a different cluster configuration file. # Make sure that instances running in the same system do not have # overlapping cluster configuration file names. # # cluster-config-file nodes-6379.conf # Cluster node timeout is the amount of milliseconds a node must be unreachable # for it to be considered in failure state. # Most other internal time limits are multiple of the node timeout. # # cluster-node-timeout 15000 # A slave of a failing master will avoid to start a failover if its data # looks too old. # # There is no simple way for a slave to actually have a exact measure of # its "data age", so the following two checks are performed: # # 1) If there are multiple slaves able to failover, they exchange messages # in order to try to give an advantage to the slave with the best # replication offset (more data from the master processed). # Slaves will try to get their rank by offset, and apply to the start # of the failover a delay proportional to their rank. # # 2) Every single slave computes the time of the last interaction with # its master. This can be the last ping or command received (if the master # is still in the "connected" state), or the time that elapsed since the # disconnection with the master (if the replication link is currently down). # If the last interaction is too old, the slave will not try to failover # at all. # # The point "2" can be tuned by user. Specifically a slave will not perform # the failover if, since the last interaction with the master, the time # elapsed is greater than: # # (node-timeout * slave-validity-factor) + repl-ping-slave-period # # So for example if node-timeout is 30 seconds, and the slave-validity-factor # is 10, and assuming a default repl-ping-slave-period of 10 seconds, the # slave will not try to failover if it was not able to talk with the master # for longer than 310 seconds. # # A large slave-validity-factor may allow slaves with too old data to failover # a master, while a too small value may prevent the cluster from being able to # elect a slave at all. # # For maximum availability, it is possible to set the slave-validity-factor # to a value of 0, which means, that slaves will always try to failover the # master regardless of the last time they interacted with the master. # (However they'll always try to apply a delay proportional to their # offset rank). # # Zero is the only value able to guarantee that when all the partitions heal # the cluster will always be able to continue. # # cluster-slave-validity-factor 10 # Cluster slaves are able to migrate to orphaned masters, that are masters # that are left without working slaves. This improves the cluster ability # to resist to failures as otherwise an orphaned master can't be failed over # in case of failure if it has no working slaves. # # Slaves migrate to orphaned masters only if there are still at least a # given number of other working slaves for their old master. This number # is the "migration barrier". A migration barrier of 1 means that a slave # will migrate only if there is at least 1 other working slave for its master # and so forth. It usually reflects the number of slaves you want for every # master in your cluster. # # Default is 1 (slaves migrate only if their masters remain with at least # one slave). To disable migration just set it to a very large value. # A value of 0 can be set but is useful only for debugging and dangerous # in production. # # cluster-migration-barrier 1 # By default Redis Cluster nodes stop accepting queries if they detect there # is at least an hash slot uncovered (no available node is serving it). # This way if the cluster is partially down (for example a range of hash slots # are no longer covered) all the cluster becomes, eventually, unavailable. # It automatically returns available as soon as all the slots are covered again. # # However sometimes you want the subset of the cluster which is working, # to continue to accept queries for the part of the key space that is still # covered. In order to do so, just set the cluster-require-full-coverage # option to no. # # cluster-require-full-coverage yes # In order to setup your cluster make sure to read the documentation # available at http://redis.io web site. ################################## SLOW LOG ################################### # The Redis Slow Log is a system to log queries that exceeded a specified # execution time. The execution time does not include the I/O operations # like talking with the client, sending the reply and so forth, # but just the time needed to actually execute the command (this is the only # stage of command execution where the thread is blocked and can not serve # other requests in the meantime). # # You can configure the slow log with two parameters: one tells Redis # what is the execution time, in microseconds, to exceed in order for the # command to get logged, and the other parameter is the length of the # slow log. When a new command is logged the oldest one is removed from the # queue of logged commands. # The following time is expressed in microseconds, so 1000000 is equivalent # to one second. Note that a negative number disables the slow log, while # a value of zero forces the logging of every command. slowlog-log-slower-than 10000 # There is no limit to this length. Just be aware that it will consume memory. # You can reclaim memory used by the slow log with SLOWLOG RESET. slowlog-max-len 128 ################################ LATENCY MONITOR ############################## # The Redis latency monitoring subsystem samples different operations # at runtime in order to collect data related to possible sources of # latency of a Redis instance. # # Via the LATENCY command this information is available to the user that can # print graphs and obtain reports. # # The system only logs operations that were performed in a time equal or # greater than the amount of milliseconds specified via the # latency-monitor-threshold configuration directive. When its value is set # to zero, the latency monitor is turned off. # # By default latency monitoring is disabled since it is mostly not needed # if you don't have latency issues, and collecting data has a performance # impact, that while very small, can be measured under big load. Latency # monitoring can easily be enabled at runtime using the command # "CONFIG SET latency-monitor-threshold " if needed. latency-monitor-threshold 0 ############################# EVENT NOTIFICATION ############################## # Redis can notify Pub/Sub clients about events happening in the key space. # This feature is documented at http://redis.io/topics/notifications # # For instance if keyspace events notification is enabled, and a client # performs a DEL operation on key "foo" stored in the Database 0, two # messages will be published via Pub/Sub: # # PUBLISH __keyspace@0__:foo del # PUBLISH __keyevent@0__:del foo # # It is possible to select the events that Redis will notify among a set # of classes. Every class is identified by a single character: # # K Keyspace events, published with __keyspace@__ prefix. # E Keyevent events, published with __keyevent@__ prefix. # g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... # $ String commands # l List commands # s Set commands # h Hash commands # z Sorted set commands # x Expired events (events generated every time a key expires) # e Evicted events (events generated when a key is evicted for maxmemory) # A Alias for g$lshzxe, so that the "AKE" string means all the events. # # The "notify-keyspace-events" takes as argument a string that is composed # of zero or multiple characters. The empty string means that notifications # are disabled. # # Example: to enable list and generic events, from the point of view of the # event name, use: # # notify-keyspace-events Elg # # Example 2: to get the stream of the expired keys subscribing to channel # name __keyevent@0__:expired use: # # notify-keyspace-events Ex # # By default all notifications are disabled because most users don't need # this feature and the feature has some overhead. Note that if you don't # specify at least one of K or E, no events will be delivered. notify-keyspace-events "" ############################### ADVANCED CONFIG ############################### # Hashes are encoded using a memory efficient data structure when they have a # small number of entries, and the biggest entry does not exceed a given # threshold. These thresholds can be configured using the following directives. hash-max-ziplist-entries 512 hash-max-ziplist-value 64 # Similarly to hashes, small lists are also encoded in a special way in order # to save a lot of space. The special representation is only used when # you are under the following limits: list-max-ziplist-entries 512 list-max-ziplist-value 64 # Sets have a special encoding in just one case: when a set is composed # of just strings that happen to be integers in radix 10 in the range # of 64 bit signed integers. # The following configuration setting sets the limit in the size of the # set in order to use this special memory saving encoding. set-max-intset-entries 512 # Similarly to hashes and lists, sorted sets are also specially encoded in # order to save a lot of space. This encoding is only used when the length and # elements of a sorted set are below the following limits: zset-max-ziplist-entries 128 zset-max-ziplist-value 64 # HyperLogLog sparse representation bytes limit. The limit includes the # 16 bytes header. When an HyperLogLog using the sparse representation crosses # this limit, it is converted into the dense representation. # # A value greater than 16000 is totally useless, since at that point the # dense representation is more memory efficient. # # The suggested value is ~ 3000 in order to have the benefits of # the space efficient encoding without slowing down too much PFADD, # which is O(N) with the sparse encoding. The value can be raised to # ~ 10000 when CPU is not a concern, but space is, and the data set is # composed of many HyperLogLogs with cardinality in the 0 - 15000 range. hll-sparse-max-bytes 3000 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in # order to help rehashing the main Redis hash table (the one mapping top-level # keys to values). The hash table implementation Redis uses (see dict.c) # performs a lazy rehashing: the more operation you run into a hash table # that is rehashing, the more rehashing "steps" are performed, so if the # server is idle the rehashing is never complete and some more memory is used # by the hash table. # # The default is to use this millisecond 10 times every second in order to # actively rehash the main dictionaries, freeing memory when possible. # # If unsure: # use "activerehashing no" if you have hard latency requirements and it is # not a good thing in your environment that Redis can reply from time to time # to queries with 2 milliseconds delay. # # use "activerehashing yes" if you don't have such hard requirements but # want to free memory asap when possible. activerehashing yes # The client output buffer limits can be used to force disconnection of clients # that are not reading data from the server fast enough for some reason (a # common reason is that a Pub/Sub client can't consume messages as fast as the # publisher can produce them). # # The limit can be set differently for the three different classes of clients: # # normal -> normal clients including MONITOR clients # slave -> slave clients # pubsub -> clients subscribed to at least one pubsub channel or pattern # # The syntax of every client-output-buffer-limit directive is the following: # # client-output-buffer-limit # # A client is immediately disconnected once the hard limit is reached, or if # the soft limit is reached and remains reached for the specified number of # seconds (continuously). # So for instance if the hard limit is 32 megabytes and the soft limit is # 16 megabytes / 10 seconds, the client will get disconnected immediately # if the size of the output buffers reach 32 megabytes, but will also get # disconnected if the client reaches 16 megabytes and continuously overcomes # the limit for 10 seconds. # # By default normal clients are not limited because they don't receive data # without asking (in a push way), but just after a request, so only # asynchronous clients may create a scenario where data is requested faster # than it can read. # # Instead there is a default limit for pubsub and slave clients, since # subscribers and slaves receive data in a push fashion. # # Both the hard or the soft limit can be disabled by setting them to zero. client-output-buffer-limit normal 0 0 0 client-output-buffer-limit slave 256mb 64mb 60 client-output-buffer-limit pubsub 32mb 8mb 60 # Redis calls an internal function to perform many background tasks, like # closing connections of clients in timeout, purging expired keys that are # never requested, and so forth. # # Not all tasks are performed with the same frequency, but Redis checks for # tasks to perform according to the specified "hz" value. # # By default "hz" is set to 10. Raising the value will use more CPU when # Redis is idle, but at the same time will make Redis more responsive when # there are many keys expiring at the same time, and timeouts may be # handled with more precision. # # The range is between 1 and 500, however a value over 100 is usually not # a good idea. Most users should use the default of 10 and raise this up to # 100 only in environments where very low latency is required. hz 10 # When a child rewrites the AOF file, if the following option is enabled # the file will be fsync-ed every 32 MB of data generated. This is useful # in order to commit the file to the disk more incrementally and avoid # big latency spikes. aof-rewrite-incremental-fsync yesasgi_redis-1.4.3/testing/sentinel/000077500000000000000000000000001315657234400171405ustar00rootroot00000000000000asgi_redis-1.4.3/testing/sentinel/Dockerfile000066400000000000000000000002771315657234400211400ustar00rootroot00000000000000FROM redis:3 EXPOSE 26379 ADD sentinel.conf /etc/redis/sentinel.conf RUN chown redis:redis /etc/redis/sentinel.conf CMD docker-entrypoint.sh redis-server /etc/redis/sentinel.conf --sentinel asgi_redis-1.4.3/testing/sentinel/sentinel.conf000066400000000000000000000005611315657234400216320ustar00rootroot00000000000000port 26379 dir /tmp sentinel monitor master-1 redis-master-1 6379 2 sentinel down-after-milliseconds master-1 30000 sentinel parallel-syncs master-1 1 sentinel failover-timeout master-1 180000 sentinel monitor master-2 redis-master-2 6379 2 sentinel down-after-milliseconds master-2 30000 sentinel parallel-syncs master-2 1 sentinel failover-timeout master-2 180000 asgi_redis-1.4.3/tests/000077500000000000000000000000001315657234400150045ustar00rootroot00000000000000asgi_redis-1.4.3/tests/__init__.py000066400000000000000000000000001315657234400171030ustar00rootroot00000000000000asgi_redis-1.4.3/tests/constants.py000066400000000000000000000004551315657234400173760ustar00rootroot00000000000000import os if os.environ.get("DOCKER_TEST_ENV"): REDIS_HOSTS = [("redis-master-1", 6379), ("redis-master-2", 6379)] SERVICE_NAMES = ["master-1", "master-2"] SENTINEL_HOSTS = [("sentinel", 26379)] else: REDIS_HOSTS = [("localhost", 6379)] SERVICE_NAMES = [] SENTINEL_HOSTS = [] asgi_redis-1.4.3/tests/test_core.py000066400000000000000000000110251315657234400173440ustar00rootroot00000000000000from __future__ import unicode_literals import time import unittest from asgi_redis import RedisChannelLayer from asgiref.conformance import ConformanceTestCase from .constants import REDIS_HOSTS # Default conformance tests class RedisLayerTests(ConformanceTestCase): expiry_delay = 1.1 receive_tries = len(REDIS_HOSTS) @classmethod def setUpClass(cls): super(RedisLayerTests, cls).setUpClass() cls.channel_layer = RedisChannelLayer(hosts=REDIS_HOSTS, expiry=1, group_expiry=2, capacity=5) # The functionality this test is for is not yet present (it's not required, # and will slow stuff down, so will be optional), but it's here for future reference. @unittest.expectedFailure def test_group_message_eviction(self): """ Tests that when messages expire, group expiry also occurs. """ # Add things to a group and send a message that should expire self.channel_layer.group_add("tgme_group", "tgme_test") self.channel_layer.send_group("tgme_group", {"value": "blue"}) # Wait message expiry plus a tiny bit (must sum to less than group expiry) time.sleep(1.2) # Send new message to group, ensure message never arrives self.channel_layer.send_group("tgme_group", {"value": "blue"}) channel, message = self.receive(["tgme_test"]) self.assertIs(channel, None) self.assertIs(message, None) def test_received_message_deletion(self): """ Ensures that when a message is received, the key containing its content is deleted as well (and not just left to EXPIRE to clean up) Note that this does not correctly fail on a sharded test, as it just runs key stats on one shard to verify. It will, however, always pass if things are working. """ # Send and receive on the channel first to make the channel key self.channel_layer.send("test-deletion", {"first": True}) self.receive(["test-deletion"]) # Get the number of keys in the Redis database before we send num_keys = self.channel_layer.connection(0).dbsize() # Send and receive self.channel_layer.send("test-deletion", {"big": False}) self.receive(["test-deletion"]) # Verify the database did not grow in size self.assertEqual(num_keys, self.channel_layer.connection(0).dbsize()) def test_statistics(self): self.channel_layer.send("first_channel", {"pay": "load"}) self.channel_layer.send("first_channel", {"pay": "load"}) self.channel_layer.send("second_channel", {"pay": "load"}) self.assertEqual( self.channel_layer.global_statistics(), { 'messages_count': 3, 'channel_full_count': 0, } ) self.assertEqual( self.channel_layer.channel_statistics("first_channel"), { 'messages_count': 2, 'messages_pending': 2, 'messages_max_age': 0, 'channel_full_count': 0, } ) self.assertEqual( self.channel_layer.channel_statistics("second_channel"), { 'messages_count': 1, 'messages_pending': 1, 'messages_max_age': 0, 'channel_full_count': 0, } ) def test_channel_full_statistics(self): if self.capacity_limit is None: raise unittest.SkipTest("No test capacity specified") for _ in range(self.capacity_limit): self.channel_layer.send("first_channel", {"pay": "load"}) for _ in range(4): with self.assertRaises(RedisChannelLayer.ChannelFull): self.channel_layer.send("first_channel", {"pay": "load"}) # check that channel full exception are counted as such, not towards messages self.assertEqual(self.channel_layer.global_statistics()["channel_full_count"], 4) self.assertEqual( self.channel_layer.channel_statistics("first_channel")["channel_full_count"], 4) # Encrypted variant of conformance tests class EncryptedRedisLayerTests(ConformanceTestCase): expiry_delay = 1.1 receive_tries = len(REDIS_HOSTS) @classmethod def setUpClass(cls): super(EncryptedRedisLayerTests, cls).setUpClass() cls.channel_layer = RedisChannelLayer( hosts=REDIS_HOSTS, expiry=1, group_expiry=2, capacity=5, symmetric_encryption_keys=["test", "old"], ) asgi_redis-1.4.3/tests/test_integration.py000066400000000000000000000026121315657234400207410ustar00rootroot00000000000000import os import subprocess import sys import time import unittest import benchmark import requests import websocket from channels.test import ChannelLiveServerTestCase @unittest.skipIf(os.environ.get("DOCKER_TEST_ENV"), "Skipping integration tests in Docker") class IntegrationTest(ChannelLiveServerTestCase): def test_http_request(self): """Test the ability to send http requests and receive responses.""" response = requests.get(self.live_server_url) assert response.status_code == 200 def test_websocket_message(self): """Test the ability to send and receive messages over WebSocket.""" ws = websocket.create_connection(self.live_server_ws_url) ws.send('test') response = ws.recv() ws.close() assert 'test' == response def test_benchmark(self): """Run channels benchmark test suite.""" proc = subprocess.Popen([ sys.executable, benchmark.__file__, self.live_server_ws_url, ]) for _ in range(0, 90, 5): time.sleep(5) if proc.returncode: break else: proc.terminate() proc.wait() assert proc.returncode == 0 @unittest.skipIf(os.environ.get("DOCKER_TEST_ENV"), "Skipping integration tests in Docker") class ConcurrentIntegrationTest(IntegrationTest): worker_threads = 4 asgi_redis-1.4.3/tests/test_local.py000066400000000000000000000010671315657234400175130ustar00rootroot00000000000000from __future__ import unicode_literals from asgi_redis import RedisLocalChannelLayer from asgiref.conformance import ConformanceTestCase from .constants import REDIS_HOSTS # Local layer conformance tests class RedisLocalLayerTests(ConformanceTestCase): expiry_delay = 1.1 capacity_limit = 5 @classmethod def setUpClass(cls): super(RedisLocalLayerTests, cls).setUpClass() cls.channel_layer = RedisLocalChannelLayer( hosts=REDIS_HOSTS, expiry=1, group_expiry=2, capacity=5 ) asgi_redis-1.4.3/tests/test_sentinel.py000066400000000000000000000133311315657234400202370ustar00rootroot00000000000000from __future__ import unicode_literals import time import unittest import redis.sentinel from redis.sentinel import MasterNotFoundError from asgi_redis import RedisSentinelChannelLayer from asgiref.conformance import ConformanceTestCase from .constants import ( SERVICE_NAMES, SENTINEL_HOSTS, ) def sentinel_exists(): if not SENTINEL_HOSTS: return False sen = redis.sentinel.Sentinel(SENTINEL_HOSTS) try: sen.discover_master(SERVICE_NAMES[0]) except MasterNotFoundError: return False return True # Default conformance tests @unittest.skipUnless(sentinel_exists(), "Redis sentinel not running") class RedisLayerTests(ConformanceTestCase): expiry_delay = 1.1 receive_tries = len(SERVICE_NAMES) @classmethod def setUpClass(cls): super(RedisLayerTests, cls).setUpClass() cls.channel_layer = RedisSentinelChannelLayer( hosts=SENTINEL_HOSTS, expiry=1, group_expiry=2, capacity=5, services=SERVICE_NAMES ) # The functionality this test is for is not yet present (it's not required, # and will slow stuff down, so will be optional), but it's here for future reference. @unittest.expectedFailure def test_group_message_eviction(self): """ Tests that when messages expire, group expiry also occurs. """ # Add things to a group and send a message that should expire self.channel_layer.group_add("tgme_group", "tgme_test") self.channel_layer.send_group("tgme_group", {"value": "blue"}) # Wait message expiry plus a tiny bit (must sum to less than group expiry) time.sleep(1.2) # Send new message to group, ensure message never arrives self.channel_layer.send_group("tgme_group", {"value": "blue"}) channel, message = self.receive(["tgme_test"]) self.assertIs(channel, None) self.assertIs(message, None) def test_statistics(self): self.channel_layer.send("first_channel", {"pay": "load"}) self.channel_layer.send("first_channel", {"pay": "load"}) self.channel_layer.send("second_channel", {"pay": "load"}) self.assertEqual( self.channel_layer.global_statistics(), { 'messages_count': 3, 'channel_full_count': 0, } ) self.assertEqual( self.channel_layer.channel_statistics("first_channel"), { 'messages_count': 2, 'messages_pending': 2, 'messages_max_age': 0, 'channel_full_count': 0, } ) self.assertEqual( self.channel_layer.channel_statistics("second_channel"), { 'messages_count': 1, 'messages_pending': 1, 'messages_max_age': 0, 'channel_full_count': 0, } ) def test_channel_full_statistics(self): if self.capacity_limit is None: raise unittest.SkipTest("No test capacity specified") for _ in range(self.capacity_limit): self.channel_layer.send("first_channel", {"pay": "load"}) for _ in range(4): with self.assertRaises(RedisSentinelChannelLayer.ChannelFull): self.channel_layer.send("first_channel", {"pay": "load"}) # check that channel full exception are counted as such, not towards messages for _ in range(self.capacity_limit): self.channel_layer.send("first_channel", {"pay": "load"}) for _ in range(4): with self.assertRaises(RedisSentinelChannelLayer.ChannelFull): self.channel_layer.send("first_channel", {"pay": "load"}) # check that channel full exception are counted as such, not towards messages self.assertEqual(self.channel_layer.global_statistics()["channel_full_count"], 4) self.assertEqual( self.channel_layer.channel_statistics("first_channel")["channel_full_count"], 4) # Encrypted variant of conformance tests @unittest.skipUnless(sentinel_exists(), "Redis sentinel not running") class EncryptedRedisLayerTests(ConformanceTestCase): expiry_delay = 1.1 receive_tries = len(SERVICE_NAMES) @classmethod def setUpClass(cls): super(EncryptedRedisLayerTests, cls).setUpClass() cls.channel_layer = RedisSentinelChannelLayer( hosts=SENTINEL_HOSTS, expiry=1, group_expiry=2, capacity=5, symmetric_encryption_keys=["test", "old"], services=SERVICE_NAMES, ) # Test that the backend can auto-discover masters from Sentinel @unittest.skipUnless(sentinel_exists(), "Redis sentinel not running") class AutoDiscoverRedisLayerTests(ConformanceTestCase): expiry_delay = 1.1 receive_tries = len(SERVICE_NAMES) @classmethod def setUpClass(cls): super(AutoDiscoverRedisLayerTests, cls).setUpClass() cls.channel_layer = RedisSentinelChannelLayer( hosts=SENTINEL_HOSTS, expiry=1, group_expiry=2, capacity=5, ) # Test that the backend can cache Sentinel master connections if given a refresh interval @unittest.skipUnless(sentinel_exists(), "Redis sentinel not running") class CachingRedisLayerTests(ConformanceTestCase): expiry_delay = 1.1 receive_tries = len(SERVICE_NAMES) @classmethod def setUpClass(cls): super(CachingRedisLayerTests, cls).setUpClass() cls.channel_layer = RedisSentinelChannelLayer( hosts=SENTINEL_HOSTS, expiry=1, group_expiry=2, capacity=5, services=SERVICE_NAMES, sentinel_refresh_interval=60, ) asgi_redis-1.4.3/tests/test_twisted.py000066400000000000000000000033611315657234400201030ustar00rootroot00000000000000from __future__ import unicode_literals import unittest # Twisted tests are skipped in setUpClass below if Twisted isn't present. try: from twisted.internet import defer, reactor import twisted.trial.unittest except ImportError: pass from .test_core import RedisChannelLayer from .constants import REDIS_HOSTS class TwistedTests(twisted.trial.unittest.TestCase): @classmethod def setUpClass(cls): try: import twisted except ImportError: raise unittest.SkipTest('Twisted not present, skipping Twisted tests.') def setUp(self): super(TwistedTests, self).setUp() self.channel_layer = RedisChannelLayer(hosts=REDIS_HOSTS, expiry=1, group_expiry=2, capacity=5) @defer.inlineCallbacks def test_receive_twisted(self): self.channel_layer.send("sr_test", {"value": "blue"}) self.channel_layer.send("sr_test", {"value": "green"}) self.channel_layer.send("sr_test2", {"value": "red"}) # Get just one first channel, message = yield self.channel_layer.receive_twisted(["sr_test"]) self.assertEqual(channel, "sr_test") self.assertEqual(message, {"value": "blue"}) # And the second channel, message = yield self.channel_layer.receive_twisted(["sr_test"]) self.assertEqual(channel, "sr_test") self.assertEqual(message, {"value": "green"}) # And the other channel with multi select channel, message = yield self.channel_layer.receive_twisted(["sr_test", "sr_test2"]) self.assertEqual(channel, "sr_test2") self.assertEqual(message, {"value": "red"}) def tearDown(self): del self.channel_layer reactor.removeAll() super(TwistedTests, self).tearDown() asgi_redis-1.4.3/tox.ini000066400000000000000000000003151315657234400151540ustar00rootroot00000000000000[tox] envlist = py27,py35 [testenv] extras = tests deps = git+https://github.com/django/channels.git#egg=channels-benchmark&subdirectory=testproject passenv = DOCKER_TEST_ENV commands = py.test {posargs}