Classe: Mongo::Monitoring::Event::CommandFailed

Herda:

Evento::Base

• Objeto
• Evento::Base
• Mongo::Monitoramento::Evento::CommandFailed

Inclui:

Seguro

Definido em:

build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_failed.rb

Visão geral

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

Desde:

• 2.1.0

Resumo constante

Constantes incluídas do Secure

Seguro::REDACTED_COMMANDS

Recolhimento do Resumo do atributo de

• #endereço ➤ Servidor::Endereço Somente leitura

  Endereço O endereço do servidor.

• #command_name ➤ string Somente leitura

  Command_name O nome do comando.

• #database_name ➤ string Somente leitura

  Database_name O nome do database_name.

• #duração ➤ Flutuante Somente leitura

  Duração A duração do comando em segundos.

• #failure ➤ BSON::Document Somente leitura

  Falha O documento de erro , se presente.

• #mensagem ➤ string Somente leitura

  Mensagem A mensagem de erro.

• #operation_id ⇒ Integer Somente leitura

  Operation_id O ID da operação.

• #request_id ⇒ Integer Somente leitura

  Request_id A ID da solicitação.

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

• #started_event ⇒ Monitoramento::Event::CommandStarted Somente leitura privado

  Started_event O evento iniciado correspondente.

Recolhimento do Resumo do método de

• .gerar(endereço, operation_id, carga útil, mensagem, falha, duração, started_event:, server_connection_id: nil, service_id: nil) ➤ CommandFailed privado

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

Recolhimento do Resumo do método de

• #initialize(command_name, database_name, endereço, query_id, operation_id, mensagem, falha, duração, started_event:, server_connection_id: nil, service_id: nil) ➤ CommandFailed construtor privado

  Crie o novo evento.

• #resumo ➤ string

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

Métodos incluídos do Secure

#compression_allowed?, #editado, #sensitive?

Detalhes do construtor

#initialize(command_name, database_name, endereço, query_id, operation_id, mensagem, falha, duração, started_event:, server_connection_id: nil, service_id: nil) ➤ CommandFailed

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.

• mensagem (string) —

  A mensagem de erro.

• falha (BSON::Document) —

  O documento de erro, se houver.

• 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

# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_failed.rb', linha 85

def inicializar(command_name, nome do banco de dados, endereço,
  request_id, operation_id, mensagem, falha, 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
  @message = mensagem
  @started_event = started_event
  @failure = editado(command_name, falha)
  @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

# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_failed.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

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

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

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

def nome do banco de dados
  @database_name
end

#duration ➤ Flutuante (somente leitura)

Retorna a duração A duração do comando em segundos.

Retorna:

• (Flutuante) —

  duration A duração do comando em segundos.

Desde:

• 2.1.0

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

def duration
  @duração
end

#failure ➤ BSON::Document (readonly)

Retorna o documento de erro com falha, se presente. Isso só será preenchido para erros comunicados por um servidor MongoDB. Em outras situações, por exemplo, no caso de um erro de rede, este atributo pode ser nulo.

Retorna:

• (BSON::Document) —

  failure O documento de erro , se presente. Isto só será preenchido para erros comunicados por um servidor MongoDB . Em outras situações, por exemplo , no caso de um erro de rede, este atributo pode ser nulo.

Desde:

• 2.1.0

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

def falha
  @failure
end

#mensagem ➤ string (somente leitura)

Retorna mensagem A mensagem de erro. Ao contrário do documento de erro, a mensagem de erro deve estar sempre presente.

Retorna:

• (string) —

  mensagem A mensagem de erro. Ao contrário do documento de erro, a mensagem de erro deve estar sempre presente.

Desde:

• 2.1.0

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

def mensagem
  @message
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

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

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

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

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

# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_failed.rb', linha 57

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

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

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:

• (Monitoramento::Event::CommandStarted) —

  started_event O evento iniciado correspondente .

Desde:

• 2.1.0

# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_failed.rb', linha 66

def started_event
  @started_event
end

Detalhes do método de classe

.gerar(endereço, operation_id, carga útil, mensagem, falha, duração, started_event:, server_connection_id: nil, service_id: nil) ➤ CommandFailed

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.

CommandFailed.generate(address, 1, payload, duration)

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.

• mensagem (string) —

  A mensagem de erro.

• falha (BSON::Document) —

  O documento de erro, se houver.

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

• (CommandFailed) —

  O evento.

Desde:

• 2.1.0

# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_failed.rb', linha 132

def auto.Gerar(endereço, operation_id, Carga útil, mensagem,
  falha, duration, started_event:, server_connection_id: nada,
  service_id: nada
)
  Novo(
    Carga útil[:command_name],
    Carga útil[:database_name],
    endereço,
    Carga útil[:request_id],
    operation_id,
    mensagem,
    falha,
    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

# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_failed.rb', linha 109

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