Class: Mongo::Monitoring::Event::CommandStarted

Inherits:
Event::Base
  • Object
show all
Includes:
Secure
Defined in:
lib/mongo/monitoring/event/command_started.rb

Overview

Event that is fired when a command operation starts.

Since:

  • 2.1.0

Constant Summary

Constants included from Secure

Secure::REDACTED_COMMANDS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Secure

#compression_allowed?, #redacted

Constructor Details

#initialize(command_name, database_name, address, request_id, operation_id, command, socket_object_id: nil, connection_id: nil, connection_generation: nil, server_connection_id: nil) ⇒ CommandStarted

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create the new event.

Examples:

Create the event.

Parameters:

  • command_name (String) —

    The name of the command.

  • database_name (String) —

    The database_name name.

  • address (Server::Address) —

    The server address.

  • request_id (Integer) —

    The request id.

  • operation_id (Integer) —

    The operation id.

  • command (BSON::Document) —

    The command arguments.

Since:

  • 2.1.0



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 73

def initialize(command_name, database_name, address, request_id,
  operation_id, command, socket_object_id: nil, connection_id: nil,
  connection_generation: nil, server_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
  @connection_generation = connection_generation
  @server_connection_id = server_connection_id
end

Instance Attribute Details

#address ⇒ Server::Address (readonly)

Returns address The server address.

Returns:

  • (Server::Address) —

    address The server address.

Since:

  • 2.1.0



26
27
28
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 26

def address
  @address
end

#command ⇒ BSON::Document (readonly)

Returns command The command arguments.

Returns:

  • (BSON::Document) —

    command The command arguments.

Since:

  • 2.1.0



29
30
31
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 29

def command
  @command
end

#command_name ⇒ String (readonly)

Returns command_name The name of the command.

Returns:

  • (String) —

    command_name The name of the command.

Since:

  • 2.1.0



32
33
34
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 32

def command_name
  @command_name
end

#connection_generation ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 2.1.0



49
50
51
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 49

def connection_generation
  @connection_generation
end

#connection_id ⇒ Integer (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns The ID for the connection over which the command is sent.

Returns:

  • (Integer) —

    The ID for the connection over which the command is sent.

Since:

  • 2.1.0



55
56
57
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 55

def connection_id
  @connection_id
end

#database_name ⇒ String (readonly)

Returns database_name The name of the database_name.

Returns:

  • (String) —

    database_name The name of the database_name.

Since:

  • 2.1.0



35
36
37
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 35

def database_name
  @database_name
end

#operation_id ⇒ Integer (readonly)

Returns operation_id The operation id.

Returns:

  • (Integer) —

    operation_id The operation id.

Since:

  • 2.1.0



38
39
40
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 38

def operation_id
  @operation_id
end

#request_id ⇒ Integer (readonly)

Returns request_id The request id.

Returns:

  • (Integer) —

    request_id The request id.

Since:

  • 2.1.0



41
42
43
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 41

def request_id
  @request_id
end

#server_connection_id ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 2.1.0



58
59
60
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 58

def server_connection_id
  @server_connection_id
end

#socket_object_id ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

object_id of the socket object used for this command.

Since:

  • 2.1.0



46
47
48
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 46

def socket_object_id
  @socket_object_id
end

Class Method Details

.generate(address, operation_id, payload, socket_object_id: nil, connection_id: nil, connection_generation: nil, server_connection_id: nil) ⇒ CommandStarted

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create the event from a wire protocol message payload.

Examples:

Create the event.

CommandStarted.generate(address, 1, payload)

Parameters:

  • address (Server::Address) —

    The server address.

  • operation_id (Integer) —

    The operation id.

  • payload (Hash) —

    The message payload.

Returns:

Since:

  • 2.1.0



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 131

def self.generate(address, operation_id, payload,
  socket_object_id: nil, connection_id: nil, connection_generation: nil,
  server_connection_id: nil
)
  new(
    payload[:command_name],
    payload[:database_name],
    address,
    payload[:request_id],
    operation_id,
    # All op_msg  payloads have a $db field. Legacy payloads do not
    # have a $db field. To emulate op_msg when publishing command
    # monitoring events for legacy servers, add $db to the payload,
    # copying the database name. Note that the database name is also
    # available as a top-level attribute on the command started event.
    payload[:command].merge('$db' => payload[:database_name]),
    socket_object_id: socket_object_id,
    connection_id: connection_id,
    connection_generation: connection_generation,
    server_connection_id: server_connection_id,
  )
end

Instance Method Details

#inspect ⇒ String

Returns a concise yet useful summary of the event.

Returns:

  • (String) —

    String summary of the event.

Since:

  • 2.6.0



159
160
161
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 159

def inspect
  "#<{#{self.class} #{database_name}.#{command_name} command=#{command}>"
end

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.

Returns:

  • (String) —

    String summary of the event.

Since:

  • 2.1.0



96
97
98
 
# File 'lib/mongo/monitoring/event/command_started.rb', line 96

def summary
  "#<#{short_class_name} address=#{address} #{database_name}.#{command_name} command=#{command_summary}>"
end