Perfx 1.1.2

perfx

Azure API Performance benchmarking tool

USAGE

perfx

Results are saved to your Documents folder with the name: Perfx.csv

• Enter r to run the benchmarks
• Enter s to print the stats/details for the previous run
• Enter l:1h:10 to fetch logs for the previous run in the last 1 hour with 10 retries (app-insights durations)
• Enter c to clear the console
• Enter q to quit
• Enter ? to print this help

PRE-REQ: Populate the following JSON and save it to your Documents folder with the name: Perfx.json

{
    "UserId": "",
    "Password": "",
    "Authority": "https://login.microsoftonline.com/YOUR_COMPANY.onmicrosoft.com",
    "ClientId": "",
    "ApiScopes": [
        "api://YOUR-API-SCOPES"
    ],
    "Endpoints": [
        "https://YOUR-API.COM/route1",
        "https://YOUR-API.COM/route2"
    ],
    "Iterations": 5,
    "ReadResponseHeadersOnly": false,
    "AppInsightsAppId": "",
    "AppInsightsApiKey": ""
}

OPTIONAL: Populate the following JSON and save it to your Documents folder with the name: Perfx.Settings.json

{
    "Logging": {
        "LogLevel": {
            "Default": "Warning"
        },
        "Console": {
            "IncludeScopes": true,
            "LogLevel": {
                "Default": "Warning" //,"System.Net.Http.HttpClient": "Information"
            }
        },
        "Debug": {
            "LogLevel": {
                "Default": "Information"
            }
        }
    }
}

Also, see "allowPublicClient": true

# Install from nuget.org
dotnet tool install -g perfx --no-cache

# Upgrade to latest version from nuget.org
dotnet tool update -g perfx --no-cache

# Install a specific version from nuget.org
dotnet tool install -g perfx --version 1.0.x

# Uninstall
dotnet tool uninstall -g perfx

NOTE: If the Tool is not accessible post installation, add %USERPROFILE%\.dotnet\tools to the PATH env-var.

CONTRIBUTION

# Install from local project path
dotnet tool install -g --add-source ./bin perfx

# Publish package to nuget.org
nuget push ./bin/Perfx.1.0.0.nupkg -ApiKey <key> -Source https://api.nuget.org/v3/index.json

NOTICES