Blacklist

You can use the blacklist feature on the APM settings page to blacklist a namespace, class name or method.

This feature is useful because it helps to filter out unwanted data from captured traces, e.g. short running but frequently called helper functions which are already performant, but clog up captured trace data due to being regularly called.

There is no limit to the blacklist - you can add as many as you’d like.

View blacklist items


Adding blacklist items

Blacklist items must be added in the following format: Namespace.Class::Method. The blacklist entry is applied using a starts with match and should not include any wildcard characters.

For example, given a method in your code with a signature of Raygun.Utilities.Foo(), the following rules will match:

  • Raygun.
  • Raygun.Utilities
  • Raygun.Utilities::Foo

Given the method Raygun.Utilities.Bar() and the same rules from above, only the first two rules would match as the method signature starts with a matching value.

note: Once you've added items to the blacklist it can take up to 10 minutes for them to be updated on your servers and will only take effect when the application being profiled is next restarted.


Live blacklist

Live blacklisting is a feature that was introduced in version 1.0.1087 and is enabled by default.

This feature analyzes traces from your application for frequently called insignificant methods and adds them to a separate live blacklist stored on the server. Items added to this blacklist are applied immediately and don’t require the application to be restarted.

To view the list of automatically blacklisted methods, in Windows, open the file %ProgramData%\Raygun\\AgentSettings\agent-configuration.json.

This file contains a section for each enabled application and within each application section is an array called LiveBlacklists. If you want a specific method to be excluded from blacklisting then locate the entry in this list and change the “Enabled” value to false. Save the file when done and restart the relevant application. We don’t recommend you remove items from this list as they may be automatically added back in by the agent process.

"LiveBlacklists":
[
  {
    "ClassMethodName": "Raygun.Common.Base36::Encode",
    "Enabled": true
  }
]

Configuration settings for live blacklisting

Automatic blacklisting can be disabled completely or adjusted using configuration settings in the Agent configuration file located at %ProgramFiles(x86)%\Raygun\RaygunAgent\RaygunAgent.exe.config.

Add a new element to the <appSettings> section like <add key="" value=""/>. The following configuration keys can be added to control the live blacklisting feature.

  • LiveBlacklistingEnabled - Set to false to disable the feature (Defaults to true).
  • QuickMethodDurationMicroseconds - A value in microseconds to consider as an insignificant method eligible for live blacklisting. (Defaults to 100)
  • QuickMethodCounter - The minimum number of times a method must be called in a single trace to be considered for live blacklisting. (Defaults to 10)

By default, the feature is enabled and a method must be called at least 10 times where each call is less than 100 microseconds in duration.