Class Mongo::Monitoring::Event::CommandFailed
In: lib/mongo/monitoring/event/command_failed.rb
Parent: Mongo::Event::Base

Event that is fired when a command operation fails.

@since 2.1.0

Methods

generate   new  

Attributes

address  [R]  @return [ Server::Address ] address The server address.
command_name  [R]  @return [ String ] command_name The name of the command.
database_name  [R]  @return [ String ] database_name The name of the database_name.
duration  [R]  @return [ Float ] duration The duration of the command in seconds.
failure  [R]  @return [ BSON::Document ] failure The error document, if present. 
  This will only be filled out for errors communicated by a
  MongoDB server. In other situations, for example in case of
  a network error, this attribute may be nil.
message  [R]  @return [ String ] message The error message. Unlike the error 
  document, the error message should always be present.
operation_id  [R]  @return [ Integer ] operation_id The operation id.
request_id  [R]  @return [ Integer ] request_id The request id.

Public Class methods

generate(address, operation_id, payload, message, failure, duration)

Create the event from a wire protocol message payload.

@example Create the event. 

  CommandFailed.generate(address, 1, payload, duration)

@param [ Server::Address ] address The server address. @param [ Integer ] operation_id The operation id. @param [ Hash ] payload The message payload. @param [ String ] message The error message. @param [ BSON::Document ] failure The error document, if any. @param [ Float ] duration The duration of the command in seconds.

@return [ CommandFailed ] The event.

@since 2.1.0 @api private

new(command_name, database_name, address, request_id, operation_id, message, failure, duration)

Create the new event.

@example Create the event.

@param [ String ] command_name The name of the command. @param [ String ] database_name The database_name name. @param [ Server::Address ] address The server address. @param [ Integer ] request_id The request id. @param [ Integer ] operation_id The operation id. @param [ String ] message The error message. @param [ BSON::Document ] failure The error document, if any. @param [ Float ] duration The duration the command took in seconds.

@since 2.1.0 @api private

[Validate]