sahilr2050/yii2-cloudwatch-logs

将应用日志按时间顺序输出到AWS Cloudwatch的Yii2日志目标。

1.0.0 2022-12-22 06:36 UTC

This package is auto-updated.

Last update: 2024-09-28 11:35:26 UTC


README

一个用于AWS Cloudwatch Logs的Yii2日志目标。

安装和配置

通过composer安装包

composer require sahilr2050/yii2-cloudwatch-logs

然后将以下内容添加到您的应用程序配置中

<?php
return [
    // ...
    'components' => [
        // ...
        'log' => [
            'targets' => [
                [
                    'class' => \sahilr2050\YiiCloudwatchLogs\Target::class,
                    'region' => 'eu-west-1',
                    'logGroup' => '/webserver/production/my-craft',
                    'logStream' => 'instance-1', // omit for automatic instance ID
                    'levels' => ['error', 'warning', 'info', 'trace', 'profile'],
                    'logVars' => ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER'],
                    'key' => 'your-key', // omit for instance role
                    'secret' => 'your-secret', // omit for instance role
                ],
                // ...
            ],
        ],

配置选项

  • (string) $region (必填) AWS区域名称,例如eu-west-1
  • (string) $logGroup (必填) 日志组名称。
  • (string) $logStream (可选) 日志流名称。如果省略,它将尝试确定运行在上的EC2实例的ID。
  • (array) $levels (可选) 日志级别。默认由Yii2提供:['error', 'warning', 'info', 'trace', 'profile']
  • (array) $logVars (可选) 要记录的变量。默认由Yii2提供:['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER']
  • (string) $key (可选) 您的AWS访问密钥。
  • (string) $secret (可选) 您的AWS密钥。

速率限制

Cloudwatch Logs API需要发送序列令牌与消息到日志流。此令牌在将消息传输到日志流后返回,用于下次传输。对于多进程系统,这很困难处理。

因此,AWS Cloudwatch Logs不支持多个进程同时向同一个日志流写入。他们的官方方法是为每个实例上的每个进程创建一个单独的日志流。但考虑到PHP-FPM在多个实例上具有动态子进程。这最终会导致日志组中出现数千个废弃的日志流。空日志流不会被自动删除并保留在日志组中。它们不收取任何费用,但会使日志组非常混乱。

我们的方法是为每个实例创建一个日志流。为了能够同时从多个进程发送日志流,必须在每次传输之前查询日志流的当前序列令牌。但AWS Cloudwatch Log API对此类请求有每秒60个请求的限制。

为了避免遇到此速率限制,强烈建议只将那些很少发生且重要的日志直接发送到Cloudwatch Logs。例如警告和错误。

在具有许多同时运行进程且日志负载高的大型基础设施中,仍然最好使用文件日志和Cloudwatch Log代理,因为这只是一个单进程。

也许将来会有所改变。

Cloudwatch Logs Insights

如果您想使用Insights解析日志,则可以这样做

fields @timestamp, @message
| sort @timestamp desc
| limit 20
| parse '[*][*][*][*][*] *' as ip, userId, sessionId, logLevel, category, message