Laravel LogViewer 日志管理工具使用指南
项目地址: https://gitcode.com/gh_mirrors/lo/LogViewer 项目概述
LogViewer 是一个专为 Laravel 框架设计的强大日志查看和管理工具。它提供了一个直观的界面来浏览、搜索、过滤和管理应用程序的日志文件，支持处理大型日志文件，是开发者和系统管理员监控应用运行状态的理想选择。
核心特性
- 完整的日志管理功能：查看、分页、过滤、下载和删除日志文件
- 多版本兼容：支持 Laravel 5.x 到 11.x 版本
- 开箱即用：包含完整的视图、路由、控制器等组件
- 自定义存储路径：支持加载自定义日志存储路径
- 本地化支持：提供多语言日志级别显示
- 高性能处理：能够流畅处理大型日志文件
- 完善的文档：提供详细的 API 文档和代码注释
安装与配置
环境要求
LogViewer 仅支持 daily 日志通道，请确保在 .env 文件中将 LOG_CHANNEL 设置为 daily 而不是 stack。
对于 Laravel 5.5 及以下版本，请在 .env 文件中设置：
APP_LOG=daily
版本兼容性
| Laravel 版本 | LogViewer 版本 |
|---|---|
| Laravel 11.x | LogViewer 11.x |
| Laravel 10.x | LogViewer 10.x |
| Laravel 9.x | LogViewer 9.x |
| Laravel 8.x | LogViewer 8.x |
| Laravel 7.x | LogViewer 7.x |
安装步骤
- 通过 Composer 安装：
composer require arcanedev/log-viewer:~11.0.0
- 服务提供者注册（Laravel 5.5 以下版本需要手动注册）：
在 config/app.php 的 providers 数组中添加：
'providers' => [
...
Arcanedev\LogViewer\LogViewerServiceProvider::class,
],
发布资源
发布配置和翻译文件：
php artisan log-viewer:publish
强制发布（覆盖现有文件）：
php artisan log-viewer:publish --force
仅发布配置文件：
php artisan log-viewer:publish --tag=config
仅发布翻译文件：
php artisan log-viewer:publish --tag=translations
配置详解
存储路径配置
'storage-path' => storage_path('logs'),
日志文件模式
'pattern' => [
'prefix' => 'laravel-',
'date' => '[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]',
'extension' => '.log',
],
本地化设置
'locale' => 'auto',
支持的语言包括：auto、ar、bg、de、en、es、et、fa、fr、hu、hy、id、it、ja、ko、nl、pl、pt-BR、ro、ru、sv、th、tr、zh-TW、zh。
主题配置
'theme' => 'bootstrap-4',
支持的主题：bootstrap-3、bootstrap-4、bootstrap-5。
路由设置
'route' => [
'enabled' => true,
'attributes' => [
'prefix' => 'log-viewer',
'middleware' => env('ARCANEDEV_LOGVIEWER_MIDDLEWARE') ? explode(',', env('ARCANEDEV_LOGVIEWER_MIDDLEWARE')) : null,
],
],
使用说明
访问日志查看器
安装完成后，通过以下 URL 访问日志查看器：
http://yourdomain.com/log-viewer
Artisan 命令
检查应用要求和日志文件：
php artisan log-viewer:check
清除所有生成的日志文件：
php artisan log-viewer:clear
界面功能
LogViewer 提供了三个主要界面：
仪表板显示日志文件的统计信息和概览
日志列表页面展示所有可用的日志文件
单一日志查看页面显示详细的日志内容和条目
高级配置
分页设置
'per-page' => 30,
下载设置
'download' => [
'prefix' => 'laravel-',
'extension' => 'log',
],
菜单设置
'menu' => [
'filter-route' => 'log-viewer::logs.filter',
'icons-enabled' => true,
],
图标配置
'icons' => [
'all' => 'fa fa-fw fa-list',
'emergency' => 'fa fa-fw fa-bug',
'alert' => 'fa fa-fw fa-bullhorn',
'critical' => 'fa fa-fw fa-heartbeat',
'error' => 'fa fa-fw fa-times-circle',
'warning' => 'fa fa-fw fa-exclamation-triangle',
'notice' => 'fa fa-fw fa-exclamation-circle',
'info' => 'fa fa-fw fa-info-circle',
'debug' => 'fa fa-fw fa-life-ring',
],
颜色配置
'colors' => [
'levels' => [
'empty' => '#D1D1D1',
'all' => '#8A8A8A',
'emergency' => '#B71C1C',
'alert' => '#D32F2F',
'critical' => '#F44336',
'error' => '#FF5722',
'warning' => '#FF9100',
'notice' => '#4CAF50',
'info' => '#1976D2',
'debug' => '#90CAF9',
],
],
最佳实践
- 定期检查日志：使用
log-viewer:check命令定期验证日志配置 - 合理设置分页：根据日志文件大小调整每页显示的条目数
- 使用中间件保护：在生产环境中为日志查看器添加适当的身份验证中间件
- 自定义主题：根据项目需求创建自定义主题
目录结构
- 核心源码：src/
- 配置文件：config/log-viewer.php
- 文档文件：_docs/
- 视图文件：views/
- 翻译文件：translations/
通过本指南，您可以快速掌握 LogViewer 的安装、配置和使用方法，有效管理和分析 Laravel 应用程序的日志信息。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
