README

The Redis Info package provides detailed monitoring and insights into your Redis database for Laravel applications. It helps track Redis usage, cache performance, and key management, making it an essential tool for debugging, optimizing, and monitoring Redis-based operations.

⚠️ Important Notice: Install Redis Before Using This Package

Before using this package, ensure that Redis is installed and running on your server. Without Redis, this package will not function correctly.

Refer to the official Redis installation guide for setup instructions:
🔗 Redis System Installation Guide

🔗 Laravel Redis Package Installation Guide

⚠️ Security Warning

This package does not include any built-in security measures and is intended for admin use only. It exposes sensitive redis details which could pose a security risk if accessed by unauthorized users.Ensure that this package is only used in a secure environment and not exposed to public or unauthorized access.

🏷️ #Redis #Caching #Laravel #PHP #Performance #Optimization #Monitoring

Documentation

Features
Supported Versions
Installation
Commands - Vendor Publish - Environment Configuration
- Accessing the Plugin
FAQs
Contributing
Security Vulnerabilities
License
Testing
Support

Features

Monitor Redis usage in Laravel applications.
Track cache and database performance.
View real-time Redis statistics (memory, uptime, commands).
Filter and search Redis keys dynamically.
Supports Laravel 9, 10, and 11 with PHP 8+ compatibility.
Lightweight and optimized for fast responses.
Easy setup with vendor publish and migration commands.
Detailed analytics for cache and session keys.

Supported Versions

PHP: ^8.0
Illuminate Support: ^9.0 | ^10.0 | ^11.0

Installation

To install the package, open the terminal and run the following command:

composer require itpathsolutions/redisinfo

Vendor Publish

Run the following command to publish the vendor files:

php artisan vendor:publish --provider="Itpathsolutions\RedisInfo\RedisServiceProvider"

Environment Configuration

After installing, add the following settings to your .env file:

CACHE_DRIVER=redis
SESSION_DRIVER=redis
QUEUE_CONNECTION=redis
REDIS_CLIENT=predis
REDIS_HOST=your_redis_host   # Default: 127.0.0.1
REDIS_PASSWORD=your_redis_password   # Leave empty if no password
REDIS_PORT=your_redis_port   # Default: 6379

⚠️ Important: Ensure Redis is installed and running. If any of these values are missing, Laravel may throw errors.

Once done, clear the cache to apply changes:

php artisan config:clear

Accessing the Plugin

Once installed, you can use the following route to access Redis insights:

localhost:8000/redis-info

This route displays memory usage, uptime, key stats, and database info in a user-friendly dashboard.

FAQs

1. What does this package do?

🔍 The Redis Info package provides an insightful dashboard to monitor Redis memory, keys, and performance statistics in Laravel applications.

2. How do I install the package?

📦 Run the following command in your terminal:

composer require itpathsolutions/redisinfo

3. Which Laravel versions are supported?

This package supports Laravel 9, 10, and 11 with PHP 8+ compatibility.

4. How do I access the Redis Info dashboard?

You can access the dashboard via:
👉 localhost:8000/redis-info

5. How do I update the package to the latest version?

Run the following command to update:

composer update itpathsolutions/redisinfo

6. Can I contribute to this package?

🤝 Absolutely! Contributions are welcome. See the CONTRIBUTING guidelines for details.

7. Where can I get support?

For any support or queries, contact us via IT Path Solutions.

Contributing

We welcome contributions from the community! Feel free to Fork the repository and contribute to this module. You can also create a pull request, and we will merge your changes into the main branch. See CONTRIBUTING for details.

Security Vulnerabilities

Please review our Security Policy on how to report security vulnerabilities.

License

This package is open-source and available under the MIT License. See the LICENSE file for details.

Testing

To test this package, run the following command:

composer test

Get Support

Feel free to contact us if you have any questions.
If you find this project helpful, please give us a ⭐ Star.

itpathsolutions / redisinfo

Maintainers

Details