Menu Docs

Página inicial do Docs → Manual da Biblioteca PHP

MongoDB\Client::addSubscriber()

Nesta página

  • Definição
  • Parâmetros
  • Erros/exceções
  • Comportamento
  • Exemplo
  • Veja também

Novidades na versão 1.18.

Definição

MongoDB\Client::addSubscriber()

Registra um assinante de evento de monitoramento com este cliente. O assinante será notificado de todos os eventos para este cliente.

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

Parâmetros

$subscriber : MongoDB\Driver\Monitoring\Subscriber
Um assinante de eventos de monitoramento para registrar com este cliente.

Erros/exceções

MongoDB\Exception\InvalidArgumentException para erros relacionados à análise de parâmetros ou opções.

MongoDB\Driver\Exception\InvalidArgumentException se o assinante for MongoDB\Driver\Monitoring\LogSubscriber , pois os loggers só podem ser registrados globalmente com MongoDB\Driver\Monitoring\addSubscriber.

Comportamento

Se $subscriber já estiver registrado com este cliente, esta função será um no-op. Se $subscriber também estiver registrado globalmente, ele ainda será notificado apenas uma vez de cada evento para esse cliente.

Exemplo

Crie um MongoDB\Driver\Monitoring\CommandSubscriber que registre todos os eventos:

<?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,
        ));
    }
}

O assinante pode então ser registrado com um cliente:

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

O código acima escreverá o seguinte na saída 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}

Veja também

← MongoDB\Client::__get()
MongoDB\Client::createClientEncryption() →

Nesta página