Recent Changes - Search:

JSnapshot User Guide

Command line options

Usage:

-agentpath:<path to agent library>=option1=value1,option2=value2

Option values can be percent-encoded (also known as URL encoding) if necessary.

List of supported options:

helpPrints this info
system_idPrints unique System ID assigned to the computer. The System ID is needed to get product license key.
license_file=<path to License Key file>Specifies license key file to use with the agent. If license key file is not provided then agent runs as a free version with limited functionality.
options_file=<path to options file>Loads options from file. File contains each option on a new line. Option format is option=value. Use '#' to begin comment line. Can be used multiple times.
output_folder=<path to output folder>Saves all exception snapshots into given output folder. can't contain a trailing backslash.
Default location is current user home (java.lang.System property user.home).
output_size=<size in MB>Stop saving exception snapshots if size of snapshot file exceeds given size in MB. Valid value must be > 0 or = -1 for unlimited size.
Default value is -1 (unlimited).
port=<port number>Port number to be used by agent. Valid value must be >= 0, 0 to use any available port number.
Default value is 0 (any available).
record=<true or false>Start recording exception snapshots when applications starts.
Default value is true.
max_object_depth=<depth>Max depth of object fields to save. Valid value must be > 0 or = -1 for unlimited object depth.
Default value is 4.
max_stack_frames=<frames count>Max number of stack frames to save. Valid value must be > 0 and <= 1024.
Default value is 1024.
filter_java=<true or false>Filter out exceptions that are caught in class defined in java.* package.
Default value is true.
filter_sun=<true or false>Filter out exceptions that are caught in class defined in sun.* package.
Default value is true.
filter_catch=<REGEX>Filter out exceptions caught at location (class name, method name and line number: com.package.Class.method():123) which matches given POSIX regular expression. Can be used multiple times.
filter_throw=<REGEX>Filter out exceptions thrown from location (class name, method name and line number: com.package.Class.method():123) which matches given POSIX regular expression. Can be used multiple times.
filter_exception_class=<REGEX>Filter out exceptions which full class name matches given POSIX regular expression. Can be used multiple times.
filter_exception_message=<REGEX>Filter out exceptions which message matches given POSIX regular expression. Can be used multiple times.
NOTE: You can create compoiste filter from multiple filter_catch, filter_throw, filter_exception_class and filter_exception_message using '&' character.
For example: filter_catch=FILTER_A&filter_throw=FILTER_B
group_similar_exceptions=<true or false>Group similar exceptions. Exceptions are similar if they were thrown from the same location, were caught at the same location and have the same exception class. Groupping means that only the first similar exception image is saved. For all other similar exceptions it saves message and timestamp only.
Default value is true.
group_similar_stack_frames=<frames count>Adds additional criteria to similarity of exceptions. Similar exceptions must have <frames count> equal top stack frames. Valid value must be >= 0 and <= 1024. 0 value disables this criteria.
Default value is 5.
group_similar_threshold_seconds=<threshold>Adds additional criteria to similarity of exceptions. Time interval between similar exceptions must be less than <threshold> seconds. Otherwise exceptions are not similar. Valid value must be > 0 and <= 86400.
Default value is 60.
Edit - History - Print - Recent Changes - Search
Page last modified on July 28, 2011, at 06:57 PM