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 falla una operación de comando.

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 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 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, id_de_operación, carga útil, mensaje, falla, duración, evento_iniciado:, id_de_conexión_del_servidor: nulo, id_de_servicio: nulo) ⇒ ComandoFailed privado

Crear el evento a partir de una carga útil de mensaje de protocolo de conexión.

Resumen del método de instancia colapsar

#inicializar(nombre_comando, nombre_base_datos, dirección, id_solicitud, id_operación, mensaje, falla, duración, evento_iniciado:, id_conexión_servidor: nil, id_servicio: nil) ⇒ ComandoFailed 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

#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 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 database_name.
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.
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 (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/monitoring/event/command_failed.rb', línea 85

def inicializar(nombre_del_comando, nombre_de_la_base_de_datos, dirección,
  id de solicitud, operation_id, mensaje, fallo, 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
  @mensaje = mensaje
  @started_event = evento_inicio
  @failure = redactado(nombre_del_comando, fallo)
  @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/monitoring/event/command_failed.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/monitoring/event/command_failed.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 database_name.

Devuelve:

(string) —

database_name El nombre de la base de datos_nombre.

Desde:

2.1.0



35
36
37

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 35

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



38
39
40

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 38

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



44
45
46

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 44

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



48
49
50

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 48

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



51
52
53

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 51

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



54
55
56

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 54

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



57
58
59

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 57

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



60
61
62

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 60

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



66
67
68

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 66

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

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 (Monitoreo::Evento::ComandoIniciado) —

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

El identificador del servicio, si lo hay.

Devuelve:

(Comandofallido) —

El evento.

Desde:

2.1.0

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 132

def sí mismo.generate(dirección, operation_id, payload, mensaje,
  fallo, duration, evento iniciado:, 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,
    evento iniciado: 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) —

Resumen de cadena del evento.

Desde:

2.1.0



109
110
111

# Archivo 'lib/mongo/monitoring/event/command_failed.rb', línea 109

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

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

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

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

#fallo ⇒ BSON::Documento (solo lectura)

#mensaje ⇒ string (solo lectura)

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

#nombre_de_base_de_datos ⇒ `Cadena` (solo lectura)

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

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

#mensaje ⇒ `string` (solo lectura)

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