Clase: Mongo::supervisión::evento::CommandStarted

Hereda:

evento::Base

Objeto
evento::Base
Mongo::Supervisión::Evento::CommandStarted

Mostrar todo

Incluye:: Seguro

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

Overview

Evento que se desencadena cuando se inicia una operación de comando.

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.
#command ⇒ BSON::Document Solo lectura
Comando Los argumentos del comando.
#nombre_comando ⇒ String Solo lectura
Command_name El nombre del comando.
#connection_generation ⇒ objeto Solo lectura privado
#connection_id ⇒ Integer Solo lectura privado
El ID de la conexión por la que se envía el comando.
#database_name ⇒ string Solo lectura
Database_name El nombre de database_name.
#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.
#sensitive ⇒ verdadero | falso Solo lectura privado
Si el evento contiene datos confidenciales.
#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.
#socket_object_id ⇒ Objeto Solo lectura privado
object_id del objeto de socket utilizado para este comando.

Resumen del método de clase colapsar

.generate(dirección, id_operación, cargar_datos, id_objeto_socket: nil, id_conexión: nil, generación_conexión: nil, id_conexión_servidor: nil, id_servicio: nil) ⇒ ComandoIniciado 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(command_name, database_name, address, request_id, operation_id, command, socket_object_id: nil, connection_id: nil, connection_generation: nil, server_connection_id: nil, service_id: nil) ⇒ CommandStarted constructor privado
Crea el nuevo evento.
#inspect ⇒ string
Devuelve un resumen conciso pero útil del evento.
#summary ⇒ String
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, comando, id_objeto_socket: nil, id_conexión: nil, generación_conexión: nil, id_conexión_servidor: nil, id_servicio: nil) ⇒ `ComandoIniciado`

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.
Comando (BSON::Document) —
Los argumentos del comando.
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_started.rb', línea 83

def inicializar(command_name, database_name, dirección, request_id,
               operation_id, Comando, socket_object_id: nulo, connection_id: nulo,
               generación_conexión: nulo, 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
  @sensitive = ¿sensible?(
    command_name: @command_name,
    documento: Comando
  )
  @command = redactado(command_name, Comando)
  @socket_object_id = socket_object_id
  @connection_id = connection_id
  @generación_de_conexión = connection_generation
  @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_started.rb', línea 27

def dirección
  @address
end

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

Devuelve comando Los argumentos del comando.

Devuelve:

(BSON::Document) —
comando Los argumentos del comando.

Desde:

2.1.0



30
31
32

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

def Comando
  @command
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



33
34
35

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

def command_name
  @command_name
end

#connection_generation ⇒ `Objeto` (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.

Desde:

2.1.0



53
54
55

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

def connection_generation
  @generación_de_conexión
end

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

El ID para la conexión por la que se envía el comando.

Devuelve:

(Número entero) —
El ID de la conexión por la que se envía el comando.

Desde:

2.1.0



59
60
61

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

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



36
37
38

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

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



39
40
41

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

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



42
43
44

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

def request_id
  @request_id
end

#confidencial ⇒ `verdadero | falso` (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.

Devuelve si el evento contiene información confidencial.

Devuelve:

(true | false) —
Si el evento contiene datos confidenciales.

Desde:

2.1.0



67
68
69

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

def sensible
  @sensitive
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



62
63
64

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

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



45
46
47

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

def service_id
  @service_id
end

#socket_object_id ⇒ `Object` (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.

object_id del objeto de socket utilizado para este comando.

Desde:

2.1.0



50
51
52

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

def socket_object_id
  @socket_object_id
end

Detalles del método de clase

.generate(direction, operation_id, payload, socket_object_id: nil, connection_id: nil, connection_generation: nil, server_connection_id: nil, service_id: nil) ⇒ `CommandStarted`

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.

CommandStarted.generate(address, 1, payload)

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.
service_id (objeto) (valor por defecto: nil) —
El id. del servicio, si lo hay.

Devuelve:

(CommandStarted) —
El evento.

Desde:

2.1.0

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

def sí mismo.generate(dirección, operation_id, payload,
                  socket_object_id: nulo, connection_id: nulo, generación_conexión: nulo,
                  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,
    # Todos los payloads de op_msg tienen un campo $db. Las cargas útiles heredadas no
    # tiene un campo $db. Para emular op_msg al publicar un comando
    #Cree eventos de supervisión para servidores heredados, añada $db a la carga útil.
    # copiando el nombre de la base de datos. Tenga en cuenta que el nombre de la base de datos también es
    # disponible como un atributo de nivel superior en el evento de inicio del comando.
    payload[Comando].fusionar('$db' => payload[:nombre_base_de_datos]),
    socket_object_id: socket_object_id,
    connection_id: connection_id,
    generación_conexión: connection_generation,
    server_connection_id: server_connection_id,
    service_id: service_id
  )
end

Detalles del método de instancia

#inspect ⇒ `String`

Devuelve un resumen conciso pero útil del evento.

Devuelve:

(string) —
String summary of the evento.

Desde:

2.6.0



175
176
177

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

def inspeccionar
  "#<{#{self.class} #{database_name}.#{command_name} command=#{command}>"
end

#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



111
112
113

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

def Resumen
  "#<#{short_class_name} dirección=#{address} #{database_name}.#{command_name} comando=#{command_summary}>"
end

Clase: Mongo::supervisión::evento::CommandStarted

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

#inicializar(nombre_comando, nombre_base_datos, dirección, id_solicitud, id_operación, comando, id_objeto_socket: nil, id_conexión: nil, generación_conexión: nil, id_conexión_servidor: nil, id_servicio: nil) ⇒ ComandoIniciado

Ejemplos:

Crear el evento.

Detalles de atributo de instancias

#address ⇒ Server::Address (solo lectura)

#comando ⇒ BSON::Documento (solo lectura)

#command_name ⇒ String (solo lectura)

#connection_generation ⇒ Objeto (solo lectura)

#connection_id ⇒ Entero (solo lectura)

#database_name ⇒ String (solo lectura)

#operation_id ⇒ Integer (solo lectura)

#request_id ⇒ Entero (solo lectura)

#confidencial ⇒ verdadero | falso (solo lectura)

#id_conexión_servidor ⇒ Entero (solo lectura)

#service_id ⇒ nil | Objeto (solo lectura)

#socket_object_id ⇒ Object (solo lectura)

Detalles del método de clase

.generate(direction, operation_id, payload, socket_object_id: nil, connection_id: nil, connection_generation: nil, server_connection_id: nil, service_id: nil) ⇒ CommandStarted

Ejemplos:

Crear el evento.

Detalles del método de instancia

#inspect ⇒ String

#summary → String

#inicializar(nombre_comando, nombre_base_datos, dirección, id_solicitud, id_operación, comando, id_objeto_socket: nil, id_conexión: nil, generación_conexión: nil, id_conexión_servidor: nil, id_servicio: nil) ⇒ `ComandoIniciado`

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

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

#command_name ⇒ `String` (solo lectura)

#connection_generation ⇒ `Objeto` (solo lectura)

#connection_id ⇒ `Entero` (solo lectura)

#database_name ⇒ `String` (solo lectura)

#operation_id ⇒ `Integer` (solo lectura)

#request_id ⇒ `Entero` (solo lectura)

#confidencial ⇒ `verdadero | falso` (solo lectura)

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

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

#socket_object_id ⇒ `Object` (solo lectura)

.generate(direction, operation_id, payload, socket_object_id: nil, connection_id: nil, connection_generation: nil, server_connection_id: nil, service_id: nil) ⇒ `CommandStarted`

#inspect ⇒ `String`

#summary → `String`