Class Mongo::Monitoring::Event::CommandSucceeded
In: lib/mongo/monitoring/event/command_succeeded.rb
Parent: Mongo::Event::Base

Event that is fired when a command operation succeeds.

@since 2.1.0

Methods

generate   new  

Included Modules

Secure

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.
duration  [R]  @return [ Float ] duration The duration of the event.
operation_id  [R]  @return [ Integer ] operation_id The operation id.
reply  [R]  @return [ BSON::Document ] reply The command reply.
request_id  [R]  @return [ Integer ] request_id The request id.

Public Class methods

generate(address, operation_id, command_payload, reply_payload, duration)

Create the event from a wire protocol message payload.

@example Create the event. 

  CommandSucceeded.generate(address, 1, command_payload, reply_payload, 0.5)

@param [ Server::Address ] address The server address. @param [ Integer ] operation_id The operation id. @param [ Hash ] command_payload The command message payload. @param [ Hash ] reply_payload The reply message payload. @param [ Float ] duration The duration of the command in seconds.

@return [ CommandCompleted ] The event.

@since 2.1.0 @api private

new(command_name, database_name, address, request_id, operation_id, reply, 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. @param [ Server::Address ] address The server address. @param [ Integer ] request_id The request id. @param [ Integer ] operation_id The operation id. @param [ BSON::Document ] reply The command reply. @param [ Float ] duration The duration the command took in seconds.

@since 2.1.0 @api private

[Validate]