Classe: Mongo::Monitoring::Event::CommandSucceeded

Herda:
Evento::Base
  • Objeto
mostrar tudo
Inclui:
Seguro
Definido em:
build/ruby-driver-v2.19/lib/mongo/monitoring/ evento/command_succeeded.rb

Visão geral

Evento que é acionado quando uma operação de comando é bem-sucedida.

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

#initialize(command_name, database_name, endereço, query_id, operation_id, explain, duration, started_event:, server_connection_id: nil, service_id: nil) ➤ CommandSucceeded

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 do banco de dados.

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

  • responder (BSON::Document) —

    A resposta do comando.

  • duration (Flutuante) —

    A duração que o comando levou em segundos.

  • started_event (Monitoramento::Event::CommandStarted) —

    O evento iniciado correspondente .

  • service_id (Objeto) (padrão para: nil) —

    A ID do serviço, se houver.

Desde:

  • 2.1.0



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', linha 78

def inicializar(command_name, nome do banco de dados, endereço, request_id,
  operation_id, responder, duration, started_event:,
  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
  @started_event = started_event
  @reply = editado(command_name, responder)
  @duração = duration
  @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/event/command_succeeded.rb', linha 29

def endereço
  @address
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



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

def command_name
  @command_name
end

#database_name ➤ string (somente leitura)

Retorna database_name O nome do banco de banco de dados.

Retorna:

  • (string) —

    database_name O nome do banco de banco de dados.

Desde:

  • 2.1.0



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

def nome do banco de dados
  @database_name
end

#duration ➤ Flutuante (somente leitura)

Retorna a duração A duração do evento.

Retorna:

  • (Flutuante) —

    duration A duração do evento.

Desde:

  • 2.1.0



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

def duration
  @duração
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



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

def operation_id
  @operation_id
end

#responder ➤ BSON::Document (readonly)

Retorna a resposta A resposta do comando.

Retorna:

  • (BSON::Document) —

    responder O comando responde.

Desde:

  • 2.1.0



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

def responder
  @reply
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



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

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



50
51
52
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', linha 50

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



53
54
55
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', linha 53

def service_id
  @service_id
end

#started_event ⇒ Monitoramento::Event::CommandStarted (readonly)

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 started_event O evento iniciado correspondente.

Retorna:

Desde:

  • 2.1.0



59
60
61
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', linha 59

def started_event
  @started_event
end

Detalhes do método de classe

.gerar(address, operation_id, command_ payload, responder_paga, duração, started_event:, server_connection_id: nil, service_id: nil) ➤ CommandCompleted

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.

CommandSucceeded.generate(address, 1, command_payload, reply_payload, 0.5)

Parâmetros:

  • endereço (Servidor::Endereço) —

    O endereço do servidor .

  • operation_id (Inteiro) —

    O ID da operação.

  • command_ payload (Hash) —

    A carga útil da mensagem de comando.

  • responder_palavra (Hash) —

    A carga útil da mensagem de resposta.

  • duration (Flutuante) —

    A duração do comando em segundos.

  • started_event (Monitoramento::Event::CommandStarted) —

    O evento iniciado correspondente .

  • service_id (Objeto) (padrão para: nil) —

    A ID do serviço, se houver.

Retorna:

  • (CommandCompleted) —

    O evento.

Desde:

  • 2.1.0



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', linha 123

def auto.Gerar(endereço, operation_id, command_ payload,
  responder_palavra, duration, started_event:, server_connection_id: nada,
  service_id: nada
)
  Novo(
    command_ payload[:command_name],
    command_ payload[:database_name],
    endereço,
    command_ payload[:request_id],
    operation_id,
    gera_reply(command_ payload, responder_palavra),
    duration,
    started_event: started_event,
    server_connection_id: server_connection_id,
    service_id: service_id,
  )
end

Detalhes do método de instância

#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



101
102
103
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', linha 101

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