クラス: Mongo::Monitoring::Event::CommandStarted

継承:
Event::Base
  • オブジェクト
すべて表示
次のことが含まれます。
セキュア
定義:
build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb

Overview

コマンド操作が開始されたときに起動されるイベント。

以来

  • 2.1.0

定数の概要

Secureから含まれる定数

Secure::REDACTED_COMMANDS

インスタンス属性の概要を折りたたむ

クラスメソッドの概要を折りたたむ

インスタンス メソッドの概要を折りたたむ

Secureに含まれるメソッド

#compression_allowed? 、 # 編集済み、 # 区別

コンストラクターの詳細

初期化（コマンド_名前, データベース_名前, アドレス, リクエスト_id, 操作_id, コマンド、ソケット_オブジェクト_id: nil、接続_id: nil、接続_生成: nil、 server_ connection_id: nil、service_id: nil） = コマンドスタート

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

新しいイベントを作成します。

例:

イベントを作成します。

パラメーター:

  • command_name ( string ) —

    コマンドの名前。

  • database_name ( string ) —

    database_name の名前。

  • address （ Server ::Address ） —

    サーバーのアドレス。

  • request_id (整数) —

    リクエスト ID。

  • operation_id (整数) —

    操作 ID。

  • コマンド （ BSON::Document ） —

    コマンド引数。

  • service_id （オブジェクト） （デフォルトはnil ） —

    サービス ID（存在する場合）。

以来

  • 2.1.0



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行85

デフォルト 初期化(command_name, database_name, address, request_id,
  operation_id, コマンド, socket_object_id: nil, connection_id: nil,
  connection_生成: nil, 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
  @区別 = 区別するかどうか(
    command_name: @command_name,
    ドキュメント: コマンド
  )
  @command = 編集済み(command_name, コマンド)
  @socket_object_id = socket_object_id
  @ connection_id = connection_id
  @ connection_生成 = connection_生成
  @server_ connection_id = server_ connection_id
end

インスタンス属性の詳細

#アドレス→ Server::Address （読み取り専用）

アドレス サーバーのアドレスを返します。

次の値を返します。

  • （ Server ::Address ） —

    address サーバーのアドレスを指定します。

以来

  • 2.1.0



29
30
31
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行29

デフォルト address
  @address
end

#コマンド= BSON ::Document (読み取り専用)

コマンド コマンド引数を返します。

次の値を返します。

  • （ BSON::Document ） —

    command コマンド引数。

以来

  • 2.1.0



32
33
34
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行32

デフォルト コマンド
  @command
end

# command_name = string （読み取り専用）

コマンド_名前 コマンドの名前を返します。

次の値を返します。

  • ( string ) —

    command_name コマンドの名前。

以来

  • 2.1.0



35
36
37
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行35

デフォルト command_name
  @command_name
end

# connection_generation =オブジェクト（読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

以来

  • 2.1.0



55
56
57
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行55

デフォルト connection_生成
  @ connection_生成
end

# connection_id ～整数（読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

コマンドが送信された接続の ID を返します。

次の値を返します。

  • (整数) —

    コマンドが送信される接続の ID。

以来

  • 2.1.0



61
62
63
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行61

デフォルト connection_id
  @ connection_id
end

# database_name = string （読み取り専用）

Database_name データベース_name の名前を返します。

次の値を返します。

  • ( string ) —

    database_name データベース_name の名前。

以来

  • 2.1.0



38
39
40
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行38

デフォルト database_name
  @database_name
end

# operation_id =整数（読み取り専用）

操作_id 操作 ID を返します。

次の値を返します。

  • (整数) —

    operation_id 操作 ID。

以来

  • 2.1.0



41
42
43
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行41

デフォルト operation_id
  @operation_id
end

# request_id =整数（読み取り専用）

request_id リクエスト ID を返します。

次の値を返します。

  • (整数) —

    request_id リクエスト ID。

以来

  • 2.1.0



44
45
46
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行44

デフォルト request_id
  @request_id
end

では、 の値を区別します。 false （読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

イベントに機密データが含まれているかどうかを返します。

次の値を返します。

  • （ true | false ） —

    イベントに機密データが含まれているかどうか。

以来

  • 2.1.0



69
70
71
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行69

デフォルト 機密
  @区別
end

# server_ connection_id =整数（読み取り専用）

Server_ connection_id サーバー接続 ID を返します。

次の値を返します。

  • (整数) —

    server_ connection_id サーバー接続 ID。

以来

  • 2.1.0



64
65
66
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行64

デフォルト server_ connection_id
  @server_ connection_id
end

# service_id = nil |オブジェクト（読み取り専用）

サービス ID（存在する場合）を返します。

次の値を返します。

  • ( nil | Object ) —

    サービス ID（存在する場合）。

以来

  • 2.1.0



47
48
49
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行47

デフォルト service_id
  @service_id
end

# socket_object_id =オブジェクト（読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

このコマンドに使用されるソケット オブジェクトの object_id。

以来

  • 2.1.0



52
53
54
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行52

デフォルト socket_object_id
  @socket_object_id
end

クラスメソッドの詳細

。 generate （ address, operation_id, ペイロード, socket_object_id: nil, connection_id: nil, connection_生成: nil, server_ connection_id: nil, service_id: nil) = コマンド開始

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ワイヤプロトコルのメッセージペイロードからイベントを作成します。

例:

イベントを作成します。

CommandStarted.generate(address, 1, payload)

パラメーター:

  • address （ Server ::Address ） —

    サーバーのアドレス。

  • operation_id (整数) —

    操作 ID。

  • ペイロード （ハッシュ） —

    メッセージのペイロード。

  • service_id （オブジェクト） （デフォルトはnil ） —

    サービス ID（存在する場合）。

次の値を返します。

以来

  • 2.1.0



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行150

デフォルト 自己.生成(address, operation_id, ペイロード,
  socket_object_id: nil, connection_id: nil, connection_生成: nil,
  server_ connection_id: nil, service_id: nil
)
  新着情報(
    ペイロード[:command_name],
    ペイロード[:database_name],
    address,
    ペイロード[:request_id],
    operation_id,
    : すべての op_msg ペイロードには $db フィールドがあります。 レガシー ペイロードは
    $db フィールドがあります コマンドの公開時に op_msg をエミュレートする方法
    レガシーサーバーの#モニタリング イベントは、ペイロードに $db を追加し、
    # データベース名をコピーします。 データベース名も
    は、 コマンドが開始された イベントで最上位属性として使用できます。
    ペイロード[: コマンド].merge('$db' => ペイロード[:database_name]),
    socket_object_id: socket_object_id,
    connection_id: connection_id,
    connection_生成: connection_生成,
    server_ connection_id: server_ connection_id,
    service_id: service_id,
  )
end

インスタンス メソッドの詳細

詳しくは、 を 検査しstring ます

イベントの簡潔でかつ有用な概要を返します。

次の値を返します。

  • ( string ) —

    イベントの string の概要。

以来

  • 2.6.0



179
180
181
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行179

デフォルト 検査する
  " #{ #{自分のクラス} #{ database_name } 。 #{ command_name } command= #{ command } > "
end

#のサマリー= string

注：

この方法は実験的なものであり、変更される可能性があります。

イベントの簡潔でかつ有用な概要を返します。

次の値を返します。

  • ( string ) —

    イベントの string の概要。

以来

  • 2.1.0



114
115
116
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_started.rb', 行114

デフォルト 概要
  " # は、 { hour_Class_name } address = #{ {dress_name } } #{ database_name } 。 "
end