类：Mongo::Monitoring::Event::CommandSucceeded

继承：
Event::Base
  • 对象
显示全部
包括：
安全
定义于：
构建/Ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_succeeded.rb

Overview

命令操作成功时触发的事件。

由于：

  • 2.1.0

常量摘要

Secure中包含的常量

Secure::REDACTED_COMMANDS

实例属性摘要折叠

类方法摘要折叠

实例方法摘要折叠

Secure中包含的方法

#compression_allowed? 、 #redacted 、 #sensitive?

构造函数详情

#initialize (command_name, database_name,address, request_id, operation_id,reply, duration,started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandSucceeded

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

创建新事件。

例子：

创建事件。

参数：

  • command_name ( string ) —

    命令的名称。

  • database_name ( string ) —

    数据库名称。

  • 地址 ( Server::Address ) —

    服务器解决。

  • request_id ( Integer ) —

    请求ID。

  • operation_id ( Integer ) —

    操作 ID。

  • 回复 ( BSON::Document ) —

    命令回复。

  • duration (浮点) —

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

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

    相应的已启动事件。

  • service_id （对象） （默认为： nil ） —

    服务 ID（如果有）。

由于：

  • 2.1.0



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_succeeded.rb', 第78行

def 初始化(command_name, database_name, 地址, request_id,
  operation_id, 回复, 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
  @started_event = started_event
  @reply = 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_succeeded.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_succeeded.rb', 第32行

def command_name
  @command_name
end

# database_name ⇒ string （只读）

返回 database_name数据库的名称。

返回：

  • ( string ) —

    database_name数据库的名称。

由于：

  • 2.1.0



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

def database_name
  @database_name
end

# duration ⇒ Float （只读）

返回持续时间事件的持续时间。

返回：

  • (浮点) —

    duration事件的持续时间。

由于：

  • 2.1.0



41
42
43
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_succeeded.rb', 第41行

def duration
  @duration
end

# operation_id ⇒整数（只读）

返回 operation_id 操作 ID。

返回：

  • ( Integer ) —

    operation_id 操作 ID。

由于：

  • 2.1.0



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

def operation_id
  @operation_id
end

#reply ⇒ BSON::Document (readonly)

返回回复 命令回复。

返回：

  • ( BSON::Document ) —

    回复 命令回复。

由于：

  • 2.1.0



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

def 回复
  @reply
end

# request_id ⇒整数（只读）

返回 request_id请求ID。

返回：

  • ( Integer ) —

    request_id请求ID。

由于：

  • 2.1.0



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

def request_id
  @request_id
end

# server_connection_id ⇒整数（只读）

返回 server_connection_id 服务器连接 ID。

返回：

  • ( Integer ) —

    server_connection_id服务器连接 ID。

由于：

  • 2.1.0



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

def server_connection_id
  @server_connection_id
end

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

返回 服务 ID（如果有）。

返回：

  • ( nil | Object ) —

    服务 ID（如果有）。

由于：

  • 2.1.0



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

def service_id
  @service_id
end

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

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

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

返回：

由于：

  • 2.1.0



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

def started_event
  @started_event
end

类方法详细信息

。生成（地址，操作 ID，命令有效负载，回复有效负载，持续时间，开始事件：，服务器连接 ID：nil，service_id：nil） ⇒ CommandCompleted

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

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

例子：

创建事件。

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

参数：

  • 地址 ( Server::Address ) —

    服务器解决。

  • operation_id ( Integer ) —

    操作 ID。

  • command_payload (哈希) —

    命令消息有效负载。

  • reply_payload (哈希) —

    回复消息有效负载。

  • duration (浮点) —

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

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

    相应的已启动事件。

  • service_id （对象） （默认为： nil ） —

    服务 ID（如果有）。

返回：

  • ( CommandCompleted ) —

    事件。

由于：

  • 2.1.0



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_succeeded.rb', 第123行

def self.生成(地址, operation_id, command_payload,
  reply_payload, duration, starts_event:, server_connection_id: nil,
  service_id: nil
)
  new(
    command_payload[:command_name],
    command_payload[:database_name],
    地址,
    command_payload[:request_id],
    operation_id,
    generate_reply(command_payload, reply_payload),
    duration,
    starts_event: started_event,
    server_connection_id: server_connection_id,
    service_id: service_id,
  )
end

实例方法详细信息

#摘要⇒ string

注意：

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

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

返回：

  • ( string ) —

    事件摘要的string 。

由于：

  • 2.1.0



101
102
103
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/monitoring/event/command_succeeded.rb', 第101行

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