CommandFailed — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Monitoring::Event::CommandFailed

Overview

Event that is fired when a command operation fails.

Constant Summary

Constants included from Secure

Secure::REDACTED_COMMANDS

Instance Attribute Summary collapse

Class Method Summarycollapse

Instance Method Summarycollapse

Methods included from Secure

#compression_allowed?, #redacted, #sensitive?

Constructor Details

#initialize(command_name, database_name, address, request_id, operation_id, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create the new event.

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 # File 'lib/mongo/monitoring/event/command_failed.rb', line 85 def initialize(command_name, database_name, address, request_id, operation_id, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil ) @command_name = command_name.to_s @database_name = database_name @address = address @request_id = request_id @operation_id = operation_id @service_id = service_id @message = message @started_event = started_event @failure = redacted(command_name, failure) @duration = duration @server_connection_id = server_connection_id end

Instance Attribute Details

#address ⇒ Server::Address

Returns address The server address.

29 30 31 # File 'lib/mongo/monitoring/event/command_failed.rb', line 29 def address @address end

#command_name ⇒ String

Returns command_name The name of the command.

32 33 34 # File 'lib/mongo/monitoring/event/command_failed.rb', line 32 def command_name @command_name end

#database_name ⇒ String

Returns database_name The name of the database_name.

35 36 37 # File 'lib/mongo/monitoring/event/command_failed.rb', line 35 def database_name @database_name end

#duration ⇒ Float

Returns duration The duration of the command in seconds.

38 39 40 # File 'lib/mongo/monitoring/event/command_failed.rb', line 38 def duration @duration end

#failure ⇒ BSON::Document

Returns failure The error document, if present. This will only be filled out for errors communicated by a MongoDB server. In other situations, for example in case of a network error, this attribute may be nil.

44 45 46 # File 'lib/mongo/monitoring/event/command_failed.rb', line 44 def failure @failure end

#message ⇒ String

Returns message The error message. Unlike the error document, the error message should always be present.

48 49 50 # File 'lib/mongo/monitoring/event/command_failed.rb', line 48 def message @message end

#operation_id ⇒ Integer

Returns operation_id The operation id.

51 52 53 # File 'lib/mongo/monitoring/event/command_failed.rb', line 51 def operation_id @operation_id end

#request_id ⇒ Integer

Returns request_id The request id.

54 55 56 # File 'lib/mongo/monitoring/event/command_failed.rb', line 54 def request_id @request_id end

#server_connection_id ⇒ Integer

Returns server_connection_id The server connection id.

57 58 59 # File 'lib/mongo/monitoring/event/command_failed.rb', line 57 def server_connection_id @server_connection_id end

#service_id ⇒ nil | Object

Returns The service id, if any.

60 61 62 # File 'lib/mongo/monitoring/event/command_failed.rb', line 60 def service_id @service_id end

#started_event ⇒ Monitoring::Event::CommandStarted

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns started_event The corresponding started event.

66 67 68 # File 'lib/mongo/monitoring/event/command_failed.rb', line 66 def started_event @started_event end

Class Method Details

.generate(address, operation_id, payload, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create the event from a wire protocol message payload.

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 # File 'lib/mongo/monitoring/event/command_failed.rb', line 132 def self.generate(address, operation_id, payload, message, failure, duration, started_event:, server_connection_id: nil, service_id: nil ) new( payload[:command_name], payload[:database_name], address, payload[:request_id], operation_id, message, failure, duration, started_event: started_event, server_connection_id: server_connection_id, service_id: service_id, ) end

Instance Method Details

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.

109 110 111 # File 'lib/mongo/monitoring/event/command_failed.rb', line 109 def summary "#<#{short_class_name} address=#{address} #{database_name}.#{command_name}>" end