Agent startup options

port=<port>

or

port=<min port>-<max port>

Specify the port that the profiler agent listens on for communication with the profiler UI.

By default, the port is chosen automatically: if port 10001 is free, it is used; otherwise, if port 10002 is free, it is used etc. If no port in the range 10001..10010 is free, an arbitrary free port is used.

If port range is specified, profiler will choose first free port in the range.

Specify the profiler agent connectivity option.

• Most security, the default option: listen=localhost opens the profiler agent socket on the IPv4 loopback network interface. The most commonly used IP address on the loopback network is 127.0.0.1. This will disable a direct remote connection to the agent via <host>:<port>. Connection to the profiler agent will be possible via port forwarding e.g. an SSH tunnel.
• Easy access: listen=all opens the profiler agent socket on all network interfaces. A remote connection to the agent will be possible directly via <host>:<port>. Note that access to the port can be additionally restricted with a firewall.
• Advanced: listen=<IP> opens the profiler agent socket on the specified IP address.
• Block all incoming connections: listen=none blocks all incoming agent connections. Option is automatically applied when broker_url is specified.

File with the SSL certificate in the PEM format.

If intermediate certificates should be specified in addition to a primary certificate, they should be specified in the same file in the following order: the primary certificate comes first, then the intermediate certificates.

If the ssl_certificate option is absent, the agent will create self-signed certificate.

File with the secret key in the PEM format.

If the secret key ssl_certificate_key is encrypted, then the first line of the specified password file will be used as a password (passphrase).

Connection broker URL.

Connection broker access token.

Immediately start CPU profiling in the sampling mode. Note that you do not have to profile CPU right from the start; instead, in many cases it's better to start or stop measuring at a later moment - from the UI or by using the Profiler API.

Immediately start CPU profiling in the tracing mode. Note that you do not have to profile CPU right from the start; instead, in many cases it's better to start or stop measuring at a later moment - from the UI or by using the Profiler API.

Specify a custom location of the CPU sampling settings configuration file.

If this option is not specified, the settings are read from <user home>/.ynp/sampling_2022.txt, where user home corresponds to the account under which a profiled application is launched.

Specify a custom location of the CPU tracing settings configuration file.

If this option is not specified, the settings are read from <user home>/.ynp/tracing_2022.txt, where user home corresponds to the account under which a profiled application is launched.

Immediately start object allocation profiling, recording each N-th allocation.

This option can be used in combination with alloc_size_limit.

To record only those objects whose size exceeds the threshold set with alloc_size_limit please specify alloc_each=0.

Note that you do not have to record allocations right from the start; instead, you can start or stop profiling later from the profiler UI or using Profiler API.

Immediately start object allocation profiling, recording allocation of all objects with size bigger than or equal to the specified value.

This option can be used in combination with alloc_each.

Note that you do not have to record allocations right from the start; instead, you can start or stop profiling later from the profiler UI or using Profiler API.

Immediately start telemetry collection. This is the default mode.

Do not immediately start telemetry collection that can instead be started later in runtime.

The telemetry and thread profiling results are remembered in a circular buffer in the profiler agent memory. This allows you to connect to a profiled application on demand and discover how the application behaved in the past.

By default, the telemetry buffer is limited to store approximately 1 hour of recent telemetry data.

With the help of the telemetry_limit option you can customize the time period within which the telemetry data is being stored.

Specify how often telemetry and thread profiling information is obtained.

By default, the period is 1 second (1000 milliseconds).

Note that setting smaller period can add overhead.

The threads option regulates the collection of data specific to the threads within a profiled application. In most cases, collecting this information does not result in significant overhead. However, it is sensible to turn it off on production servers to ensure minimal profiling overhead.

• full - The default value. Collect both thread states and stacks.
• states - Collect only thread states.
• off - Do not collect thread states and stacks.

Immediately start the exception profiling. This is the default mode.

Do not immediately start the exception profiling that can instead be started later in runtime.

Fully disable exception profiling and totally eliminate related overhead. The exception profiling will not be available.

Specify custom snapshot directory for the particular profiled application

Specify alternate rule to compose snapshot file names.

Available macros:

• {app_name} - application name
• {date} - snapshot capture date in format 'yyyy-MM-dd'
• {datetime} - snapshot capture date and time in format 'yyyy-MM-dd-HH-mm'
• {pid} - profiled process ID

The default format is {app_name}-{date}.

Characters not allowed in file names, if specified, will be replaced with '-'.

Capture a performance snapshot on profiled application exit.

If this option is not specified, the performance snapshot will be captured on exit if CPU profiling or object allocation profiling is running at that moment.

Specify the file with description of the triggers to be applied from startup.

If this option is not specified, the trigger description is read from <user home>/.ynp/triggers.txt, where user home corresponds to the account under which a profiled application is launched.

By default, that file does not exist, thus no triggers are applied.

Adds a trigger to automatically capture a memory snapshot when process used memory reaches the threshold.

Adds a trigger to periodically capture performance snapshots.

Adds a trigger to periodically capture memory snapshots.

probe_on=<pattern>

probe_off=<pattern>

probe_auto=<pattern>

probe_disable=<pattern>

Control probes on startup. Read more...

options_file=<path to options file>

or

@<path to options file>

Specify a path to the options file with agent startup options. Options from the options file will be used as if they were directly specified in its place, in order they are written in the file.

Example: options_file=profiler-options.txt or @profiler-options.txt.

Specify alternate presentable name of the profiled application used in:

• the profiler UI
• snapshot names
• log file name

If this option is not specified, the application name is automatically chosen based on its executable name.

The default, automatically generated application name can be specified via {default} macro.

For example, to append the host name to the default application name, use app_name={default}-${HOSTNAME} on UNIX and app_name={default}-${COMPUTERNAME} on Windows.

By default, the profiler agent log file is <user home>/.ynp/log/<application name>-<PID>.log

Use this option to create logs in different directory.

For example, it can be useful when profiling applications running as a Windows service. They usually run under special user, thus the logs are located in that special user's home directory. For example, it can be C:\WINDOWS\system32\config\systemprofile. It can be difficult to find that directory and to open it in explorer.

Instead, make the logs created in an arbitrary easily accessible directory, e.g. log_dir=c:\log

Specify alternate directory for temporary files created by the profiler agent:

• agent-client communication buffer.

By default, the profiler agent creates the temporary files in the default temporary directory.

Limit the number of rows to be stored by the profiler agent per table. The default value is 100,000.

Specify the number of recently finished threads for which profiling results are kept. The default value is 50. Profiling results for the finished threads beyond this limit are merged to <Oldest finished threads> pseudo-thread node. The intention is to limit collected data size when profiling applications constantly creating new short living threads.

Disable object allocation notification events in the runtime to totally eliminate corresponding overhead. Object allocation profiling will not be available.

Disable method enter and leave events in the runtime needed for CPU tracing. CPU tracing will not be available.

Disable several capabilities at once: disable_alloc, disable_tracing, exceptions=disable, probe_disable=*, telemetry=off, threads=off

Forbids CLR to inline any methods.

Specify this option to see all method calls and exact stack traces. Please be aware that the profiled application may run up to 10 times slower.

Use this option when invocation counts obtained with CPU tracing and stack trace accuracy for all called methods are more valuable than the time accuracy and lower overhead.

The compression algorithm used when transferring the snapshot:

• none - no compression.
• deflate - deflate algorithm.
• zstd - zstd algorithm.

The default option is zstd.

The quiet option suppresses or allows printing occasional agent messages to stdout and stderr, such as printing agent log path on application startup.

• true - The default value. Suppresses agent messages to stdout and stderr.
• false - Allows agent messages to stdout and stderr.