Clase: Mongo::Monitoring::Event::CommandFailed

Hereda:

evento::Base

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

Mostrar todo

Incluye:: Seguro

Definido en:: lib/mongo/supervisión/evento/command_failed.rb

Overview

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

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 database_name.
#duración ⇒ Flotante Solo lectura
Duración La duración del comando en segundos.
#failure ⇒ BSON::Document Solo lectura
Fallo. El documento de error, en caso de existir.
#message ⇒ String Solo lectura
Mensaje El mensaje de error.
#operation_id ⇒ Integer Solo lectura
Operation_id El id de la operación.
#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

generate(dirección, id_operación, carga, mensaje, fallo, duración, evento_iniciado:, id_conexión_servidor: nil, id_servicio: nil) ⇒ CommandFailed privado
Crear el evento a partir de una carga útil de mensaje de protocolo de conexión.

Resumen del método de instancia colapsar

#initialize(command_name, database_name, address, request_id, operation_id, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed 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, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandFailed`

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 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.
mensaje (string) —
El mensaje de error.
fallo (BSON::Document) —
El documento de error, si lo hay.
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_failed.rb', línea 83

def inicializar(command_name, database_name, dirección,
               request_id, operation_id, mensaje, fallo, duration,
               started_event:, server_connection_id: nulo, service_id: nulo)
  @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
  @message = mensaje
  @started_event = evento_inicio
  @failure = redactado(command_name, fallo)
  @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_failed.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_failed.rb', línea 30

def command_name
  @command_name
end

#database_name ⇒ `String` (solo lectura)

Devuelve database_name El nombre de database_name.

Devuelve:

(string) —
database_name El nombre del database_name.

Desde:

2.1.0



33
34
35

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

def database_name
  @database_name
end

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

Devuelve la duración, que es el tiempo que tarda el comando en completarse (en segundos).

Devuelve:

(Float) —
duración La duración del comando en segundos.

Desde:

2.1.0



36
37
38

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

def duration
  @duration
end

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

Devuelve fallo El documento de error, si existe. Esto solo se completará para los errores comunicados por un servidor de MongoDB. En otras situaciones, por ejemplo en caso de un error de red, este atributo puede ser nulo.

Devuelve:

(BSON::Document) —
falla El documento de error, si está presente. Esto solo se completará para errores comunicados por un servidor de MongoDB. En otras situaciones, por ejemplo, en caso de un error de red, este atributo puede ser nulo.

Desde:

2.1.0



42
43
44

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

def fallo
  @failure
end

#mensaje ⇒ `string` (solo lectura)

Retorna el mensaje El mensaje de error. A diferencia del documento de error, el mensaje de error siempre debe estar presente.

Devuelve:

(string) —
message El mensaje de error. A diferencia del documento de error, el mensaje de error siempre debe estar presente.

Desde:

2.1.0



46
47
48

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

def mensaje
  @message
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



49
50
51

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

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



52
53
54

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

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



55
56
57

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

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



58
59
60

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

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



64
65
66

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

def evento_inicio
  @started_event
end

Detalles del método de clase

.generate(address, operation_id, payload, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandFailed`

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.

CommandFailed.generate(address, 1, payload, duration)

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.
mensaje (string) —
El mensaje de error.
fallo (BSON::Document) —
El documento de error, si lo hay.
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:

(ComandoFallido) —
El evento.

Desde:

2.1.0

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

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



106
107
108

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

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

Clase: Mongo::Monitoring::Event::CommandFailed

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, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed

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)

#fallo ⇒ BSON::Documento (solo lectura)

#mensaje ⇒ string (solo lectura)

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

.generate(address, operation_id, payload, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed

Ejemplos:

Crear el evento.

Detalles del método de instancia

#summary → String

#initialize(command_name, database_name, address, request_id, operation_id, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandFailed`

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

#command_name ⇒ `String` (solo lectura)

#database_name ⇒ `String` (solo lectura)

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

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

#mensaje ⇒ `string` (solo lectura)

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

.generate(address, operation_id, payload, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandFailed`

#summary → `String`