Skip to content

Latest commit

 

History

History
103 lines (65 loc) · 3.54 KB

profiling.md

File metadata and controls

103 lines (65 loc) · 3.54 KB
Raw
description
Performance profiler for PowerShell Universal.

Profiling

{% hint style="info" %} Available in PowerShell Universal 2.8.2 or later. Profiling only works for the integrated environment. {% endhint %}

PowerShell Universal provides a performance profiler for debugging issues where the platform may exhibit slow responses. This is primarily useful when building Dashboards.

Enable Profiling

Profiling will increase memory usage as profiling data is stored in memory. You can enable profiling by configuring the Profiling appsettings.json property. It is false by default. You will need to restart PowerShell Universal after enabling or disabling profiling. 

"Profiling": true

Access Profiling Data

You can access profiling data by navigating to /profiler/results-index . You will need to be logged in as administrator before being able to access this URL.

You will see a list of requests and their timings.

Result Index

Clicking on the request will display a break-down of the timings.

Timings

Profiling an API Endpoint

You can profile an API endpoint using Measure-PSUBlock. The API will be listed by URL in the result index.

For example, assume an API called /process. 

New-PSUEndpoint -Url "/process" -Endpoint {
    Measure-PSUBlock -Name 'Api' -ScriptBlock {
        Get-Process | Select-Object name
    }
} -Authentication -Timeout 0

The result of profiling this API would be listed by URL.

Viewing the profile for this API would list the block we measured.

Profiling a Dashboard

{% hint style="info" %} Measure-UDBlock is an alias for Measure-PSUBlock {% endhint %}

You can use the built-in profiler with Dashboards. By default, certain internal action timings are recorded. You can also use the Measure-PSUBlock cmdlet to measure specific blocks within your dashboard.

For example, this dashboard uses Measure-UDBlock to measure the performance of the Start-Sleep cmdlet. The result is the block will take one second to execute. 

New-UDDashboard -Title 'Dashboard' -Content {
    New-UDDynamic -Id 'MyElement' -Content {
        Measure-UDBlock -Name 'WithinDashboard' -ScriptBlock {
            Start-Sleep 1
        }
    }
}

When reviewing requests within the profiler, you will want to look for UDComponent\ElementPost and UDComponent\Element. These are requests for elements within Dashboards.

Below is the example output from the dashboard shown above. Notice that the URL includes the element's ID MyElement. You'll also notice that the WithinDashboard block takes about 1 second.

Dashboard Timing

Not all timing will be displayed by default. You can click show trivial to expand all timings.

All Timings

Profiling a Job

You can profile jobs by using Measure-PSUBlock within your script.

For example, assume we have a script that calls Get-Service. 

Measure-PSUBlock -ScriptBlock {
    Get-Service
} -Name 'Get-Service'

Running a profile on this script will list the job as JobProfiler/{id}. The id will match the job ID shown in the admin console.

The profile will include the block that was measured.