praatmetdedokter/pulse-redis-monitor

Laravel Pulse 的 Redis 监控卡片

v0.1.3 2024-08-14 10:30 UTC

This package is auto-updated.

Last update: 2024-09-19 13:31:04 UTC


README

这是一个可自定义的 Laravel Pulse 卡片,用于监控关键 Redis 指标。

功能

此卡片监控并显示以下 Redis 指标

  • 内存使用

    • 已用内存:Redis 当前正在使用的内存量。
    • 最大内存:Redis 可用最大内存。
  • 关键统计信息

    • 总键数:Redis 当前存储的总键数。
    • 有过期时间的键:有过期时间的键的数量。
  • 移除键

    • 过期键:在 TTL 过期后自动删除的键的数量。
    • 被驱逐键:由于 Redis 空间不足而因内存限制被驱逐的键的数量。
  • 平均 TTL:Redis 中键的平均剩余存活时间 (TTL)。

  • 网络使用

    • 总流量:Redis 接收和发送的数据总和(流入 + 流出)。

安装

首先,通过 composer 安装此包

composer require praatmetdedokter/pulse-redis-monitor

然后,将记录器添加到你的 config/pulse.php

return [
    // ...

    'recorders' => [
        PraatmetdeDokter\Pulse\RedisMonitor\Recorders\RedisMonitorRecorder::class => [
            'connections' => env('PULSE_REDIS_MONITOR_CONNECTIONS', ['default']),
            'interval' => env('PULSE_REDIS_MONITOR_INTERVAL', 5), // Interval in minutes between monitoring events
            'colors' => [
                'primary' => '#ee3969',
                'secondary' => '#2ca3cc'
            ],
            'metrics' => [
                'memory_usage' => env('PULSE_REDIS_MONITOR_MEMORY_USAGE', true),
                'key_statistics' => env('PULSE_REDIS_MONITOR_KEY_STATISTICS', true),
                'removed_keys' => env('PULSE_REDIS_MONITOR_REMOVED_KEYS', true),
                'network_usage' => env('PULSE_REDIS_MONITOR_NETWORK_USAGE', true),
            ]
        ],

        // ...
    ],
];

接下来,将卡片添加到你的 resources/views/vendor/pulse/dashboard.blade.php

<x-pulse>
    <livewire:pulse.redis-monitor/>

    <!-- ... -->
</x-pulse>

使用方法

不要忘记运行 pulse:check 命令以开始记录。

配置

要自定义 Redis Monitor Recorder 的行为,你可以在配置中可选地包含 colorsmetrics 设置。你只需指定你想要从默认设置中更改的值。

配置选项

  • colors:为图表定义自定义颜色。
  • metrics:禁用特定指标。

许可证

MIT 许可证(MIT)。有关更多信息,请参阅 许可文件