class Mongo::Monitoring::Event::CommandStarted
Event
that is fired when a command operation starts.
@since 2.1.0
Attributes
@return [ Server::Address ] address The server address.
@return [ BSON::Document ] command The command arguments.
@return [ String ] command_name
The name of the command.
@return [ Integer ] The ID for the connection over which the command
is sent.
@api private
@return [ String ] database_name
The name of the database_name.
@return [ Integer ] operation_id
The operation id.
@return [ Integer ] request_id
The request id.
object_id of the socket object used for this command.
@api private
Public Class Methods
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
# File lib/mongo/monitoring/event/command_started.rb, line 93 def self.generate(address, operation_id, payload, socket_object_id: nil, connection_id: nil ) new( payload[:command_name], payload[:database_name], address, payload[:request_id], operation_id, payload[:command], socket_object_id: socket_object_id, connection_id: connection_id, ) end
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
# File lib/mongo/monitoring/event/command_started.rb, line 67 def initialize(command_name, database_name, address, request_id, operation_id, command, socket_object_id: nil, connection_id: nil ) @command_name = command_name.to_s @database_name = database_name @address = address @request_id = request_id @operation_id = operation_id @command = redacted(command_name, command) @socket_object_id = socket_object_id @connection_id = connection_id end
Public Instance Methods
Returns a concise yet useful summary of the event.
@return [ String ] String summary of the event.
@since 2.6.0
# File lib/mongo/monitoring/event/command_started.rb, line 113 def inspect "#<{#{self.class} #{database_name}.#{command_name} command=#{command}>" end