Clase: Mongo::supervisión::evento::CommandSucceeded

Hereda:

evento::Base

Objeto
evento::Base
Mongo::supervisión::evento::CommandSucceeded

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 de 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.
#database_name ⇒ string 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 ID de la solicitud.
#server_connection_id ⇒ Integer Solo lectura
Server_connection_id El ID de conexión del servidor.
#service_id ⇒ nil | Object Solo lectura
El id. del servicio, si lo hay.
#started_evento ⇒ Supervisión::Evento::CommandStarted 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

#initialize(command_name, database_name, address, request_id, operation_id, reply, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandSucceeded constructor privado
Crea el nuevo evento.
#summary ⇒ String
Devuelve un resumen conciso pero útil del evento.

Métodos incluidos de Seguro

#compression_allowed?, #redacted, #sensitive?

Detalles del Constructor

#initialize(command_name, database_name, address, request_id, operation_id, reply, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandSucceeded`

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Crea el nuevo evento.

Ejemplos:

Crear el evento.

Parámetros:

command_name (string) —
El nombre del comando.
database_name (string) —
El nombre de la base de datos.
dirección (servidor::Address) —
La dirección del servidor.
request_id (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 (Monitoring::Event::CommandStarted) —
El evento iniciado correspondiente.
service_id (objeto) (valor por defecto: nil) —
El id. del servicio, si lo hay.

Desde:

2.1.0

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

def inicializar(command_name, database_name, dirección, request_id,
               operation_id, respuesta, duration, started_event:,
               server_connection_id: nulo, service_id: nulo)
  super()
  @command_name = command_name.to_s
  @database_name = database_name
  @address = dirección
  @request_id = request_id
  @operation_id = operation_id
  @service_id = service_id
  @started_event = evento_inicio
  @respondido = redactado(command_name, respuesta)
  @duration = duration
  @server_connection_id = server_connection_id
end

Detalles de atributo de instancias

#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



27
28
29

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

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



30
31
32

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

def command_name
  @command_name
end

#database_name ⇒ `String` (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



36
37
38

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

def database_name
  @database_name
end

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

Retorna duración La duración del evento.

Devuelve:

(Float) —
duration La duración del evento.

Desde:

2.1.0



39
40
41

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

def duration
  @duration
end

#operation_id ⇒ `Integer` (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



42
43
44

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

def operation_id
  @operation_id
end

#respuesta ⇒ `BSON::Document` (solo lectura)

Devuelve respuesta La respuesta del comando.

Devuelve:

(BSON::Document) —
reply El comando reply.

Desde:

2.1.0



33
34
35

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

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



45
46
47

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

def request_id
  @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



48
49
50

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

def server_connection_id
  @server_connection_id
end

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

Retorna El ID del servicio, si existe.

Devuelve:

(nil | Object) —
El id. del servicio, si lo hay.

Desde:

2.1.0



51
52
53

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

def service_id
  @service_id
end

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

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Retorna started_event El evento iniciado correspondiente.

Devuelve:

(Monitoring::Event::CommandStarted) —
started_event El evento iniciado correspondiente.

Desde:

2.1.0



57
58
59

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

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 es parte de una API privada. Se debe evitar el uso de este método 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 (Monitoring::Event::CommandStarted) —
El evento iniciado correspondiente.
service_id (objeto) (valor por defecto: nil) —
El id. del servicio, si lo hay.

Devuelve:

(CommandCompleted) —
El evento.

Desde:

2.1.0

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

def sí mismo.generate(dirección, operation_id, command_payload,
                  reply_payload, duration, started_event:, 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,
    started_event: evento_inicio,
    server_connection_id: server_connection_id,
    service_id: service_id
  )
end

.generate_reply(command_payload, reply_payload) ⇒ `Object`

Desde:

2.1.0

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

def sí mismo.generar_respuesta(command_payload, reply_payload)
  si reply_payload
    respuesta = reply_payload[Respuesta]
    si (cursor = respuesta[:cursor]) && !cursor.key?(Colección::NS)
      cursor.¡Actualizar!(Colección::NS => namespace(command_payload))
    end
    respuesta
  else
    BSON::Documento.Nuevo(Operación::Resultado::OK => 1)
  end
end

.namespace(payload) ⇒ `objeto`

Desde:

2.1.0

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

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) —
String summary of the evento.

Desde:

2.1.0



99
100
101

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

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

Clase: Mongo::supervisión::evento::CommandSucceeded

Overview

Resumen constante

Constantes incluidas de 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

#initialize(command_name, database_name, address, request_id, operation_id, reply, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandSucceeded

Ejemplos:

Crear el evento.

Detalles de atributo de instancias

#address ⇒ Server::Address (solo lectura)

#command_name ⇒ String (solo lectura)

#database_name ⇒ String (solo lectura)

#duración ⇒ Flotante (solo lectura)

#operation_id ⇒ Integer (solo lectura)

#respuesta ⇒ BSON::Document (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.

.generate_reply(command_payload, reply_payload) ⇒ Object

.namespace(payload) ⇒ objeto

Detalles del método de instancia

#summary → String

#initialize(command_name, database_name, address, request_id, operation_id, reply, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandSucceeded`

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

#command_name ⇒ `String` (solo lectura)

#database_name ⇒ `String` (solo lectura)

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

#operation_id ⇒ `Integer` (solo lectura)

#respuesta ⇒ `BSON::Document` (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`

.generate_reply(command_payload, reply_payload) ⇒ `Object`

.namespace(payload) ⇒ `objeto`

#summary → `String`