typhonius/acquia-logstream

连接到Acquia Logstream服务的PHP库

0.0.13 2023-03-09 19:07 UTC

README

Packagist Acquia Logstream Test Total Downloads License

Acquia Logstream

预安装

  1. 运行 composer install

生成API访问令牌

要生成API访问令牌,请登录到https://cloud.acquia.com,然后访问https://cloud.acquia.com/#/profile/tokens,并点击创建令牌

  • 为访问令牌提供标签,以便于识别。点击创建令牌

  • 令牌生成后,将API密钥和API密钥复制到安全的地方。请确保你现在记录下来:你将无法再次检索此访问令牌的密钥。

用法

独立工具

Phar文件

Phar文件将被附加到GitHub上每个标记的版本。您可以下载并立即使用,使用php logstream.phar acquia:logstream

Shell脚本

已包含一个shell脚本作为logstream命令的包装器,用户可以直接运行logstream命令而无需进一步的要求。可以从克隆的目录运行./bin/logstream acquia:logstream来调用它。

PHP库

可以将LogstreamManager类包含在任何其他PHP库中,就像它在Acquia Cli工具中一样。包含和调用此库的最简单方法是以下所示

use AcquiaCloudApi\Connector\Client;
use AcquiaCloudApi\Connector\Connector;
use AcquiaCloudApi\Endpoints\Logs;
use AcquiaLogstream\LogstreamManager;

$config = [
    'key' => 'FILL ME',
    'secret' => 'FILL ME'
];

$environmentUuid = 'FILL ME'

$connector = new Connector($config);
$client = Client::factory($connector);
$logs = new Logs($client);

$stream = $logs->stream($environmentUuid);
$params = $stream->logstream->params;

$logstream = new LogstreamManager($input, $output, $params);
$logstream->stream();

更高级的用法允许通过LogstreamManager类上的方法设置和配置不同的选项。

命令参数

Logstream命令作为参数接受三个必需的参数。

  • 您的Acquia API密钥
  • 您的Acquia API密钥
  • 环境UUID

还有三个可选参数,可用于过滤日志类型、从服务器流日志以及启用着色。

示例

# Show help
./bin/logstream acquia:logstream --help

# Stream all logs from all servers
./bin/logstream acquia:logstream APIKEY APISECRET ENVIRONMENTUUID

# Stream Varnish and NGINX logs
./bin/logstream acquia:logstream APIKEY APISECRET ENVIRONMENTUUID -t bal-request -t varnish-request

# Stream PHP error and Apache error logs from one server
./bin/logstream acquia:logstream APIKEY APISECRET ENVIRONMENTUUID -t php-error -t apache-error -s web-1234

# Stream all logs with colourisation to determine which log type is used
./bin/logstream acquia:logstream APIKEY APISECRET ENVIRONMENTUUID -c