类：Mongo::Monitoring::Event::CommandFailed

继承：

Event::Base

对象
Event::Base
Mongo::Monitoring::Event::CommandFailed

显示全部

包括：: 安全

定义于：: build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb

Overview

命令操作失败时触发的事件。

由于：

2.1.0

常量摘要

Secure中包含的常量

Secure::REDACTED_COMMANDS

实例属性摘要折叠

#解决="Server::Address" 只读

地址服务器地址。
# command_name ⇒ string 只读

Command_name 命令的名称。
# database_name ⇒ string 只读

Database_name database_name 的名称。
# duration ⇒ Float 只读

持续时间命令的持续时间（以秒为单位）。
# failure ⇒ BSON::Document 只读

失败错误文档（如果存在）。
# message ⇒ string 只读

消息错误消息。
#operation_id ⇒ Integer 只读

Operation_id 操作 ID。
#request_id ⇒ Integer 只读

Request_id请求ID。
# server_connection_id ⇒ 整数只读

Server_connection_id 服务器连接 ID。
# service_id ="nil |对象只读

服务 ID（如果有）。
#started_event ⇒ Monitoring::Event::CommandStarted 只读 private

Started_event 相应的已启动事件。

类方法摘要折叠

。 generate (address, operation_id, payload, message, failure, duration,Started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed private

从传输协议消息有效负载创建事件。

实例方法摘要折叠

#initialize (command_name, database_name,address, request_id, operation_id, message, failure, duration,Started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed 构造函数 private

创建新事件。
#摘要⇒ string

返回简洁而有用的事件摘要。

Secure中包含的方法

#compression_allowed? 、 #redacted 、 #sensitive?

构造函数详情

#initialize (command_name, database_name, 解决, request_id, operation_id, message, failure, duration,Started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandFailed`

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

创建新事件。

例子：

创建事件。

参数：

command_name ( string ) —

命令的名称。
database_name ( string ) —

database_name 名称。
地址 ( Server::Address ) —

服务器解决。
request_id ( Integer ) —

请求ID。
operation_id ( Integer ) —

操作 ID。
message ( string ) —

错误消息。
故障 ( BSON::Document ) —

错误文档（如果有）。
duration (浮点) —

命令持续时间（以秒为单位）。
started_event ( Monitoring::Event::CommandStarted ) —

相应的已启动事件。
service_id （对象） （默认为： nil ） —

服务 ID（如果有）。

由于：

2.1.0

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第85行

def 初始化(command_name, database_name, 地址,
  request_id, operation_id, message, 故障, duration,
  starts_event:, server_connection_id: nil, service_id: nil
)
  @command_name = command_name.to_s
  @database_name = database_name
  @address = 地址
  @request_id = request_id
  @operation_id = operation_id
  @service_id = service_id
  @message = message
  @started_event = started_event
  @failure = redacted(command_name, 故障)
  @duration = duration
  @server_connection_id = server_connection_id
end

实例属性详细信息

#解决⇒ `Server::Address` （只读）

返回地址服务器地址。

( Server::Address ) —

解决服务器解决。

由于：

2.1.0



29
30
31

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第29行

def 地址
  @address
end

# command_name ⇒ `string` （只读）

返回 command_name 命令的名称。

( string ) —

command_name 命令的名称。

由于：

2.1.0



32
33
34

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第32行

def command_name
  @command_name
end

# database_name ⇒ `string` （只读）

返回 database_name database_name 的名称。

( string ) —

database_name database_name 的名称。

由于：

2.1.0



35
36
37

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第35行

def database_name
  @database_name
end

# duration ⇒ `Float` （只读）

返回 duration 命令的持续时间（以秒为单位）。

(浮点) —

持续时间命令的持续时间（以秒为单位）。

由于：

2.1.0



38
39
40

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第38行

def duration
  @duration
end

# failure ⇒ `BSON::Document` （只读）

返回失败错误文档（如果存在）。只有在出现由 MongoDB 服务器传达的错误时才会填写此字段。在其他情况下，例如出现网络错误时，该属性可能为零。

( BSON::Document ) —

failure 错误文档（如果存在）。只有当MongoDB服务器发生错误时才会填写此字段。在其他情况下，示例出现网络错误时，该属性可能为零。

由于：

2.1.0



44
45
46

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第44行

def 故障
  @failure
end

# message ⇒ `string` (readonly)

返回消息错误消息。与错误文档不同，错误消息应始终存在。

( string ) —

message 错误消息。与错误文档不同，错误消息应始终存在。

由于：

2.1.0



48
49
50

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第48行

def message
  @message
end

# operation_id ⇒`整数`（只读）

返回 operation_id 操作 ID。

( Integer ) —

operation_id 操作 ID。

由于：

2.1.0



51
52
53

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第51行

def operation_id
  @operation_id
end

# request_id ⇒`整数`（只读）

返回 request_id请求ID。

( Integer ) —

request_id请求ID。

由于：

2.1.0



54
55
56

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第54行

def request_id
  @request_id
end

# server_connection_id ⇒`整数`（只读）

返回 server_connection_id 服务器连接 ID。

( Integer ) —

server_connection_id服务器连接 ID。

由于：

2.1.0



57
58
59

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第57行

def server_connection_id
  @server_connection_id
end

# service_id =" `nil |对象`（只读）

返回服务 ID（如果有）。

( nil | Object ) —

服务 ID（如果有）。

由于：

2.1.0



60
61
62

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第60行

def service_id
  @service_id
end

#started_event ⇒ `Monitoring::Event::CommandStarted` (readonly)

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

返回 startup_event 相应的已启动事件。

( Monitoring::Event::CommandStarted ) —

startup_event 相应的已启动事件。

由于：

2.1.0



66
67
68

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第66行

def started_event
  @started_event
end

类方法详细信息

。 generate (address, operation_id, payload, message, failure, duration,Started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandFailed`

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

从传输协议消息有效负载创建事件。

例子：

创建事件。

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

参数：

地址 ( Server::Address ) —

服务器解决。
operation_id ( Integer ) —

操作 ID。
有效负载 (哈希) —

消息有效负载。
message ( string ) —

错误消息。
故障 ( BSON::Document ) —

错误文档（如果有）。
duration (浮点) —

命令的持续时间（以秒为单位）。
started_event ( Monitoring::Event::CommandStarted ) —

相应的已启动事件。
service_id （对象） （默认为： nil ） —

服务 ID（如果有）。

( CommandFailed ) —

事件。

由于：

2.1.0

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第132行

def self.生成(地址, operation_id, 有效负载, message,
  故障, duration, starts_event:, server_connection_id: nil,
  service_id: nil
)
  new(
    有效负载[:command_name],
    有效负载[:database_name],
    地址,
    有效负载[:request_id],
    operation_id,
    message,
    故障,
    duration,
    starts_event: started_event,
    server_connection_id: server_connection_id,
    service_id: service_id,
  )
end

实例方法详细信息

#摘要⇒ `string`

注意：

此方法是实验性的，可能会发生变化。

返回简洁而有用的事件摘要。

( string ) —

事件摘要的string 。

由于：

2.1.0



109
110
111

# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 第109行

def 总结
  " #< #{简短类名}地址= #{地址} #{ database_name } . #{ command_name } > "
end

类：Mongo::Monitoring::Event::CommandFailed

Overview

常量摘要

Secure中包含的常量

实例属性摘要折叠

类方法摘要折叠

实例方法摘要折叠

Secure中包含的方法

构造函数详情

#initialize (command_name, database_name, 解决, request_id, operation_id, message, failure, duration,Started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed

实例属性详细信息

#解决⇒ Server::Address （只读）

# command_name ⇒ string （只读）

# database_name ⇒ string （只读）

# duration ⇒ Float （只读）

# failure ⇒ BSON::Document （只读）

# message ⇒ string (readonly)

# operation_id ⇒整数（只读）

# request_id ⇒整数（只读）

# server_connection_id ⇒整数（只读）

# service_id =" nil |对象（只读）

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

类方法详细信息

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

实例方法详细信息

#摘要⇒ string

#initialize (command_name, database_name, 解决, request_id, operation_id, message, failure, duration,Started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandFailed`

#解决⇒ `Server::Address` （只读）

# command_name ⇒ `string` （只读）

# database_name ⇒ `string` （只读）

# duration ⇒ `Float` （只读）

# failure ⇒ `BSON::Document` （只读）

# message ⇒ `string` (readonly)

# operation_id ⇒`整数`（只读）

# request_id ⇒`整数`（只读）

# server_connection_id ⇒`整数`（只读）

# service_id =" `nil |对象`（只读）

#started_event ⇒ `Monitoring::Event::CommandStarted` (readonly)

。 generate (address, operation_id, payload, message, failure, duration,Started_event:, server_connection_id: nil, service_id: nil) ⇒ `CommandFailed`

#摘要⇒ `string`