diff --git a/config/websockets.php b/config/websockets.php index b7ffe7c..28b14b4 100644 --- a/config/websockets.php +++ b/config/websockets.php @@ -214,6 +214,7 @@ return [ 'logger' => \BeyondCode\LaravelWebSockets\Statistics\Logger\MemoryStatisticsLogger::class, // 'logger' => \BeyondCode\LaravelWebSockets\Statistics\Logger\NullStatisticsLogger::class, + // 'logger' => \BeyondCode\LaravelWebSockets\Statistics\Logger\RedisStatisticsLogger::class, /* |-------------------------------------------------------------------------- diff --git a/docs/horizontal-scaling/getting-started.md b/docs/horizontal-scaling/getting-started.md index fffd7fa..3408fff 100644 --- a/docs/horizontal-scaling/getting-started.md +++ b/docs/horizontal-scaling/getting-started.md @@ -32,3 +32,23 @@ Now, when your app broadcasts the message, it will make sure the connection reac The available drivers for replication are: - [Redis](redis) + +## Configure the Statistics driver + +If you work with multi-node environments, beside replication, you shall take a look at the statistics logger. Each time your user connects, disconnects or send a message, you can track the statistics. However, these are centralized in one place before they are dumped in the database. + +Unfortunately, you might end up with multiple rows when multiple servers run in parallel. + +To fix this, just change the `statistics.logger` class with a logger that is able to centralize the statistics in one place. For example, you might want to store them into a Redis instance: + +```php +'statistics' => [ + + 'logger' => \BeyondCode\LaravelWebSockets\Statistics\Logger\RedisStatisticsLogger::class, + + ... + +], +``` + +Check the `websockets.php` config file for more details. diff --git a/docs/horizontal-scaling/redis.md b/docs/horizontal-scaling/redis.md index ee6c758..55020fe 100644 --- a/docs/horizontal-scaling/redis.md +++ b/docs/horizontal-scaling/redis.md @@ -34,4 +34,3 @@ You can set the connection name to the Redis database under `redis`: ``` The connections can be found in your `config/database.php` file, under the `redis` key. It defaults to connection `default`. - diff --git a/src/Statistics/Logger/RedisStatisticsLogger.php b/src/Statistics/Logger/RedisStatisticsLogger.php new file mode 100644 index 0000000..e6125b2 --- /dev/null +++ b/src/Statistics/Logger/RedisStatisticsLogger.php @@ -0,0 +1,206 @@ +channelManager = $channelManager; + $this->driver = $driver; + $this->redis = Cache::getRedis(); + } + + /** + * Handle the incoming websocket message. + * + * @param mixed $appId + * @return void + */ + public function webSocketMessage($appId) + { + $this->ensureAppIsSet($appId) + ->hincrby($this->getHash($appId), 'websocket_message_count', 1); + } + + /** + * Handle the incoming API message. + * + * @param mixed $appId + * @return void + */ + public function apiMessage($appId) + { + $this->ensureAppIsSet($appId) + ->hincrby($this->getHash($appId), 'api_message_count', 1); + } + + /** + * Handle the new conection. + * + * @param mixed $appId + * @return void + */ + public function connection($appId) + { + $currentConnectionCount = $this->ensureAppIsSet($appId) + ->hincrby($this->getHash($appId), 'current_connection_count', 1); + + $currentPeakConnectionCount = $this->redis->hget($this->getHash($appId), 'peak_connection_count'); + + $peakConnectionCount = is_null($currentPeakConnectionCount) + ? 1 + : max($currentPeakConnectionCount, $currentConnectionCount); + + $this->redis->hset($this->getHash($appId), 'peak_connection_count', $peakConnectionCount); + } + + /** + * Handle disconnections. + * + * @param mixed $appId + * @return void + */ + public function disconnection($appId) + { + $currentConnectionCount = $this->ensureAppIsSet($appId) + ->hincrby($this->getHash($appId), 'current_connection_count', -1); + + $currentPeakConnectionCount = $this->redis->hget($this->getHash($appId), 'peak_connection_count'); + + $peakConnectionCount = is_null($currentPeakConnectionCount) + ? 0 + : max($currentPeakConnectionCount, $currentConnectionCount); + + $this->redis->hset($this->getHash($appId), 'peak_connection_count', $peakConnectionCount); + } + + /** + * Save all the stored statistics. + * + * @return void + */ + public function save() + { + $this->lock()->get(function () { + foreach ($this->redis->smembers('laravel-websockets:apps') as $appId) { + if (! $statistic = $this->redis->hgetall($this->getHash($appId))) { + continue; + } + + $this->driver::create([ + 'app_id' => $appId, + 'peak_connection_count' => $statistic['peak_connection_count'] ?? 0, + 'websocket_message_count' => $statistic['websocket_message_count'] ?? 0, + 'api_message_count' => $statistic['api_message_count'] ?? 0, + ]); + + $currentConnectionCount = $this->channelManager->getConnectionCount($appId); + + $currentConnectionCount === 0 + ? $this->resetAppTraces($appId) + : $this->resetStatistics($appId, $currentConnectionCount); + } + }); + } + + /** + * Ensure the app id is stored in the Redis database. + * + * @param mixed $appId + * @return \Illuminate\Redis\RedisManager + */ + protected function ensureAppIsSet($appId) + { + $this->redis->sadd('laravel-websockets:apps', $appId); + + return $this->redis; + } + + /** + * Reset the statistics to a specific connection count. + * + * @param mixed $appId + * @param int $currentConnectionCount + * @return void + */ + public function resetStatistics($appId, int $currentConnectionCount) + { + $this->redis->hset($this->getHash($appId), 'current_connection_count', $currentConnectionCount); + $this->redis->hset($this->getHash($appId), 'peak_connection_count', $currentConnectionCount); + $this->redis->hset($this->getHash($appId), 'websocket_message_count', 0); + $this->redis->hset($this->getHash($appId), 'api_message_count', 0); + } + + /** + * Remove all app traces from the database if no connections have been set + * in the meanwhile since last save. + * + * @param mixed $appId + * @return void + */ + public function resetAppTraces($appId) + { + $this->redis->hdel($this->getHash($appId), 'current_connection_count'); + $this->redis->hdel($this->getHash($appId), 'peak_connection_count'); + $this->redis->hdel($this->getHash($appId), 'websocket_message_count'); + $this->redis->hdel($this->getHash($appId), 'api_message_count'); + + $this->redis->srem('laravel-websockets:apps', $appId); + } + + /** + * Get the Redis hash name for the app. + * + * @param mixed $appId + * @return string + */ + protected function getHash($appId): string + { + return "laravel-websockets:app:{$appId}"; + } + + /** + * Get a new RedisLock instance to avoid race conditions. + * + * @return \Illuminate\Cache\CacheLock + */ + protected function lock() + { + return new RedisLock($this->redis, 'laravel-websockets:lock', 0); + } +} diff --git a/tests/Statistics/Logger/FakeStatisticsLogger.php b/tests/Mocks/FakeMemoryStatisticsLogger.php similarity index 83% rename from tests/Statistics/Logger/FakeStatisticsLogger.php rename to tests/Mocks/FakeMemoryStatisticsLogger.php index 629e627..88f1e11 100644 --- a/tests/Statistics/Logger/FakeStatisticsLogger.php +++ b/tests/Mocks/FakeMemoryStatisticsLogger.php @@ -1,10 +1,10 @@ assertCount(0, WebSocketsStatisticsEntry::all()); } + + /** @test */ + public function it_counts_connections_with_redis_logger_with_no_data() + { + $this->runOnlyOnRedisReplication(); + + config(['cache.default' => 'redis']); + + $connection = $this->getConnectedWebSocketConnection(['channel-1']); + + $logger = new RedisStatisticsLogger( + $this->channelManager, + $this->statisticsDriver + ); + + $logger->resetAppTraces('1234'); + + $logger->webSocketMessage($connection->app->id); + $logger->apiMessage($connection->app->id); + $logger->connection($connection->app->id); + $logger->disconnection($connection->app->id); + + $logger->save(); + + $this->assertCount(1, WebSocketsStatisticsEntry::all()); + + $entry = WebSocketsStatisticsEntry::first(); + + $this->assertEquals(1, $entry->peak_connection_count); + $this->assertEquals(1, $entry->websocket_message_count); + $this->assertEquals(1, $entry->api_message_count); + } + + /** @test */ + public function it_counts_connections_with_redis_logger_with_existing_data() + { + $this->runOnlyOnRedisReplication(); + + config(['cache.default' => 'redis']); + + $connection = $this->getConnectedWebSocketConnection(['channel-1']); + + $logger = new RedisStatisticsLogger( + $this->channelManager, + $this->statisticsDriver + ); + + $logger->resetStatistics('1234', 0); + + $logger->webSocketMessage($connection->app->id); + $logger->apiMessage($connection->app->id); + $logger->connection($connection->app->id); + $logger->disconnection($connection->app->id); + + $logger->save(); + + $this->assertCount(1, WebSocketsStatisticsEntry::all()); + + $entry = WebSocketsStatisticsEntry::first(); + + $this->assertEquals(1, $entry->peak_connection_count); + $this->assertEquals(1, $entry->websocket_message_count); + $this->assertEquals(1, $entry->api_message_count); + } } diff --git a/tests/TestCase.php b/tests/TestCase.php index 9f27541..e817fb8 100644 --- a/tests/TestCase.php +++ b/tests/TestCase.php @@ -8,8 +8,8 @@ use BeyondCode\LaravelWebSockets\PubSub\Drivers\RedisClient; use BeyondCode\LaravelWebSockets\PubSub\ReplicationInterface; use BeyondCode\LaravelWebSockets\Statistics\Drivers\StatisticsDriver; use BeyondCode\LaravelWebSockets\Tests\Mocks\Connection; +use BeyondCode\LaravelWebSockets\Tests\Mocks\FakeMemoryStatisticsLogger; use BeyondCode\LaravelWebSockets\Tests\Mocks\Message; -use BeyondCode\LaravelWebSockets\Tests\Statistics\Logger\FakeStatisticsLogger; use BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManager; use GuzzleHttp\Psr7\Request; use Orchestra\Testbench\BrowserKit\TestCase as BaseTestCase; @@ -58,7 +58,7 @@ abstract class TestCase extends BaseTestCase $this->statisticsDriver = $this->app->make(StatisticsDriver::class); - StatisticsLogger::swap(new FakeStatisticsLogger( + StatisticsLogger::swap(new FakeMemoryStatisticsLogger( $this->channelManager, app(StatisticsDriver::class) ));