README

日志接口

本文件描述了日志库的通用接口。

主要目标是允许库接收一个 His\Log\LoggerInterface 对象，并以简单通用的方式向其写入日志。有特殊需求的框架和CMS可以扩展接口以实现自己的目的，但应保持与本文件的兼容性。这确保了应用程序使用的第三方库可以向集中式应用程序日志写入。

本文件中“必须”、“禁止”、“必需”、“应当”、“不应”、“推荐”、“可以”、“可选”等关键词的解释与RFC 2119中的描述一致。

本文件中“实现者”一词的解释为在日志相关库或框架中实现LoggerInterface的人。使用日志记录器的用户称为“用户”。

LoggerInterface提供了八个方法来向八个RFC 5424级别（调试、信息、注意、警告、错误、严重、警报、紧急）写入日志。
第九个方法log接受一个日志级别作为第一个参数。调用此方法并传递其中一个日志级别常量，其结果必须与调用特定级别的特定方法相同。调用此方法并传递本规范未定义的级别，如果实现者不知道该级别，则必须抛出His\Log\Exception\InvalidArgumentException。用户在没有确切知道当前实现是否支持自定义级别的情况下，不应使用自定义级别。

每个方法都接受一个数组作为上下文数据。这旨在包含不适合字符串的任何额外信息。数组可以包含任何内容。实现者必须确保尽可能宽松地处理上下文数据。上下文中的特定值不得抛出异常或引发任何PHP错误、警告或通知。
如果上下文数据中传递了Exception对象，则必须在'exception'键中。记录异常是一种常见模式，这允许实现者在日志后端支持的情况下从异常中提取堆栈跟踪。实现者在使用之前必须验证'exception'键确实是一个Exception，因为它可能包含任何内容。