Classe: Mongo::Monitoring::Event::CommandStarted

Herda:

Evento::Base

Objeto
Evento::Base
Mongo::Monitoramento::Evento::CommandStarted

mostrar tudo

Inclui:: Seguro

Definido em:: lib/mongo/monitoring/ evento/command_started.rb

Visão geral

Evento que é acionado quando uma operação de comando é iniciada.

Desde:

2.1.0

Resumo constante

Constantes incluídas do Secure

Seguro::REDACTED_COMMANDS

Recolhimento do Resumo do atributo de instância

#endereço ➤ Servidor::Endereço Somente leitura
Endereço O endereço do servidor.
#command ➤ BSON::Document Somente leitura
Comando Os argumentos de comando.
#command_name ➤ string Somente leitura
Command_name O nome do comando.
#connection_generation ➤ Objeto Somente leitura privado
#connection_id ➤ Inteiro Somente leitura privado
A ID da conexão pela qual o comando é enviado.
#database_name ➤ string Somente leitura
Database_name O nome do database_name.
#operation_id ⇒ Integer Somente leitura
Operation_id O ID da operação.
#request_id ⇒ Integer Somente leitura
Request_id A ID da solicitação.
#sensitive ➤ true | false Somente leitura privado
Se o evento contém dados confidenciais.
#server_connection_id ➤ Inteiro Somente leitura
Server_connection_id A ID de conexão do servidor.
#service_id ➤ nil | Objeto Somente leitura
A ID do serviço, se houver.
#socket_object_id ➤ Objeto Somente leitura privado
object_id do objeto de soquete usado para esse comando.

Recolhimento do Resumo do método de classe

.gerar(endereço, operation_id, carga útil, soquete_object_id: nil, connection_id: nil, connection_generação: nil, server_connection_id: nil, service_id: nil) ➤ CommandStarted privado
Crie o evento a partir de uma carga útil de mensagem de protocolo de fio.

Recolhimento do Resumo do método de instância

. construtor privado
Crie o novo evento.
#inspecionar ➤ string
Retorna um resumo conciso, mas útil, do evento.
#resumo ➤ string
Retorna um resumo conciso, mas útil, do evento.

Métodos incluídos do Secure

#compression_allowed?, #editado, #sensitive?

Detalhes do construtor

.

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Crie o novo evento.

Exemplos:

Crie o evento.

Parâmetros:

command_name (string) —
O nome do comando.
nome do banco de dados (string) —
O nome database_name.
endereço (Servidor::Endereço) —
O endereço do servidor .
request_id (Inteiro) —
A ID da solicitação.
operation_id (Inteiro) —
O ID da operação.
comando (BSON::Document) —
Os argumentos de comando.
service_id (Objeto) (padrão para: nil) —
A ID do serviço, se houver.

Desde:

2.1.0

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 83

def inicializar(command_name, nome do banco de dados, endereço, request_id,
               operation_id, comando, socket_object_id: nada, connection_id: nada,
               connection_generação: nada, server_connection_id: nada,
               service_id: nada)
  @command_name = command_name.to_s
  @database_name = nome do banco de dados
  @address = endereço
  @request_id = request_id
  @operation_id = operation_id
  @service_id = service_id
  @sensitive = sensível?(
    command_name: @command_name,
    Documento: comando
  )
  @command = editado(command_name, comando)
  @socket_object_id = socket_object_id
  @connection_id = connection_id
  @connection_generation = connection_generação
  @server_connection_id = server_connection_id
end

Detalhes do atributo da instância

#endereço ➤ `Servidor::Endereço` (somente leitura)

Retorna endereço O endereço do servidor.

Retorna:

(Servidor::Endereço) —
endereço O endereço do servidor .

Desde:

2.1.0



27
28
29

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 27

def endereço
  @address
end

#command ➤ `BSON::Document` (readonly)

Retorna comando Os argumentos de comando.

Retorna:

(BSON::Document) —
comando Os argumentos de comando.

Desde:

2.1.0



30
31
32

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 30

def comando
  @command
end

#command_name ➤ `string` (somente leitura)

Retorna command_name O nome do comando.

Retorna:

(string) —
command_name O nome do comando.

Desde:

2.1.0



33
34
35

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 33

def command_name
  @command_name
end

# `objeto` de connection_generação(somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Desde:

2.1.0



53
54
55

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 53

def connection_generação
  @connection_generation
end

#connection_id ➤ `Inteiro` (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna A ID da conexão pela qual o comando é enviado.

Retorna:

(Inteiro) —
A ID da conexão pela qual o comando é enviado.

Desde:

2.1.0



59
60
61

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 59

def connection_id
  @connection_id
end

#database_name ➤ `string` (somente leitura)

Retorna database_name O nome do database_name.

Retorna:

(string) —
database_name O nome do database_name.

Desde:

2.1.0



36
37
38

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 36

def nome do banco de dados
  @database_name
end

#operation_id ➤ `Inteiro` (somente leitura)

Retorna operation_id A ID da operação.

Retorna:

(Inteiro) —
operation_id A ID da operação.

Desde:

2.1.0



39
40
41

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 39

def operation_id
  @operation_id
end

#request_id ➤ `Inteiro` (somente leitura)

Retorna request_id A ID da solicitação.

Retorna:

(Inteiro) —
request_id A ID da solicitação.

Desde:

2.1.0



42
43
44

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 42

def request_id
  @request_id
end

#sensitive ➤ `true | false` (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna se o evento contém dados confidenciais.

Retorna:

(verdadeiro | falso) —
Se o evento contém dados confidenciais.

Desde:

2.1.0



67
68
69

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 67

def sensível
  @sensitive
end

#server_connection_id ➤ `Inteiro` (somente leitura)

Retorna server_connection_id O ID de conexão do servidor.

Retorna:

(Inteiro) —
server_connection_id A ID de conexão do servidor .

Desde:

2.1.0



62
63
64

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 62

def server_connection_id
  @server_connection_id
end

#service_id ➤ `nil | Objeto` (somente leitura)

Retorna A ID do serviço, se houver.

Retorna:

(nil | Objeto) —
A ID do serviço, se houver.

Desde:

2.1.0



45
46
47

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 45

def service_id
  @service_id
end

#socket_object_id ➤ `Objeto` (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

object_id do objeto de soquete usado para esse comando.

Desde:

2.1.0



50
51
52

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 50

def socket_object_id
  @socket_object_id
end

Detalhes do método de classe

.gerar(endereço, operation_id, carga útil, soquete_object_id: nil, connection_id: nil, connection_generação: nil, server_connection_id: nil, service_id: nil) ➤ `CommandStarted`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Crie o evento a partir de uma carga útil de mensagem de protocolo de fio.

Exemplos:

Crie o evento.

CommandStarted.generate(address, 1, payload)

Parâmetros:

endereço (Servidor::Endereço) —
O endereço do servidor .
operation_id (Inteiro) —
O ID da operação.
Carga útil (Hash) —
A carga útil da mensagem.
service_id (Objeto) (padrão para: nil) —
A ID do serviço, se houver.

Retorna:

(CommandStarted) —
O evento.

Desde:

2.1.0

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 147

def auto.Gerar(endereço, operation_id, Carga útil,
                  socket_object_id: nada, connection_id: nada, connection_generação: nada,
                  server_connection_id: nada, service_id: nada)
  Novo(
    Carga útil[:command_name],
    Carga útil[:database_name],
    endereço,
    Carga útil[:request_id],
    operation_id,
    # Todas as cargas úteis op_msg têm um campo$db. Cargas úteis legadas não
    # ter um campo$db . Para emular op_msg ao publicar comando
    # monitoramento de eventos para servidores legado , adicione $db à carga,
    # copiando o nome do banco de dados de dados. Observe que o nome do banco de dados de dados também é
    # disponível como um atributo de nível superior no evento iniciado por comando.
    Carga útil[:command].mesclar('$db' => Carga útil[:database_name]),
    socket_object_id: socket_object_id,
    connection_id: connection_id,
    connection_generação: connection_generação,
    server_connection_id: server_connection_id,
    service_id: service_id
  )
end

Detalhes do método de instância

#inspecionar ➤ `string`

Retorna um resumo conciso, mas útil, do evento.

Retorna:

(string) —
resumo de string do evento.

Desde:

2.6.0



175
176
177

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 175

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

#resumo ➤ `string`

Observação:

Este método é experimental e sujeito a alterações.

Retorna um resumo conciso, mas útil, do evento.

Retorna:

(string) —
resumo de string do evento.

Desde:

2.1.0



111
112
113

# File 'lib/mongo/monitoring/ evento/command_started.rb', linha 111

def Resumo
  "#<#{curto_class_name} endereço=#{endereço} #{database_name}.#{command_name} command=#{command_summary}>"
end

Classe: Mongo::Monitoring::Event::CommandStarted

Visão geral

Resumo constante

Constantes incluídas do Secure

Recolhimento do Resumo do atributo de instância

Recolhimento do Resumo do método de classe

Recolhimento do Resumo do método de instância

Métodos incluídos do Secure

Detalhes do construtor

.

Exemplos:

Crie o evento.

Detalhes do atributo da instância

#endereço ➤ Servidor::Endereço (somente leitura)

#command ➤ BSON::Document (readonly)

#command_name ➤ string (somente leitura)

# objeto de connection_generação(somente leitura)

#connection_id ➤ Inteiro (somente leitura)

#database_name ➤ string (somente leitura)

#operation_id ➤ Inteiro (somente leitura)

#request_id ➤ Inteiro (somente leitura)

#sensitive ➤ true | false (somente leitura)

#server_connection_id ➤ Inteiro (somente leitura)

#service_id ➤ nil | Objeto (somente leitura)

#socket_object_id ➤ Objeto (somente leitura)

Detalhes do método de classe

.gerar(endereço, operation_id, carga útil, soquete_object_id: nil, connection_id: nil, connection_generação: nil, server_connection_id: nil, service_id: nil) ➤ CommandStarted

Exemplos:

Crie o evento.

Detalhes do método de instância

#inspecionar ➤ string

#resumo ➤ string

#endereço ➤ `Servidor::Endereço` (somente leitura)

#command ➤ `BSON::Document` (readonly)

#command_name ➤ `string` (somente leitura)

# `objeto` de connection_generação(somente leitura)

#connection_id ➤ `Inteiro` (somente leitura)

#database_name ➤ `string` (somente leitura)

#operation_id ➤ `Inteiro` (somente leitura)

#request_id ➤ `Inteiro` (somente leitura)

#sensitive ➤ `true | false` (somente leitura)

#server_connection_id ➤ `Inteiro` (somente leitura)

#service_id ➤ `nil | Objeto` (somente leitura)

#socket_object_id ➤ `Objeto` (somente leitura)

.gerar(endereço, operation_id, carga útil, soquete_object_id: nil, connection_id: nil, connection_generação: nil, server_connection_id: nil, service_id: nil) ➤ `CommandStarted`

#inspecionar ➤ `string`

#resumo ➤ `string`