README

项目使用

此包允许您将项目数据发送到所选端点，以便您可以跟踪统计信息，例如数据库大小、使用了多少内存以及使用了哪些包。

安装

composer require marshmallow/server-project-usage

使用

首先发布配置或更新以下值的 .env 文件。

PROJECT_USAGE_API_ENDPOINT=XXXXX
PROJECT_USAGE_CUSTOMER_ID=XXXXXX
PROJECT_USAGE_PROJECT_ID=XXXXXX

设置自动更新

将以下命令添加到您的 composer.json 中，以便在每次 composer 更新时更新您面板中的信息。

"scripts": {
    "post-autoload-dump": [
        // ...
        "@php artisan marshmallow:publish-package-usage --ansi"
    ],
    // ...
}

安排您的更新

将命令添加到您的项目计划中，并在您的配置文件中处理端点的请求以存储要发送的数据。

protected function schedule(Schedule $schedule)
{
    $schedule->command('marshmallow:publish-project-usage')->daily();
}

命令

# This will show the data that will be send to the endpoint
php artisan marshmallow:show-project-usage

# This will do a post request to the endpoint in the config
php artisan marshmallow:publish-project-usage

# This will only post the package information to your endpoint
php artisan marshmallow:publish-package-usage

数据

以下是将发送到 API 端点的数据。

{
	"customer_id": "XXXXXX",
	"project_id": "XXXXXX",
	"data": {
		"server": {
			"php_version": "7.4.8"
		},
		"database": {
			"size": 14155776,		// bytes
			"table_count": 31
		},
		"storage": {
			"root": 284579340,		// bytes
			"storage": 53010322		// bytes
		},
		"packages": {
			"composer": {
				"marshmallow/package-novastyling": "v1.1.1",
				"marshmallow/server-project-usage": "v1.0.4"
				// ...
			},
			"dependencies": {
				"doctrine/inflector": "2.0.3",
				"laravel/ui": "v2.1.0"
				// ...
			}
		}
	}
}