MongoDB\Client::addSubscriber()

バージョン1.18の新機能。

定義

MongoDB\Client::addSubscriber()

このクライアントを使用してモニタリングイベントサブスクライブを登録します。サブスクライブには、このクライアントのすべてのイベントが通知されます。

function addSubscriber(MongoDB\Driver\Monitoring\Subscriber $subscriber): void

パラメーター

$subscriber : MongoDB\ドライバー\モニタリング\Subscriber: このクライアントに登録するモニタリングイベントサブスクライブ。

エラーと例外

MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合はです。

サブスクリプションがMongoDB$Driver\Monitoring\LogSubscriber の場合、 MongoDB$Driver\Exception\InvalidArgmentException。これは、ロガーがMongoDB$Driver\Monitoring\addSubscriber を使用してグローバルに登録できるためです。

動作

$subscriberがすでにこのクライアントに登録されている場合、この関数は実行されません。 $subscriberもグローバルに登録されている場合でも、このクライアントの各イベントに 1 回のみ通知されます。

例

すべてのイベントをログに記録するMongoDB\Driver\Monitoring\CommandSubscriber を作成します。

<?php
use MongoDB\Driver\Monitoring\CommandSubscriber;use MongoDB\Driver\Monitoring\CommandStartedEvent;use MongoDB\Driver\Monitoring\CommandSucceededEvent;use MongoDB\Driver\Monitoring\CommandFailedEvent;
class LogCommandSubscriber implements CommandSubscriber{    private $stream;    public function __construct($stream)    {        $this->stream = $stream;    }
    public function commandStarted(CommandStartedEvent $event): void    {        fwrite($this->stream, sprintf(            'Started command #%d "%s": %s%s',            $event->getRequestId(),            $event->getCommandName(),            Document::fromPHP($event->getCommand())->toCanonicalExtendedJSON(),            PHP_EOL,        ));    }
    public function commandSucceeded(CommandSucceededEvent $event): void    {        fwrite($this->stream, sprintf(            'Succeeded command #%d "%s" in %d microseconds: %s%s',            $event->getRequestId(),            $event->getCommandName(),            $event->getDurationMicros(),            json_encode($event->getReply()),            PHP_EOL,        ));    }
    public function commandFailed(CommandFailedEvent $event): void    {        fwrite($this->stream, sprintf(            'Failed command #%d "%s" in %d microseconds: %s%s',            $event->getRequestId(),            $event->getCommandName(),            $event->getDurationMicros(),            $event->getError()->getMessage(),            PHP_EOL,        ));    }}

その後、サブスクライブをクライアントに登録できます。

<?php
$client = new MongoDB\Client();$subscriber = new LogCommandSubscriber(STDERR);
$client->addSubscriber($subscriber);
$client->test->users->insertOne(['username' => 'alice']);

上記のコードでは、stderr 出力に以下が書き込まれます。

Started command #1 "insert": { "insert" : "users", "ordered" : true, "$db" : "test", "lsid" : { "id" : { "$binary" : { "base64" : "dKTBhZD7Qvi0vUhvR58mCA==", "subType" : "04" } } }, "documents" : [ { "username" : "alice", "_id" : { "$oid" : "655d1fca12e81018340a4fc2" } } ] }Succeeded command #1 "insert" in 876 microseconds: {"n":1,"ok":1}

その他の参照

戻る

__get()

createClientEncryption()