cxj/looking-glass

远程来源状态数据的中央监控和显示

0.0.1 2023-03-21 02:30 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Looking Glass 是一个基于 Laravel 的应用程序,用于提供多个应用程序状态和健康数据的快速概述。它提供了一个简单的仪表盘,列出所有配置的应用程序检查及其当前状态。任何能够调用 HTTP webhook 的应用程序都可以将其状态数据通信到 Looking Glass 以供展示。

要求

PHP 8.1+ 服务器,可以访问合理的 SQL 数据库,最好是 MySQL 或等效的。

安装

通过 composer 安装此包

composer require cxj/looking-glass

使用以下命令运行迁移

php artisan migrate

用法

这是早期测试版软件。更多功能和文档即将推出。

  • 用户账户默认对所有用户开放注册,在 /register URL 路径上。您可能需要实施一些限制来控制潜在用户。

  • 创建用户账户并登录以查看当前状态仪表板。

  • 需要定期通过 cron 或类似机制运行 Laravel 调度工作进程(例如 artisan schedule:work

  • 使用 Spatie Laravel Health 包,有关更多详细信息,请参阅 Spatie 的优秀文档。

  • 使用 Spatie Webhook Client 包,有关更多详细信息,请参阅 Spatie 的项目。可以通过 Spatie Webhook Server 包轻松地向 Looking Glass 发送 webhook 调用。JSON 有效负载很简单,Bearer Token 身份验证也是如此。几乎所有软件都应该能够成功调用 Looking Glass webhook 以交付状态有效负载。

示例 JSON 有效负载

{
	"name": "Test-app",
	"label": "Test-label",
	"result": {
		"meta": [],
		"ended_at": "",
		"status": "ok",
		"notificationMessage": "notification-message",
		"shortSummary": "short-summary"
	}
}

如果您想使用 Looking Glass 来监控 Laravel 应用程序,请查看 Laravel Looking Glass Client 包。

测试

./vendor/bin/pest

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

贡献

有关详细信息,请参阅 CONTRIBUTING

安全漏洞

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

鸣谢

许可

GNU Affero 通用公共许可证版本 3。请参阅 许可文件 了解更多信息。