クラス: Mongo::Monitoring::Event::CommandSucceeded

継承:
Event::Base
  • オブジェクト
すべて表示
次のことが含まれます。
セキュア
定義:
lib/mongo/monitoring/ イベント/command_succeeded.rb

Overview

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

以来

  • 2.1.0

定数の概要

Secureから含まれる定数

Secure::REDACTED_COMMANDS

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

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

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

Secureに含まれるメソッド

#compression_allowed?# 編集済み# 区別

コンストラクターの詳細

#初期化(コマンド_名前, データベース_名前, アドレス, リクエスト_id, 操作_id, 応答, duration, duration: 開始イベント:, サーバー_接続_id: nil, service_id: nil) = コマンドSucceeded

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

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

例:

イベントを作成します。

パラメーター:

  • command_name ( string )

    コマンドの名前。

  • database_name ( string )

    データベース名。

  • address Server ::Address

    サーバーのアドレス。

  • request_id (整数)

    リクエスト ID。

  • operation_id (整数)

    操作 ID。

  • 応答 BSON::Document

    コマンドの応答。

  • duration 浮動小数

    コマンドにかかる時間(秒単位)。

  • start_event モニタリング::Event::CommandStarted

    対応する開始されたイベント。

  • service_id オブジェクト (デフォルトはnil

    サービス ID(存在する場合)。

以来

  • 2.1.0



76
77
78
79
80
81
82
83
84
85
86
87
88
89
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 76

デフォルト 初期化(command_name, database_name, address, request_id,
               operation_id, 応答, duration, start_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
  @started_event = start_event
  @reply = 編集済み(command_name, 応答)
  @dration = duration
  @server_ connection_id = server_ connection_id
end

インスタンス属性の詳細

#アドレスServer::Address (読み取り専用)

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

次の値を返します。

  • Server ::Address

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

以来

  • 2.1.0



27
28
29
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 27

デフォルト address
  @address
end

# command_name = string (読み取り専用)

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

次の値を返します。

  • ( string )

    command_name コマンドの名前。

以来

  • 2.1.0



30
31
32
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 30

デフォルト command_name
  @command_name
end

# database_name = string (読み取り専用)

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

次の値を返します。

  • ( string )

    database_name データベースの名前。

以来

  • 2.1.0



36
37
38
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 36

デフォルト database_name
  @database_name
end

duration読み取り専用)

duration イベントの期間を返します。

次の値を返します。

  • 浮動小数

    duration イベントの期間。

以来

  • 2.1.0



39
40
41
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 39

デフォルト duration
  @dration
end

# operation_id =整数(読み取り専用)

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

次の値を返します。

  • (整数)

    operation_id 操作 ID。

以来

  • 2.1.0



42
43
44
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 42

デフォルト operation_id
  @operation_id
end

応答= BSON::Document (読み取り専用)

応答 コマンドの応答を返します。

次の値を返します。

  • BSON::Document

    response コマンドの応答。

以来

  • 2.1.0



33
34
35
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 33

デフォルト 応答
  @reply
end

# request_id =整数(読み取り専用)

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

次の値を返します。

  • (整数)

    request_id リクエスト ID。

以来

  • 2.1.0



45
46
47
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 45

デフォルト request_id
  @request_id
end

# server_ connection_id =整数(読み取り専用)

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

次の値を返します。

  • (整数)

    server_ connection_id サーバー接続 ID。

以来

  • 2.1.0



48
49
50
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 48

デフォルト server_ connection_id
  @server_ connection_id
end

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

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

次の値を返します。

  • ( nil | Object )

    サービス ID(存在する場合)。

以来

  • 2.1.0



51
52
53
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 51

デフォルト service_id
  @service_id
end

# Started_event ~監視::Event::CommandStarted (読み取り専用)

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

対応する開始されたイベントを返します。

次の値を返します。

以来

  • 2.1.0



57
58
59
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 57

デフォルト start_event
  @started_event
end

クラスメソッドの詳細

generate (address, operation_id, command_ payload, replay_ payload, duration, starting_event:, server_ connection_id: nil, service_id: nil) = コマンド完了

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

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

例:

イベントを作成します。

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

パラメーター:

  • address Server ::Address

    サーバーのアドレス。

  • operation_id (整数)

    操作 ID。

  • command_ payload ハッシュ

    コマンド メッセージのペイロード。

  • response_ payload ハッシュ

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

  • duration 浮動小数

    コマンドの継続時間(秒単位)。

  • start_event モニタリング::Event::CommandStarted

    対応する開始されたイベント。

  • service_id オブジェクト (デフォルトはnil

    サービス ID(存在する場合)。

次の値を返します。

  • コマンドが完了しました )

    イベント。

以来

  • 2.1.0



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 120

デフォルト 自己.生成(address, operation_id, command_ payload,
                  response_ payload, duration, start_event:, server_ connection_id: nil,
                  service_id: nil)
  新着情報(
    command_ payload[:command_name],
    command_ payload[:database_name],
    address,
    command_ payload[:request_id],
    operation_id,
    generate_reply(command_ payload, response_ payload),
    duration,
    start_event: start_event,
    server_ connection_id: server_ connection_id,
    service_id: service_id
  )
end

generate_reply(command_ payload、 replay_ payload) = オブジェクト

以来

  • 2.1.0



137
138
139
140
141
142
143
144
145
146
147
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 137

デフォルト 自己.generate_reply(command_ payload, response_ payload)
  場合 response_ payload
    応答 = response_ payload[:return]
    場合 (cursor = 応答[:cursor]) & & !cursor.key?(コレクション::ns)
      cursor.mergeします。(コレクション::ns => namespace(command_ payload))
    end
    応答
  else
    BSON::ドキュメント.新着情報(操作::結果::OK => 1)
  end
end

名前空間(ペイロード) = オブジェクト

以来

  • 2.1.0



149
150
151
152
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 149

デフォルト 自己.namespace(ペイロード)
  コマンド = ペイロード[: コマンド]
  " #{ payload [ :database_name ] } . #{ コマンド [ :コレクション ] || コマンド .   最初の } "
end

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

#のサマリー= string

注:

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

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

次の値を返します。

  • ( string )

    イベントの string の概要。

以来

  • 2.1.0



98
99
100
# ファイル 'lib/mongo/monitoring/ イベント/command_succeeded.rb' 行 98

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