The MongoDB\Driver\Monitoring\CommandFailedEvent class

Introduction

The MongoDB\Driver\Monitoring\CommandFailedEvent class encapsulates information about a failed command.

MongoDB\Driver\Monitoring\CommandFailedEvent

final class MongoDB\Driver\Monitoring\CommandFailedEvent {

/* Properties */

public readonly string $host;

public readonly int $port;

public readonly string $commandName;

public readonly string $databaseName;

public readonly int $duration;

public readonly Exception $error;

public readonly object $reply;

public readonly string $operationId;

public readonly string $requestId;

public readonly MongoDB\BSON\ObjectIdnull $serviceId;

public readonly intnull $serverConnectionId;

/* Methods */

final public string getCommandName()

final public string getDatabaseName()

final public int getDurationMicros()

final public Exception getError()

final public string getHost()

final public string getOperationId()

final public int getPort()

final public object getReply()

final public string getRequestId()

final public MongoDB\Driver\Server getServer()

final public intnull getServerConnectionId()

final public MongoDB\BSON\ObjectIdnull getServiceId()

}

host: The hostname of the server that executed the command.
port: The port of the server that executed the command.
commandName: The command name.
databaseName: The database name.
duration: The duration of the command in microseconds. The duration is a calculated value that includes the time to send the message and receive the response from the server.
error: The exception that was thrown when the command failed.
reply: The failure reply document returned by the server.
operationId: The operation ID. This may be used to link events together such as bulk writes, which may dispatch multiple commands.
requestId: The request ID. This may be used to associate this MongoDB\Driver\Monitoring\CommandFailedEvent with a corresponding MongoDB\Driver\Monitoring\CommandStartedEvent.
serviceId: The service ID, or null if the server does not support it (i.e. not using load-balanced mode).
serverConnectionId: The server connection ID, or null if not available.

Version	Description
PECL mongodb 2.3.0	Added public readonly properties. The `duration` property replaces the getDurationMicros method.

Table of Contents