クラス: Mongo::Monitoring::Event::CommandFailed

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

Overview

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

以来

  • 2.1.0

定数の概要

Secureから含まれる定数

Secure::REDACTED_COMMANDS

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

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

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

Secureに含まれるメソッド

#compression_allowed?# 編集済み# 区別

コンストラクターの詳細

初期化(コマンド_名前, データベース_名前, アドレス, リクエスト_id, 操作_id, メッセージ, 障害、期間、開始_イベント:, サーバー_接続_id : nil, service_id: nil) = コマンド失敗

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

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

例:

イベントを作成します。

パラメーター:

  • command_name ( string )

    コマンドの名前。

  • database_name ( string )

    database_name の名前。

  • address Server ::Address

    サーバーのアドレス。

  • request_id (整数)

    リクエスト ID。

  • operation_id (整数)

    操作 ID。

  • メッセージ ( string )

    エラーメッセージ。

  • 失敗 BSON::Document

    エラードキュメント(存在する場合)。

  • duration 浮動小数

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

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

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

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

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

以来

  • 2.1.0



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

デフォルト 初期化(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
  @message = メッセージ
  @started_event = start_event
  @failure = 編集済み(command_name, 失敗)
  @dration = duration
  @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_failed.rb', 行29

デフォルト address
  @address
end

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

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

次の値を返します。

  • ( string )

    command_name コマンドの名前。

以来

  • 2.1.0



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

デフォルト command_name
  @command_name
end

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

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

次の値を返します。

  • ( string )

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

以来

  • 2.1.0



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

デフォルト database_name
  @database_name
end

duration読み取り専用)

duration コマンドの保存期間を秒単位で返します。

次の値を返します。

  • 浮動小数

    duration コマンドの期間(秒単位)。

以来

  • 2.1.0



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

デフォルト duration
  @dration
end

#障害= BSON::Document (読み取り専用)

失敗したエラー ドキュメント(存在する場合)を返します。 これは、MongoDB サーバーによって通信されたエラーにのみ入力されます。 ネットワーク エラーが発生した場合など、他の状況では、この属性は nil になる場合があります。

次の値を返します。

  • BSON::Document

    fail エラードキュメント(存在する場合)。 これは、MongoDB サーバーによって通信されたエラーにのみ入力されます。 ネットワーク エラーが発生した場合など、他の状況では、この属性は nil になる場合があります。

以来

  • 2.1.0



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

デフォルト 失敗
  @failure
end

#メッセージ= string (読み取り専用)

メッセージ エラーメッセージを返します。 エラードキュメントと違い、エラーメッセージは常に存在する必要があります。

次の値を返します。

  • ( string )

    メッセージ エラー メッセージ。 エラードキュメントと違い、エラーメッセージは常に存在する必要があります。

以来

  • 2.1.0



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

デフォルト メッセージ
  @message
end

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

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

次の値を返します。

  • (整数)

    operation_id 操作 ID。

以来

  • 2.1.0



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

デフォルト operation_id
  @operation_id
end

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

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

次の値を返します。

  • (整数)

    request_id リクエスト ID。

以来

  • 2.1.0



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

デフォルト request_id
  @request_id
end

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

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

次の値を返します。

  • (整数)

    server_ connection_id サーバー接続 ID。

以来

  • 2.1.0



57
58
59
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 行57

デフォルト server_ connection_id
  @server_ connection_id
end

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

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

次の値を返します。

  • ( nil | Object )

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

以来

  • 2.1.0



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

デフォルト service_id
  @service_id
end

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

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

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

次の値を返します。

以来

  • 2.1.0



66
67
68
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 行66

デフォルト start_event
  @started_event
end

クラスメソッドの詳細

生成(アドレス、操作_id、ペイロード、メッセージ、障害、期間、開始_イベント:, サーバー_接続_id : nil, service_id: nil) = コマンド失敗

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

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

例:

イベントを作成します。

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

パラメーター:

  • address Server ::Address

    サーバーのアドレス。

  • operation_id (整数)

    操作 ID。

  • ペイロード ハッシュ

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

  • メッセージ ( string )

    エラーメッセージ。

  • 失敗 BSON::Document

    エラードキュメント(存在する場合)。

  • duration 浮動小数

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

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

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

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

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

次の値を返します。

以来

  • 2.1.0



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 行132

デフォルト 自己.生成(address, operation_id, ペイロード, メッセージ,
  失敗, duration, start_event:, server_ connection_id: nil,
  service_id: nil
)
  新着情報(
    ペイロード[:command_name],
    ペイロード[:database_name],
    address,
    ペイロード[:request_id],
    operation_id,
    メッセージ,
    失敗,
    duration,
    start_event: start_event,
    server_ connection_id: server_ connection_id,
    service_id: service_id,
  )
end

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

#のサマリー= string

注:

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

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

次の値を返します。

  • ( string )

    イベントの string の概要。

以来

  • 2.1.0



109
110
111
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/monitoring/event/command_failed.rb', 行109

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