Clase: Mongo::Monitoreo::Evento::Comando exitoso

Hereda:
Evento::Base
  • Objeto
Mostrar todo
Incluye:
Seguro
Definido en:
lib/mongo/monitoring/event/command_succeeded.rb

Overview

Evento que se activa cuando una operación de comando tiene éxito.

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, respuesta, duración, evento_iniciado:, id_conexión_servidor: nulo, id_servicio: nulo) ⇒ Comando exitoso

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 de la base de datos.

  • 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.

  • respuesta (BSON::Documento)

    La respuesta del comando.

  • duración (Flotar) -

    La duración que tomó el comando en segundos.

  • evento iniciado (Monitoreo::Evento::ComandoIniciado)

    El evento iniciado correspondiente.

  • id_de_servicio (Objeto) (predeterminado: nulo)

    El identificador del servicio, si lo hay.

Desde:

  • 2.1.0



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# Archivo 'lib/mongo/supervisión/evento/command_succeeded.rb', línea 78

def inicializar(nombre_del_comando, nombre_de_la_base_de_datos, dirección, id de solicitud,
  operation_id, respuesta, duración, evento iniciado:,
  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
  @started_event = evento iniciado
  @respondido = redactado(nombre_del_comando, respuesta)
  @duración = duración
  @id_de_conexión_del_servidor = id_de_conexión_del_servidor
end

Detalles de los atributos de instancia

#direcciónServidor::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/supervisión/evento/command_succeeded.rb', línea 29

def dirección
  @DIRECCIÓN
end

#command_nameCadena (solo lectura)

Devuelve command_name El nombre del comando.

Devuelve:

  • (Cadena) -

    command_name El nombre del comando.

Desde:

  • 2.1.0



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

def nombre_del_comando
  @nombre_del_comando
end

#nombre_de_base_de_datosCadena (solo lectura)

Devuelve database_name El nombre de la base de datos.

Devuelve:

  • (Cadena) -

    database_name El nombre de la base de datos.

Desde:

  • 2.1.0



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

def nombre_de_la_base_de_datos
  @database_name
end

#duraciónFlotante (solo lectura)

Devuelve duración La duración del evento.

Devuelve:

  • (Flotar) -

    duración La duración del evento.

Desde:

  • 2.1.0



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

def duración
  @duración
end

#operation_idEntero (solo lectura)

Devuelve operation_id El ID de la operación.

Devuelve:

  • (Entero)

    operation_id El id. de operación.

Desde:

  • 2.1.0



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

def operation_id
  @id_de_operación
end

#responderBSON::Documento (solo lectura)

Devuelve respuesta El comando responder.

Devuelve:

  • (BSON::Documento)

    responder El comando responder.

Desde:

  • 2.1.0



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

def respuesta
  @respondido
end

#request_idEntero (solo lectura)

Devuelve request_id El ID de la solicitud.

Devuelve:

  • (Entero)

    request_id El identificador de la solicitud.

Desde:

  • 2.1.0



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

def id de solicitud
  @request_id
end

#server_connection_idEntero (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



50
51
52
# Archivo 'lib/mongo/supervisión/evento/command_succeeded.rb', línea 50

def id_de_conexión_del_servidor
  @id_de_conexión_del_servidor
end

#service_idnil | 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



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

def id_de_servicio
  @service_id
end

#begun_eventMonitoring::Event::CommandStarted (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 begun_event El evento iniciado correspondiente.

Devuelve:

  • (Monitoreo::Evento::ComandoIniciado)

    begun_event El evento iniciado correspondiente.

Desde:

  • 2.1.0



59
60
61
# Archivo 'lib/mongo/supervisión/evento/command_succeeded.rb', línea 59

def evento iniciado
  @started_event
end

Detalles del método de clase

.generar(address, operation_id, command_payload, reply_payload, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandCompleted

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.

CommandSucceeded.generate(address, 1, command_payload, reply_payload, 0.5)

Parámetros:

  • dirección (servidor::Address)

    La dirección del servidor.

  • operation_id (Entero)

    El id de la operación.

  • command_payload (Hash)

    La carga útil del mensaje de comando.

  • carga útil de respuesta (Hash)

    La carga útil del mensaje de respuesta.

  • duración (Flotar) -

    La duración del comando en segundos.

  • evento iniciado (Monitoreo::Evento::ComandoIniciado)

    El evento iniciado correspondiente.

  • id_de_servicio (Objeto) (predeterminado: nulo)

    El identificador del servicio, si lo hay.

Devuelve:

  • (CommandCompleted)

    El evento.

Desde:

  • 2.1.0



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# Archivo 'lib/mongo/supervisión/evento/command_succeeded.rb', línea 123

def yo.generate(dirección, operation_id, command_payload,
  carga útil de respuesta, duración, evento iniciado:, id_de_conexión_del_servidor: nulo,
  id_de_servicio: nulo
)
  Nuevo(
    command_payload[:nombre_del_comando],
    command_payload[:nombre_de_la_base_de_datos],
    dirección,
    command_payload[:id_de_solicitud],
    operation_id,
    generar_respuesta(command_payload, carga útil de respuesta),
    duración,
    evento iniciado: evento iniciado,
    id_de_conexión_del_servidor: id_de_conexión_del_servidor,
    id_de_servicio: id_de_servicio,
  )
end

.generar_respuesta (carga_útil_del_comando, carga_útil_de_la_respuesta)Objeto

Desde:

  • 2.1.0



143
144
145
146
147
148
149
150
151
152
153
154
155
# Archivo 'lib/mongo/supervisión/evento/command_succeeded.rb', línea 143

def yo.generar_respuesta(command_payload, carga útil de respuesta)
  Si carga útil de respuesta
    respuesta = carga útil de respuesta[:responder]
    Si cursor = respuesta[:cursor]
      Si !cursor.key?(Colección::NS)
        cursor.¡unir!(Colección::NS => namespace(command_payload))
      end
    end
    respuesta
  else
    BSON::Documento.Nuevo(Operación::Resultado::Vale => 1)
  end
end

. espacio de nombres(carga útil) ⇒ Objeto

Desde:

  • 2.1.0



157
158
159
160
# Archivo 'lib/mongo/supervisión/evento/command_succeeded.rb', línea 157

def yo.namespace(carga útil)
  Comando = carga útil[:dominio]
  "#{payload[:database_name]}.#{command[:collection] || command.values.first}"
end

Detalles del método de instancia

#resumenCadena

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



101
102
103
# Archivo 'lib/mongo/supervisión/evento/command_succeeded.rb', línea 101

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