Activities
latest
false
IT Automation Activities
Last updated Jun 11, 2024

Performance Trigger

UiPath.DesktopTriggers.Activities.ProcessPerformanceTrigger

Important: The Performance Trigger activity must be placed inside a .

Use this activity to create a trigger that monitors the performance of your system or of a specific application.

The trigger you configure executes once it meets the threshold conditions and return information about the performance event for later investigation.

Properties

Common

The property in this category refers to common activity settings.

  • DisplayName (String) - Sets the name for this activity. For example, "Monitor UiPath Studio CPU usage".
Input

The properties in this category refer to basic performance settings.

  • Applications to monitor (String) - Sets the entire system or a specific application for which you want to monitor the performance. You can select only one application per activity.

    All available user applications can be monitored.

    To make sure you input the correct process name, select it from the dropdown menu, or check the Windows Task Manager > Details tab, as the activity uses the same process names, without the .exe extension.

    To see all currently open applications, use the activity body to set this property, as it displays a drop-down list from which you can select either one application or all of them. Use the refresh button to display the latest application list.



  • Performance Monitor Type (String)- Selects from memory, processor (CPU), disk, or network performance.
  • Include child processes (Boolean) - If selected, the activity monitors child processes as well. Subsequently, the trigger event result displays an array of all child processes and their information, while the total value is for the parent process. By default, the option is set to false.
  • Include privileged access (Boolean) - If selected, the activity monitors processes that require privileged access, in addition to user-available ones. Subsequently, the trigger event result displays an array of all open processes and their information, and the total consumption value includes the privileged processes as well. Returning the full result may take up to 20 seconds. By default, the option is set to false.
    Note: For Disk consumption, selecting the checkbox does not not return privileged process results.
  • Threshold Duration(sec) (Int32)- Sets the number of seconds the threshold level must be exceeded continuously before executing the trigger. Accepts minimum 1 second, maximum 600 seconds.
  • Threshold Level(%) (Double) - Sets the exceed level for the selected performance type (memory or CPU). Accepts minimum 1%, maximum 100%.

    Note:
    Monitoring the network consumption of an individual process requires admin rights. Kill all UiPath processes using Task Manager, restart UiPath Studio in admin mode, then rerun the workflow.
    docs image

Example

For example, say you create a performance trigger to inform you when an application causes CPU to exceed a threshold level of 10% for more than 4 seconds continuously. You set the Performance Monitor Type as CPU, the Threshold Level (%) as 10, and Threshold Duration (sec) as 4.
Misc

The property in this category refers to miscellaneous settings.

  • Private (Boolean) - To skip generating data logs for this activity, check this box. By default, the checkbox is cleared (set to false).
  • Properties

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.