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

Herda:
Evento::Base
  • Objeto
mostrar tudo
Inclui:
Seguro
Definido em:
build/ruby-driver-v2.19/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

Recolhimento do Resumo do método de classe

Recolhimento do Resumo do método de instância

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 85

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



29
30
31
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 29

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



32
33
34
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 32

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



35
36
37
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 35

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



55
56
57
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 55

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



61
62
63
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 61

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



38
39
40
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 38

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



41
42
43
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 41

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



44
45
46
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 44

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



69
70
71
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 69

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



64
65
66
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 64

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



47
48
49
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 47

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



52
53
54
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 52

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:

Desde:

  • 2.1.0



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 150

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



179
180
181
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 179

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



114
115
116
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_started.rb', linha 114

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