README

在CMS中显示您的SilverStripe日志条目。

需求

• PHP 5.6+
• SilverStripe ^4.0
• Composer

安装

使用composer安装

composer require silverleague/logviewer

这是一个即插即用模块。只需安装，然后运行dev/build并刷新

sake dev/build flush=1

现在您将在CMS中看到“日志”选项卡

配置

此模块有一些配置选项。这些可以在您的YAML配置中修改，例如 - mysite/_config/logviewer.yml

---
Name: mysitelogviewer
---
# Configuration for the cleanup task
SilverLeague\LogViewer\Model\LogEntry:
  # Whether the cleanup task should be run by a cron task (you need to figure the cron yourself)
  # Type: bool
  cron_enabled: true
  # How often the cron should run (default: 4am daily)
  # Type: string (a cron expression)
  cron_schedule: 0 4 * * *
  # The maximum age in days for a LogEntry before it will be removed by the cleanup task
  # Type: int
  max_log_age: 30
  # Which Monolog\Logger levels (numeric) to start handling from (see class for examples)
  minimum_log_level: 300 # WARNING

虽然这是默认配置的副本，但如果默认配置尚未存在或不同，则此配置将告诉LogViewer您希望在每天凌晨4点通过cron计划清理超过30天的旧日志条目。您还只想保留“WARNING”级别或更高（有关所有可用级别，请参阅Monolog\Logger）的日志。

测试

该存储库中有一个示例BuildTask，您可以使用它来生成每个PSR-3日志级别的日志，以供测试。

上面的截图是运行它后的结果，使用的是上面的示例配置。

清理

如前所述，如果您已经有一个正在运行的silverstripe/crontask模块，则默认情况下RemoveOldLogEntriesTask将在每天凌晨4点运行，并删除超过30天的日志条目。

您可以通过使用sake或ssconsole从命令行手动运行任务。

# With sake:
vendor/bin/sake dev/tasks/RemoveOldLogEntriesTask

# With ssconsole:
ssconsole dev:tasks:remove-old-log-entries

您还可以通过点击“清除所有”从管理区域中的日志界面中完全删除所有日志条目。这将清除所有日志，而不仅仅是超过30天的日志。

支持

如果您在我们的模块中遇到问题，请通过在我们的问题跟踪器上创建问题来告知我们。

请确保告诉我们您正在使用此模块的哪个版本，以及您正在使用的PHP和SilverStripe框架的版本。如果您不确定，您可以从命令行运行以下命令来找出： php -v，composer show silverleague/logviewer 和 composer show silverstripe/framework。

贡献

有关更多信息，请参阅贡献指南。