NoticeError (.NET agent API) | New Relic Documentation

Syntax

NewRelic.Api.Agent.NewRelic.NoticeError(exception $exception[, IDictionary $attributes])
NewRelic.Api.Agent.NewRelic.NoticeError(string $error_message, IDictionary $attributes)
NewRelic.Api.Agent.NewRelic.NoticeError(string $error_message, IDictionary $attributes, bool $is_expected)

Notice an error and report to New Relic, along with optional custom attributes.

Requirements

Compatible with all agent versions.

Compatible with all app types.

Description

Notice an error and report it to New Relic along with optional custom attributes. For each transaction, the agent only retains the exception and attributes from the first call to NoticeError(). You can pass an actual exception, or pass a string to capture an arbitrary error message.

If this method is invoked within a transaction, the agent reports the exception within the parent transaction. If it is invoked outside of a transaction, the agent creates an error trace and categorizes the error in the New Relic UI as a NewRelic.Api.Agent.NoticeError API call. If invoked outside of a transaction, the NoticeError() call will not contribute to the error rate of an application.

The agent adds the attributes only to the traced error; it does not send them to New Relic. For more information, see AddCustomAttribute().

Errors reported with this API are still sent to New Relic when they are reported within a transaction that results in an HTTP status code, such as a 404, that is configured to be ignored by agent configuration. For more information, see our documentation about managing errors in APM.

Parameters

Parameter	Description
`NewRelic.Api.Agent.NewRelic.NoticeError(exception $exception[, IDictionary $attributes])`
`$exception` exception	Required. The exception you want to instrument. Only the first 10,000 characters from the stack trace are retained.
`$attributes` IDictionary	Optional. Specify key/value pairs of attributes to annotate the error message.
`NewRelic.Api.Agent.NewRelic.NoticeError(string $error_message, IDictionary $attributes)`
`$error_message` string	Required. Specify a string to report to New Relic as though it's an exception. Only the first 1,000 characters are retained.
`$attributes` IDictionary	Required (can be null). Specify key/value pairs of attributes to annotate the error message. To send no attributes, pass `null`.
`NewRelic.Api.Agent.NewRelic.NoticeError(string $error_message, IDictionary $attributes, bool $is_expected)`
`$error_message` string	Required. Specify a string to report to New Relic as though it's an exception. Only the first 1,000 characters are retained.
`$attributes` IDictionary	Required (can be null). Specify key/value pairs of attributes to annotate the error message. To send no attributes, pass `null`.
`$is_expected` bool	Mark error as expected so that it won't affect Apdex score and error rate.

Examples

Pass an exception without custom attributes

try
{
  string ImNotABool = "43";
  bool.Parse(ImNotABool);
}
catch (Exception ex)
{
  NewRelic.Api.Agent.NewRelic.NoticeError(ex);
}

Pass an exception with custom attributes

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);
}

Pass an error message string with custom attributes

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);
}

Pass an error message string without custom attributes

try
{
  string ImNotABool = "43";
  bool.Parse(ImNotABool);
}
catch (Exception ex)
{
  NewRelic.Api.Agent.NewRelic.NoticeError("String error message", null);
}

Pass an error message string and mark it as expected

try
{
  string ImNotABool = "43";
  bool.Parse(ImNotABool);
}
catch (Exception ex)
{
  NewRelic.Api.Agent.NewRelic.NoticeError("String error message", null, true);
}