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

Hereda:

evento::Base

Objeto
evento::Base
Mongo::Monitoreo::Evento::Comando exitoso

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

Resumen de atributos de la instancia colapsar

#address ⇒ servidor::Address Solo lectura

Dirección. La dirección del servidor.
#nombre_comando ⇒ String Solo lectura

Command_name El nombre del comando.
#nombre_de_base_de_datos ⇒ Cadena Solo lectura

database_name El nombre de la base de datos.
#duración ⇒ Flotante Solo lectura

Duración La duración del evento.
#operation_id ⇒ Integer Solo lectura

Operation_id El id de la operación.
#responder ⇒ BSON::Document Solo lectura

Respuesta El comando de respuesta.
#request_id ⇒ Integer Solo lectura

Request_id El identificador de la solicitud.
#server_connection_id ⇒ Integer Solo lectura

Server_connection_id El ID de conexión del servidor.
#service_id ⇒ nulo | Objeto Solo lectura

El identificador del servicio, si lo hay.
#evento_iniciado ⇒ Monitoreo::Evento::ComandoIniciado Solo lectura privado

Evento_started El evento correspondiente iniciado.

Resumen del método de clase colapsar

.generar(dirección, operation_id, command_payload, reply_payload, duración, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandCompleted privado

Crear el evento a partir de una carga útil de mensaje de protocolo de conexión.
.generate_reply(command_payload, reply_payload) ⇒ Objeto
.namespace(payload) ⇒ objeto

Resumen del método de instancia colapsar

#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 constructor privado

Crea el nuevo evento.
#resumen ⇒ Cadena

Devuelve un resumen conciso pero útil del evento.

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, 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 (string) —

El nombre del comando.
nombre_de_la_base_de_datos (string) —

El nombre de la base de datos.
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.
respuesta (BSON::Document) —

La respuesta al comando.
duration (Float) —

La duración que tomó el comando en segundos.
evento_inicio (Monitoreo::Evento::ComandoIniciado) —

El evento iniciado correspondiente.
service_id (Objeto) (predeterminado: nulo) —

El identificador del servicio, si lo hay.

Desde:

2.1.0

# 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, duration, evento iniciado:,
  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
  @started_event = evento_inicio
  @respondido = redactado(nombre_del_comando, respuesta)
  @duration = duration
  @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_succeeded.rb', línea 29

def dirección
  @address
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



32
33
34

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

def nombre_del_comando
  @command_name
end

#nombre_de_base_de_datos ⇒ `Cadena` (solo lectura)

Devuelve database_name El nombre de la base de datos.

Devuelve:

(string) —

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ón ⇒ `Flotante` (solo lectura)

Devuelve duración La duración del evento.

Devuelve:

(Float) —

duration 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 duration
  @duration
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



44
45
46

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

def operation_id
  @operation_id
end

#responder ⇒ `BSON::Documento` (solo lectura)

Devuelve respuesta La respuesta del comando.

Devuelve:

(BSON::Document) —

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_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



47
48
49

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

def id de solicitud
  @request_id
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



50
51
52

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

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



53
54
55

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

def service_id
  @service_id
end

#started_event ⇒ `Supervisión::Evento::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_inicio
  @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 (Número entero) —

La id. de la operación.
command_payload (encriptada) —

La carga útil del mensaje de comando.
reply_payload (encriptada) —

La carga útil del mensaje de respuesta.
duration (Float) —

La duración de la orden en segundos.
evento_inicio (Monitoreo::Evento::ComandoIniciado) —

El evento iniciado correspondiente.
service_id (Objeto) (predeterminado: nulo) —

El identificador del servicio, si lo hay.

Devuelve:

(CommandCompleted) —

El evento.

Desde:

2.1.0

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

def sí mismo.generate(dirección, operation_id, command_payload,
  reply_payload, duration, evento iniciado:, server_connection_id: nulo,
  service_id: nulo
)
  Nuevo(
    command_payload[nombre_de_comando],
    command_payload[:nombre_base_de_datos],
    dirección,
    command_payload[id de solicitud],
    operation_id,
    generar_respuesta(command_payload, reply_payload),
    duration,
    evento iniciado: evento_inicio,
    server_connection_id: server_connection_id,
    service_id: service_id,
  )
end

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

Desde:

2.1.0

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

def sí mismo.generar_respuesta(command_payload, reply_payload)
  si reply_payload
    respuesta = reply_payload[Respuesta]
    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

.namespace(payload) ⇒ `objeto`

Desde:

2.1.0

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

def sí mismo.namespace(payload)
  Comando = payload[Comando]
  "#{payload[:database_name]}.#{command[:collection] || command.values.first}"
end

Detalles del método de instancia

#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



101
102
103

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

def Resumen
  ”#<#{short_class_name} address=#{address} #{database_name}.#{command_name}>”
end

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

Overview

Resumen constante

Constantes incluidas desde Secure

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

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

Ejemplos:

Crear el evento.

Detalles de los atributos de instancia

#address ⇒ Server::Address (solo lectura)

#command_name ⇒ String (solo lectura)

#nombre_de_base_de_datos ⇒ Cadena (solo lectura)

#duración ⇒ Flotante (solo lectura)

#operation_id ⇒ Entero (solo lectura)

#responder ⇒ BSON::Documento (solo lectura)

#request_id ⇒ Entero (solo lectura)

#id_conexión_servidor ⇒ Entero (solo lectura)

#service_id ⇒ nil | Objeto (solo lectura)

#started_event ⇒ Supervisión::Evento::CommandStarted (solo lectura)

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

Ejemplos:

Crear el evento.

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

.namespace(payload) ⇒ objeto

Detalles del método de instancia

#summary → String

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

#address ⇒ `Server::Address` (solo lectura)

#command_name ⇒ `String` (solo lectura)

#nombre_de_base_de_datos ⇒ `Cadena` (solo lectura)

#duración ⇒ `Flotante` (solo lectura)

#operation_id ⇒ `Entero` (solo lectura)

#responder ⇒ `BSON::Documento` (solo lectura)

#request_id ⇒ `Entero` (solo lectura)

#id_conexión_servidor ⇒ `Entero` (solo lectura)

#service_id ⇒ `nil | Objeto` (solo lectura)

#started_event ⇒ `Supervisión::Evento::CommandStarted` (solo lectura)

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

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

.namespace(payload) ⇒ `objeto`

#summary → `String`