Clase: Mongo::supervisión::evento::CommandStarted

Hereda:
evento::Base
  • Objeto
Mostrar todo
Incluye:
Seguro
Definido en:
lib/mongo/supervisión/evento/command_started.rb

Overview

Evento que se activa cuando se inicia una operación de comando.

Desde:

  • 2.1.0

Resumen constante

Constantes incluidas desde Secure

Secure::REDACTED_COMMANDS

Resumen de atributos de la instancia colapsar

Resumen del método de clase colapsar

Resumen del método de instancia colapsar

Métodos incluidos de Seguro

#compression_allowed?, #redacted, #sensitive?

Detalles del constructor

#inicializar(nombre_comando, nombre_base_datos, dirección, id_solicitud, id_operación, comando, id_objeto_socket: nil, id_conexión: nil, generación_conexión: nil, id_conexión_servidor: nil, id_servicio: nil) ⇒ ComandoIniciado

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Crea el nuevo evento.

Ejemplos:

Crear el evento.

Parámetros:

  • nombre_del_comando (string) —

    El nombre del comando.

  • nombre_de_la_base_de_datos (string) —

    El nombre database_name.

  • dirección (servidor::Address) —

    La dirección del servidor.

  • id de solicitud (Número entero) —

    El id de la solicitud.

  • operation_id (Número entero) —

    La id. de la operación.

  • Comando (BSON::Document) —

    Los argumentos del comando.

  • service_id (Objeto) (predeterminado: nulo) —

    El identificador del servicio, si lo hay.

Desde:

  • 2.1.0



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 85

def inicializar(nombre_del_comando, nombre_de_la_base_de_datos, dirección, id de solicitud,
  operation_id, Comando, socket_object_id: nulo, connection_id: nulo,
  generación_conexión: nulo, server_connection_id: nulo,
  service_id: nulo
)
  @command_name = nombre_del_comando.to_s
  @database_name = nombre_de_la_base_de_datos
  @address = dirección
  @request_id = id de solicitud
  @operation_id = operation_id
  @service_id = service_id
  @sensible = ¿sensible?(
    command_name: @command_name,
    documento: Comando
  )
  @command = redactado(nombre_del_comando, Comando)
  @socket_object_id = socket_object_id
  @id_de_conexión = connection_id
  @connection_generation = connection_generation
  @server_connection_id = server_connection_id
end

Detalles de los atributos de instancia

#address ⇒ Server::Address (solo lectura)

Regresa la dirección La dirección del servidor.

Devuelve:

  • (servidor::Address) —

    dirección La dirección del servidor.

Desde:

  • 2.1.0



29
30
31
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 29

def dirección
  @address
end

#comando ⇒ BSON::Documento (solo lectura)

Devuelve comando Los argumentos del comando.

Devuelve:

  • (BSON::Document) —

    comando Los argumentos del comando.

Desde:

  • 2.1.0



32
33
34
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 32

def Comando
  @command
end

#command_name ⇒ String (solo lectura)

Devuelve command_name El nombre del comando.

Devuelve:

  • (string) —

    command_name El nombre del comando.

Desde:

  • 2.1.0



35
36
37
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 35

def nombre_del_comando
  @command_name
end

#connection_generation ⇒ Objeto (solo lectura)

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Desde:

  • 2.1.0



55
56
57
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 55

def connection_generation
  @connection_generation
end

#connection_id ⇒ Entero (solo lectura)

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

El ID para la conexión por la que se envía el comando.

Devuelve:

  • (Número entero) —

    El ID de la conexión por la que se envía el comando.

Desde:

  • 2.1.0



61
62
63
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 61

def connection_id
  @id_de_conexión
end

#nombre_de_base_de_datos ⇒ Cadena (solo lectura)

Devuelve database_name El nombre de database_name.

Devuelve:

  • (string) —

    database_name El nombre de la base de datos_nombre.

Desde:

  • 2.1.0



38
39
40
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 38

def nombre_de_la_base_de_datos
  @database_name
end

#operation_id ⇒ Entero (solo lectura)

Devuelve operation_id El ID de la operación.

Devuelve:

  • (Número entero) —

    operation_id El id. de operación.

Desde:

  • 2.1.0



41
42
43
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 41

def operation_id
  @operation_id
end

#request_id ⇒ Entero (solo lectura)

Devuelve request_id La solicitud id.

Devuelve:

  • (Número entero) —

    request_id El ID de la solicitud.

Desde:

  • 2.1.0



44
45
46
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 44

def id de solicitud
  @request_id
end

#sensible ⇒ verdadero | falso (solo lectura)

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve si el evento contiene información confidencial.

Devuelve:

  • (true | false) —

    Si el evento contiene datos confidenciales.

Desde:

  • 2.1.0



69
70
71
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 69

def sensible
  @sensible
end

#id_conexión_servidor ⇒ Entero (solo lectura)

Devuelve server_connection_id El id de conexión del servidor.

Devuelve:

  • (Número entero) —

    server_connection_id El ID de conexión del servidor.

Desde:

  • 2.1.0



64
65
66
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 64

def server_connection_id
  @server_connection_id
end

#service_id ⇒ nil | Objeto (solo lectura)

Devuelve el ID del servicio, si lo hay.

Devuelve:

  • (nil | Objeto) —

    El identificador del servicio, si lo hay.

Desde:

  • 2.1.0



47
48
49
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 47

def service_id
  @service_id
end

#socket_object_id ⇒ Object (solo lectura)

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

object_id del objeto de socket utilizado para este comando.

Desde:

  • 2.1.0



52
53
54
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 52

def socket_object_id
  @socket_object_id
end

Detalles del método de clase

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

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Crear el evento a partir de una carga útil de mensaje de protocolo de conexión.

Ejemplos:

Crear el evento.

CommandStarted.generate(address, 1, payload)

Parámetros:

  • dirección (servidor::Address) —

    La dirección del servidor.

  • operation_id (Número entero) —

    La id. de la operación.

  • payload (encriptada) —

    La carga útil del mensaje.

  • service_id (Objeto) (predeterminado: nulo) —

    El identificador del servicio, si lo hay.

Devuelve:

  • (Comandoiniciado) —

    El evento.

Desde:

  • 2.1.0



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 150

def sí mismo.generate(dirección, operation_id, payload,
  socket_object_id: nulo, connection_id: nulo, generación_conexión: nulo,
  server_connection_id: nulo, service_id: nulo
)
  Nuevo(
    payload[nombre_de_comando],
    payload[:nombre_base_de_datos],
    dirección,
    payload[id de solicitud],
    operation_id,
    # Todos los payloads de op_msg tienen un campo $db. Las cargas útiles heredadas no
    # tiene un campo $db. Para emular op_msg al publicar un comando
    #Cree eventos de supervisión para servidores heredados, añada $db a la carga útil.
    # copiando el nombre de la base de datos. Tenga en cuenta que el nombre de la base de datos también es
    # disponible como un atributo de nivel superior en el evento de inicio del comando.
    payload[Comando].fusionar('$db' => payload[:nombre_base_de_datos]),
    socket_object_id: socket_object_id,
    connection_id: connection_id,
    generación_conexión: connection_generation,
    server_connection_id: server_connection_id,
    service_id: service_id,
  )
end

Detalles del método de instancia

#inspect ⇒ String

Devuelve un resumen conciso pero útil del evento.

Devuelve:

  • (string) —

    Resumen de cadena del evento.

Desde:

  • 2.6.0



179
180
181
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 179

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

#summary → String

Nota:

Este método es experimental y está sujeto a cambios.

Devuelve un resumen conciso pero útil del evento.

Devuelve:

  • (string) —

    Resumen de cadena del evento.

Desde:

  • 2.1.0



114
115
116
 
# Archivo 'lib/mongo/supervisión/evento/command_started.rb', línea 114

def Resumen
  "#<#{short_class_name} dirección=#{address} #{database_name}.#{command_name} comando=#{command_summary}>"
end