README

Laravel Pulse 的 S3 指标卡

从 AWS CloudWatch 获取您的 S3 存储桶的现有数据使用量和存储指标，并在您的 Laravel Pulse 控制台中以卡片形式显示。

雇佣我们

Arcana Softworks 的开发者已经为超过 10 年的企业级 PHP 应用程序构建。了解更多关于我们能为您或您的企业做什么。

安装

您可以通过 composer 安装此包

composer require arcana/laravel-pulse-s3-metrics

您可以选择通过以下命令发布配置文件

php artisan vendor:publish --tag="laravel-pulse-s3-metrics-config"

这是已发布配置文件的内容

return [

    'enabled' => env('PULSE_S3_METRICS_ENABLED', true),

    'key' => env('AWS_ACCESS_KEY_ID'),

    'secret' => env('AWS_SECRET_ACCESS_KEY'),

    'region' => env('AWS_DEFAULT_REGION'),

    'bucket' => env('AWS_BUCKET'),

    'class' => env('AWS_STORAGE_CLASS', 'StandardStorage'),
    
];

默认情况下，此包将获取您在 AWS_BUCKET 环境变量中指定的 S3 存储桶的指标。您可以通过设置 bucket 配置值来覆盖此设置。

您可能缺少的变量是 AWS_STORAGE_CLASS 变量，该变量已由本包引入。此变量应设置为您的 S3 存储桶的存储类。默认值为 StandardStorage，这是 S3 存储桶的默认存储类。如果您有不同的存储类，应将此变量设置为适当的值。

区域应该是您在 CloudWatch 上存储 S3 指标的区域。

安装记录器

发布 Laravel Pulse 配置，以便您可以添加 S3 指标记录器

php artisan vendor:publish --tag=pulse-config

这将发布 Pulse 配置到 config/pulse.php

将 S3 指标记录器添加到 Pulse 配置的 recorders 部分

'recorders' => [
    
    // Existing recorders...
    // ...
    
    \Arcana\PulseS3Metrics\Recorders\S3Metrics::class => [
        'enabled' => env('PULSE_S3_METRICS_ENABLED', true),
    ],
    
],

将卡片添加到您的 Laravel Pulse 控制台

发布 Laravel Pulse 控制台视图

php artisan vendor:publish --tag=pulse-dashboard

这将发布 Pulse 控制台视图到 resources/views/vendor/pulse/dashboard.blade.php

将 S3 指标卡添加到您的仪表板（卡片在全宽时看起来最好）

<x-pulse>

    <livewire:pulse-s3-metrics cols="full" />
    
    {{-- Existing cards... --}}
    
</x-pulse>

用法

S3 指标卡可能不会立即显示您 S3 存储桶的指标。可能需要长达 24 小时才能在 CloudWatch 上提供指标。

记录器将在 php artisan pulse:work 运行时定期运行。您可以在终端窗口中运行此命令以启动记录器

php artisan pulse:check

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

请参阅我们的安全策略了解如何报告安全漏洞。

鸣谢

许可证

MIT 许可证 (MIT)。请参阅许可证文件了解更多信息。

arcana / laravel-pulse-s3-metrics

维护者

详细信息