Class Mongo::Monitoring::Event::CommandStarted
In: lib/mongo/monitoring/event/command_started.rb
Parent: Mongo::Event::Base

Event that is fired when a command operation starts.

@since 2.1.0

Methods

generate   inspect   new  

Included Modules

Secure

Attributes

address  [R]  @return [ Server::Address ] address The server address.
command  [R]  @return [ BSON::Document ] command The command arguments.
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.
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)

Create the event from a wire protocol message payload.

@example Create the event. 

  CommandStarted.generate(address, 1, payload)

@param [ Server::Address ] address The server address. @param [ Integer ] operation_id The operation id. @param [ Hash ] payload The message payload.

@return [ CommandStarted ] The event.

@since 2.1.0 @api private

new(command_name, database_name, address, request_id, operation_id, command)

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 [ BSON::Document ] command The command arguments.

@since 2.1.0 @api private

Public Instance methods

inspect()

Returns a concise yet useful summary of the event.

@return [ String ] String summary of the event.

@since 2.6.0

[Validate]