Startup options

port=<port>

or

port=<min port>-<max port>

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

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 loopback network interface. The most commonly used IP address on the loopback network is 127.0.0.1 for IPv4 and ::1 for IPv6. 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.

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.

The telemetry information is 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 telemetrylimit option you can customize the time period within which the telemetry data is being stored.

Do not use unnecessarily long buffers

Extending the telemetry buffer will allocate additional amount of memory in the profiled application's address space. That is especially important for 32-bit processes because their address space is limited.

Also, the longer the buffer, the more time it takes to retrieve the telemetry information from the profiler agent when you connect to a long running profiled application.

Specify how often telemetry information is obtained.

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

Note that setting smaller period can add overhead.

Probes: limit the number of rows to be stored by the profiler agent per table.

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.

Specify custom snapshot directory for the particular profiled application

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. logdir=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.

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.

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 '-'.

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.

Choose which of multiple CLR version instances loaded in a single process should be profiled. See MSDN article In-Process Side-by-Side Execution for detail.

Use targetclr=v4 to profile CLR 4 instance or targetclr=v2 to profile CLR 2 instance.

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.

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. This option cannot be used in combination with disabletracing.

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

This option can be used in combination with allocsizelimit. This option cannot be used in combination with disablealloc.

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

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

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

This option can be used in combination with alloceach. This option cannot be used in combination with disablealloc.

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

Automatically capture a memory snapshot when process used memory reaches the threshold.

Periodically capture performance snapshots.

Periodically capture memory snapshots.

Do not collect thread stack and status information shown in Thread view as well as in other telemetry views. This information can be very useful because it allows you to connect to the profiled application on demand and discover how the application behaved in the past. In most cases, there is no significant overhead of collecting this information. However, you may want to stop it to minimize profiling overhead.

See also: Profiling overhead: how to reduce or avoid.

Do not start with exception profiling. The exception profiling helps discovering performance issues and logic errors. In most cases, there is no significant overhead of collecting this information. However, you may want to disable it to minimize profiling overhead.

See also: Profiling overhead: how to reduce or avoid.

probe_on=<pattern>

probe_off=<pattern>

probe_auto=<pattern>

probe_disable=<pattern>

Control probes on startup. Read more...

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.

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

See also: Profiling overhead: how to reduce or avoid.

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

See also: Profiling overhead: how to reduce or avoid.

Disable several capabilities at once: disablealloc, disablestacktelemetry, disabletracing, exceptions=off, probe_disable=*