interactive-solutions/zf-log-handler

Interactive Solutions 日志处理器

1.0.0 2019-03-12 12:20 UTC

This package is auto-updated.

Last update: 2024-09-13 00:02:01 UTC


README

一个用于将异常(带有堆栈跟踪)和请求/响应详情记录到配置适配器的实用程序库。

请求持续时间

如果定义了常量 START_TIME,持续时间将成为发送到每个适配器的数据的一部分。如果您想记录持续时间,应在应用程序引导之前使用 define('START_TIME', microtime(true))

适配器

所有适配器都必须实现 AdapterInterface,本库中内置的唯一适配器是 ElasticsearchAdapter,它将数据记录到 Elasticsearch。

选项

LogHandlerOptions

处理本库的通用配置。

以下示例配置

LogHandlerOptions::class => [
    'environment'     => 'dev',
    'debug'           => true,
    'adapters'        => [
        ElasticsearchAdapter::class,
    ],
    'alwaysLogRoutes' => [],
],
  • environment 是一个字符串,将被添加到正在记录的数据数组中,如果日志包含来自多个环境的数据,则非常有用。
  • debug 如果设置为 true,将记录每个传入请求及其对应的响应;如果设置为 false,将禁用请求/响应的记录。
  • adapters 实现 AdapterInterface 的适配器列表,每个适配器的 write 方法将所有要记录的数据
  • alwaysLogRoutes 路由名列表,其请求和相应的响应应该始终记录(即使 debug 设置为 false)

ElasticsearchOptions

处理 ElasticsearchAdapter 的配置。

以下示例配置

ElasticsearchOptions::class => [
    'host'     => 'localhost,
    'port'     => <port>,
    'username' => '',
    'password' => '',
    'prefix'   => 'project-name',
],
  • host Elasticsearch 主机
  • port Elasticsearch 主机的端口
  • username 登录到 Elasticsearch 的用户名
  • password 登录到 Elasticsearch 的密码
  • prefix 应该记录数据的 Elasticsearch 索引的前缀