类：Mongo::Monitoring::Event::CommandStarted

继承：

Event::Base

对象
Event::Base
Mongo::Monitoring::Event::CommandStarted

显示全部

包括：: 安全

定义于：: 构建/Ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb

Overview

命令操作开始时触发的事件。

由于：

2.1.0

常量摘要

Secure中包含的常量

Secure::REDACTED_COMMANDS

实例属性摘要折叠

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

地址服务器地址。
#命令⇒ BSON::Document 只读

命令命令参数。
# command_name ⇒ string 只读

Command_name 命令的名称。
# connection_Generation ⇒ 对象只读 private
# connection_id ⇒ 整数只读 private

发送命令的连接的ID 。
# database_name ⇒ string 只读

Database_name database_name 的名称。
#operation_id ⇒ Integer 只读

Operation_id 操作 ID。
#request_id ⇒ Integer 只读

Request_id请求ID。
#sensitive ⇒ true | false 只读 private

事件是否包含敏感数据。
# server_connection_id ⇒ 整数只读

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

服务 ID（如果有）。
# socket_object_id ⇒ 对象只读 private

用于此命令的套接字对象的 object_id。

类方法摘要折叠

。 generate (解决, operation_id, payload, socket_object_id: nil, connection_id: nil, connection_Generation: nil, server_connection_id: nil, service_id: nil) ⇒ CommandStarted private

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

实例方法摘要折叠

#initialize (command_name, database_name, 解决, request_id, operation_id, command, socket_object_id: nil, connection_id: nil, connection_Generation: nil, server_connection_id: nil, service_id: nil) ⇒ CommandStarted 构造函数 private

创建新事件。
#检查⇒ string

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

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

Secure中包含的方法

#compression_allowed? 、 #redacted 、 #sensitive?

构造函数详情

#initialize (command_name, database_name, 解决, request_id, operation_id, command, socket_object_id: nil, connection_id: nil, connection_Generation: nil, server_connection_id: nil, service_id: nil) ⇒ `CommandStarted`

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

创建新事件。

例子：

创建事件。

参数：

command_name ( string ) —

命令的名称。
database_name ( string ) —

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

服务器解决。
request_id ( Integer ) —

请求ID。
operation_id ( Integer ) —

操作 ID。
命令 ( BSON::Document ) —

命令参数。
service_id （对象） （默认为： nil ） —

服务 ID（如果有）。

由于：

2.1.0

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第85行

def 初始化(command_name, database_name, 地址, request_id,
  operation_id, 命令, socket_object_id: nil, connection_id: nil,
  connection_Generation: nil, 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
  @sensitive = 敏感？(
    command_name: @command_name,
    文档: 命令
  )
  @command = redacted(command_name, 命令)
  @socket_object_id = socket_object_id
  @connection_id = connection_id
  @connection_Generation = connection_Generation
  @server_connection_id = server_connection_id
end

实例属性详细信息

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

返回地址服务器地址。

( Server::Address ) —

解决服务器解决。

由于：

2.1.0



29
30
31

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第29行

def 地址
  @address
end

#命令⇒ `BSON::Document` （只读）

返回命令命令参数。

( BSON::Document ) —

命令命令参数。

由于：

2.1.0



32
33
34

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第32行

def 命令
  @command
end

# command_name ⇒ `string` （只读）

返回 command_name 命令的名称。

( string ) —

command_name 命令的名称。

由于：

2.1.0



35
36
37

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第35行

def command_name
  @command_name
end

# connection_Generation ⇒`对象`（只读）

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

由于：

2.1.0



55
56
57

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第55行

def connection_Generation
  @connection_Generation
end

# connection_id ⇒`整数`（只读）

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

返回发送命令所使用的连接的ID 。

( Integer ) —

发送命令的连接的ID 。

由于：

2.1.0



61
62
63

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第61行

def connection_id
  @connection_id
end

# database_name ⇒ `string` （只读）

返回 database_name database_name 的名称。

( string ) —

database_name database_name 的名称。

由于：

2.1.0



38
39
40

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第38行

def database_name
  @database_name
end

# operation_id ⇒`整数`（只读）

返回 operation_id 操作 ID。

( Integer ) —

operation_id 操作 ID。

由于：

2.1.0



41
42
43

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第41行

def operation_id
  @operation_id
end

# request_id ⇒`整数`（只读）

返回 request_id请求ID。

( Integer ) —

request_id请求ID。

由于：

2.1.0



44
45
46

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第44行

def request_id
  @request_id
end

#sensitive ⇒ `true | false` （只读）

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

返回事件是否包含敏感数据。

( true | false ) —

事件是否包含敏感数据。

由于：

2.1.0



69
70
71

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第69行

def 敏感
  @sensitive
end

# server_connection_id ⇒`整数`（只读）

返回 server_connection_id 服务器连接 ID。

( Integer ) —

server_connection_id服务器连接 ID。

由于：

2.1.0



64
65
66

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第64行

def server_connection_id
  @server_connection_id
end

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

返回服务 ID（如果有）。

( nil | Object ) —

服务 ID（如果有）。

由于：

2.1.0



47
48
49

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第47行

def service_id
  @service_id
end

# socket_object_id ⇒`对象`（只读）

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

用于此命令的套接字对象的 object_id。

由于：

2.1.0



52
53
54

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第52行

def socket_object_id
  @socket_object_id
end

类方法详细信息

。 generate (解决, operation_id, payload, socket_object_id: nil, connection_id: nil, connection_Generation: nil, server_connection_id: nil, service_id: nil) ⇒ `CommandStarted`

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

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

例子：

创建事件。

CommandStarted.generate(address, 1, payload)

参数：

地址 ( Server::Address ) —

服务器解决。
operation_id ( Integer ) —

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

消息有效负载。
service_id （对象） （默认为： nil ） —

服务 ID（如果有）。

( CommandStarted ) —

事件。

由于：

2.1.0

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第150行

def self.生成(地址, operation_id, 有效负载,
  socket_object_id: nil, connection_id: nil, connection_Generation: nil,
  server_connection_id: nil, service_id: nil
)
  new(
    有效负载[:command_name],
    有效负载[:database_name],
    地址,
    有效负载[:request_id],
    operation_id,
    # 所有 op_msg 有效负载都有一个 $db字段。 传统有效负载不
    # 有一个 $db字段。 在发布命令时模拟 op_msg
    # 传统服务器的监控事件，将 $db 添加到有效负载中，
    # 复制数据库名称。 请注意，数据库名称也是
    # 可用作命令启动事件的顶级属性。
    有效负载[:command].合并(merge)(' $db ' => 有效负载[:database_name]),
    socket_object_id: socket_object_id,
    connection_id: connection_id,
    connection_Generation: connection_Generation,
    server_connection_id: server_connection_id,
    service_id: service_id,
  )
end

实例方法详细信息

#检查⇒ `string`

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

( string ) —

事件摘要的string 。

由于：

2.6.0



179
180
181

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第179行

def 检查
  " #<{ #{ self . class } #{ database_name } . #{ command_name } command= #{ command } > "
end

#摘要⇒ `string`

注意：

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

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

( string ) —

事件摘要的string 。

由于：

2.1.0



114
115
116

# File ' 构建/ruby-driver-v2.19/lib/ mongo / 监控/ 事件/command_started.rb', 第114行

def 总结
  " #< #{简短类名}解决= #{解决} #{ database_name } . #{ command_name } command= #{ command_summary } > "
end

类：Mongo::Monitoring::Event::CommandStarted

Overview

常量摘要

Secure中包含的常量

实例属性摘要折叠

类方法摘要折叠

实例方法摘要折叠

Secure中包含的方法

构造函数详情

#initialize (command_name, database_name, 解决, request_id, operation_id, command, socket_object_id: nil, connection_id: nil, connection_Generation: nil, server_connection_id: nil, service_id: nil) ⇒ CommandStarted

实例属性详细信息

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

#命令⇒ BSON::Document （只读）

# command_name ⇒ string （只读）

# connection_Generation ⇒对象（只读）

# connection_id ⇒整数（只读）

# database_name ⇒ string （只读）

# operation_id ⇒整数（只读）

# request_id ⇒整数（只读）

#sensitive ⇒ true | false （只读）

# server_connection_id ⇒整数（只读）

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

# socket_object_id ⇒对象（只读）

类方法详细信息

。 generate (解决, operation_id, payload, socket_object_id: nil, connection_id: nil, connection_Generation: nil, server_connection_id: nil, service_id: nil) ⇒ CommandStarted

实例方法详细信息

#检查⇒ string

#摘要⇒ string

#initialize (command_name, database_name, 解决, request_id, operation_id, command, socket_object_id: nil, connection_id: nil, connection_Generation: nil, server_connection_id: nil, service_id: nil) ⇒ `CommandStarted`

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

#命令⇒ `BSON::Document` （只读）

# command_name ⇒ `string` （只读）

# connection_Generation ⇒`对象`（只读）

# connection_id ⇒`整数`（只读）

# database_name ⇒ `string` （只读）

# operation_id ⇒`整数`（只读）

# request_id ⇒`整数`（只读）

#sensitive ⇒ `true | false` （只读）

# server_connection_id ⇒`整数`（只读）

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

# socket_object_id ⇒`对象`（只读）

。 generate (解决, operation_id, payload, socket_object_id: nil, connection_id: nil, connection_Generation: nil, server_connection_id: nil, service_id: nil) ⇒ `CommandStarted`

#检查⇒ `string`

#摘要⇒ `string`