Clase: Mongo::Monitoring::Event::CommandStarted

Hereda:
Evento::Base
  • Objeto
Mostrar todo
Incluye:
Seguro
Definido en:
lib/mongo/monitoring/event/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

Colapso delresumen de atributos de instancia

Colapso delresumen del método de clase

Colapso del resumen del método de instancia

Métodos incluidos de Secure

#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 (Cadena) -

    El nombre del comando.

  • nombre_de_la_base_de_datos (Cadena) -

    El nombre database_name.

  • dirección (servidor::Address) —

    La dirección del servidor.

  • id de solicitud (Entero) —

    El id de la solicitud.

  • operation_id (Entero) —

    El id de la operación.

  • Comando (BSON::Documento) —

    Los argumentos del comando.

  • id_de_servicio (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/monitoring/event/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, id_de_conexión: nulo,
  generación_de_conexión: nulo, id_de_conexión_del_servidor: nulo,
  id_de_servicio: nulo
)
  @nombre_del_comando = nombre_del_comando.a_s
  @database_name = nombre_de_la_base_de_datos
  @DIRECCIÓN = dirección
  @request_id = id de solicitud
  @id_de_operación = operation_id
  @service_id = id_de_servicio
  @sensible = ¿sensible?(
    nombre_del_comando: @nombre_del_comando,
    documento: Comando
  )
  @dominio = redactado(nombre_del_comando, Comando)
  @id_del_objeto_de_socket = id_del_objeto_del_zócalo
  @id_de_conexión = id_de_conexión
  @connection_generation = generación de conexión
  @id_de_conexión_del_servidor = id_de_conexión_del_servidor
end

Detalles de los atributos de instancia

#dirección ⇒ Servidor::Dirección (solo lectura)

Dirección de retorno 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/monitoring/event/command_started.rb', línea 29

def dirección
  @DIRECCIÓN
end

#comando ⇒ BSON::Documento (solo lectura)

Devuelve el comando Los argumentos del comando.

Devuelve:

  • (BSON::Documento) —

    comando Los argumentos del comando.

Desde:

  • 2.1.0



32
33
34
 
# Archivo 'lib/mongo/monitoring/event/command_started.rb', línea 32

def Comando
  @dominio
end

#command_name ⇒ Cadena (solo lectura)

Devuelve command_name El nombre del comando.

Devuelve:

  • (Cadena) -

    command_name El nombre del comando.

Desde:

  • 2.1.0



35
36
37
 
# Archivo 'lib/mongo/monitoring/event/command_started.rb', línea 35

def nombre_del_comando
  @nombre_del_comando
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/monitoring/event/command_started.rb', línea 55

def generación de conexión
  @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.

Devuelve el ID de la conexión a través de la cual se envía el comando.

Devuelve:

  • (Entero) —

    El ID de la conexión a través de la cual se envía el comando.

Desde:

  • 2.1.0



61
62
63
 
# Archivo 'lib/mongo/monitoring/event/command_started.rb', línea 61

def id_de_conexión
  @id_de_conexión
end

#nombre_de_base_de_datos ⇒ Cadena (solo lectura)

Devuelve database_name El nombre de database_name.

Devuelve:

  • (Cadena) -

    database_name El nombre de la base de datos_nombre.

Desde:

  • 2.1.0



38
39
40
 
# Archivo 'lib/mongo/monitoring/event/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:

  • (Entero) —

    operation_id El id. de operación.

Desde:

  • 2.1.0



41
42
43
 
# Archivo 'lib/mongo/monitoring/event/command_started.rb', línea 41

def operation_id
  @id_de_operación
end

#request_id ⇒ Entero (solo lectura)

Devuelve request_id El ID de la solicitud.

Devuelve:

  • (Entero) —

    request_id El identificador de la solicitud.

Desde:

  • 2.1.0



44
45
46
 
# Archivo 'lib/mongo/monitoring/event/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 datos confidenciales.

Devuelve:

  • (verdadero | falso) —

    Si el evento contiene datos confidenciales.

Desde:

  • 2.1.0



69
70
71
 
# Archivo 'lib/mongo/monitoring/event/command_started.rb', línea 69

def sensible
  @sensible
end

#server_connection_id ⇒ Entero (solo lectura)

Devuelve server_connection_id El identificador de conexión del servidor.

Devuelve:

  • (Entero) —

    server_connection_id El identificador de conexión del servidor.

Desde:

  • 2.1.0



64
65
66
 
# Archivo 'lib/mongo/monitoring/event/command_started.rb', línea 64

def id_de_conexión_del_servidor
  @id_de_conexión_del_servidor
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/monitoring/event/command_started.rb', línea 47

def id_de_servicio
  @service_id
end

#socket_object_id ⇒ 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.

object_id del objeto de socket utilizado para este comando.

Desde:

  • 2.1.0



52
53
54
 
# Archivo 'lib/mongo/monitoring/event/command_started.rb', línea 52

def id_del_objeto_del_zócalo
  @id_del_objeto_de_socket
end

Detalles del método de clase

.generar(dirección, id_de_operación, carga útil, id_de_objeto_de_socket: nulo, id_de_conexión: nulo, id_de_conexión_del_servidor: nulo, id_de_servicio: nulo) ⇒ Comando Iniciado

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 (Entero) —

    El id de la operación.

  • carga útil (Hash) —

    La carga útil del mensaje.

  • id_de_servicio (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/monitoring/event/command_started.rb', línea 150

def yo.generate(dirección, operation_id, carga útil,
  socket_object_id: nulo, id_de_conexión: nulo, generación_de_conexión: nulo,
  id_de_conexión_del_servidor: nulo, id_de_servicio: nulo
)
  Nuevo(
    carga útil[:nombre_del_comando],
    carga útil[:nombre_de_la_base_de_datos],
    dirección,
    carga útil[:id_de_solicitud],
    operation_id,
    # Todas las cargas útiles de op_msg tienen un campo $db. Las cargas útiles heredadas no lo tienen.
    # tener 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.
    carga útil[:dominio].unir('$db' => carga útil[:nombre_de_la_base_de_datos]),
    socket_object_id: id_del_objeto_del_zócalo,
    id_de_conexión: id_de_conexión,
    generación_de_conexión: generación de conexión,
    id_de_conexión_del_servidor: id_de_conexión_del_servidor,
    id_de_servicio: id_de_servicio,
  )
end

Detalles del método de instancia

#inspeccionar ⇒ Cadena

Devuelve un resumen conciso pero útil del evento.

Devuelve:

  • (Cadena) -

    Resumen de cadena del evento.

Desde:

  • 2.6.0



179
180
181
 
# Archivo 'lib/mongo/monitoring/event/command_started.rb', línea 179

def inspeccionar
  "#<{#{self.class} #{nombre_de_base_de_datos }.#{nombre_de_comando} comando=#{comando}>"
end

#resumen ⇒ Cadena

Nota:

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

Devuelve un resumen conciso pero útil del evento.

Devuelve:

  • (Cadena) -

    Resumen de cadena del evento.

Desde:

  • 2.1.0



114
115
116
 
# Archivo 'lib/mongo/monitoring/event/command_started.rb', línea 114

def resumen
  "#<#{nombre_de_clase_corto} dirección=#{dirección} #{nombre_de_base_de_datos }.#{nombre_de_comando} comando=#{resumen_de_comando}>"
end