過負荷
エラーを通知し、オプションのカスタム属性とともに、New Relicに報告します。
NewRelic.Api.Agent.NewRelic.NoticeError(Exception $exception);NewRelic.Api.Agent.NewRelic.NoticeError(Exception $exception, IDictionary<TKey, TValue> $attributes);NewRelic.Api.Agent.NewRelic.NoticeError(string $error_message, IDictionary<TKey, TValue> $attributes);NewRelic.Api.Agent.NewRelic.NoticeError(string $error_message, IDictionary<TKey, TValue> $attributes, bool $is_expected);
要件
このAPI呼び出しは、次のものと互換性があります。
- すべてのエージェントバージョン
- すべてのアプリタイプ
説明
エラーに気づき、オプションのカスタム属性とともにNewRelicに報告してください。トランザクションごとに、エージェントはNoticeError()
への最初の呼び出しからの例外と属性のみを保持します。実際の例外を渡すか、文字列を渡して任意のエラーメッセージをキャプチャできます。
このメソッドがトランザクション内で呼び出された場合、エージェントは親トランザクション内で例外を報告します。トランザクションの外部で呼び出された場合、エージェントはエラートレースを作成し、NewRelicUIでエラーをNewRelic.Api.Agent.NoticeError
API呼び出しとして分類します。トランザクションの外部で呼び出された場合、 NoticeError()
呼び出しはアプリケーションのエラー率に影響しません。
エージェントは、トレースされたエラーにのみ属性を追加します。 NewRelicには送信されません。詳細については、 AddCustomAttribute()
を参照してください。
このAPIで報告されたエラーは、エージェント構成によって無視されるように構成された404
などのHTTPステータスコードをもたらすトランザクション内で報告された場合でも、NewRelicに送信されます。詳細については、APMでのエラーの管理に関するドキュメントを参照してください。
この呼び出しの使用方法の例については、以下のセクションを確認してください。
NoticeError(例外)
NewRelic.Api.Agent.NewRelic.NoticeError(Exception $exception)
パラメータ | 説明 |
---|---|
例外 | 必須。インストルメントする |
NoticeError(例外、IDictionary)
NewRelic.Api.Agent.NewRelic.NoticeError(Exception $exception, IDictionary<TKey, TValue> $attributes)
パラメータ | 説明 |
---|---|
例外 | 必須。インストルメントする |
IDictionary <TKey、TValue> | エラーメッセージに注釈を付けるには、属性のキーと値のペアを指定します。 |
NoticeError(String、IDictionary)
NewRelic.Api.Agent.NewRelic.NoticeError(string $error_message, IDictionary<TKey, TValue> $attributes)
パラメータ | 説明 |
---|---|
ストリング | 必須。例外であるかのようにNewRelicに報告する文字列を指定します。このメソッドは、エラーイベントとエラートレースの両方を作成します。エラーイベントでは最初の1023文字のみが保持され、エラートレースではメッセージ全体が保持されます。 |
IDictionary <TKey、TValue> | 必須(nullの場合もあります)。エラーメッセージに注釈を付けるには、属性のキーと値のペアを指定します。 |
NoticeError(String、IDictionary、bool)
NewRelic.Api.Agent.NewRelic.NoticeError(string $error_message, IDictionary<TKey, TValue> $attributes, bool $is_expected)
パラメータ | 説明 |
---|---|
ストリング | 必須。例外であるかのようにNewRelicに報告する文字列を指定します。このメソッドは、エラーイベントとエラートレースの両方を作成します。エラーイベントでは最初の1023文字のみが保持され、エラートレースではメッセージ全体が保持されます。 |
IDictionary <TKey、TValue> | 必須(nullの場合もあります)。エラーメッセージに注釈を付けるには、属性のキーと値のペアを指定します。 |
bool | Apdexのスコアやエラーレートに影響を与えないように、エラーを予想通りにマークします。 |
カスタム属性を持たない例外を渡す
try{ string ImNotABool = "43"; bool.Parse(ImNotABool);}catch (Exception ex){ NewRelic.Api.Agent.NewRelic.NoticeError(ex);}
カスタム属性を持つ例外を渡す
try{ string ImNotABool = "43"; bool.Parse(ImNotABool);}catch (Exception ex){ var errorAttributes = new Dictionary<string, string>() {{"foo", "bar"},{"baz", "luhr"}}; NewRelic.Api.Agent.NewRelic.NoticeError(ex, errorAttributes);}
カスタム属性を持つエラーメッセージ文字列を渡す
try{ string ImNotABool = "43"; bool.Parse(ImNotABool);}catch (Exception ex){ var errorAttributes = new Dictionary<string, string>{{"foo", "bar"},{"baz", "luhr"}}; NewRelic.Api.Agent.NewRelic.NoticeError("String error message", errorAttributes);}
カスタム属性のないエラーメッセージ文字列を渡す
try{ string ImNotABool = "43"; bool.Parse(ImNotABool);}catch (Exception ex){ NewRelic.Api.Agent.NewRelic.NoticeError("String error message", null);}
エラーメッセージ文字列を渡し、期待通りのマークを付ける
try{ string ImNotABool = "43"; bool.Parse(ImNotABool);}catch (Exception ex){ NewRelic.Api.Agent.NewRelic.NoticeError("String error message", null, true);}