.Net性能测试框架Crank的使用方法

目录

  • 安装Crank
  • 创建Crank配置文件
  • 启动Crank-Agent
  • 启动Crank
    • 结果输出
  • 更多参考资料
    Crank 是微软新出的一个性能测试框架,集成了多种基准测试工具,如bombardier、wrk等。
    Crank通过统一的配置,可以转换成不同基准测试工具命令进行测试。可参考Bombardier Job实现。

    安装Crank 运行如下两个命令分别安装Crankcli(Controller)Agent
    dotnet tool update Microsoft.Crank.Controller --version "0.2.0-*" --globaldotnet tool update Microsoft.Crank.Agent--version "0.2.0-*" --global

    需要.Net SDK 5.0环境
    安装完成后执行命令crank,会打印出如下可以配置的参数和介绍,或者github查看相关参数介绍。
    PS C:\Users\Stack\Desktop> crankCrank Benchmarks ControllerThe Crank controller orchestrates benchmark jobs on Crank agents.Usage: Crank [command] [options]Options:-?|-h|--helpShow help information-c|--configConfiguration file or url-s|--scenarioScenario to execute-j|--jobName of job to define--profileProfile name--scriptExecute a named script available in the configuration files. Can be used multiple times.-j|--jsonSaves the results as json in the specified file.--csvSaves the results as csv in the specified file.--compareAn optional filename to compare the results to. Can be used multiple times.--variableVariable--sqlConnection string of the SQL Server Database to store results in--tableTable name of the SQL Database to store results in--sessionA logical identifier to group related jobs.--descriptionA string describing the job.-p|--propertySome custom key/value that will be added to the results, .e.g. --property arch=arm --propertyos=linux

    执行crank-agent,启动基准测试所需的代理服务。github查看相关参数介绍。
    PS C:\Users\Stack\Desktop> crank-agentHosting environment: ProductionContent root path: C:\Users\Stack\.dotnet\tools\.store\microsoft.crank.agent\0.2.0-alpha.21567.1\microsoft.crank.agent\0.2.0-alpha.21567.1\tools\net5.0\any\Now listening on: http://[::]:5010


    创建Crank配置文件 配置文件参考官方hello.benchmarks.yml示例
    【.Net性能测试框架Crank的使用方法】示例文件中引入了bombardier.yml,由于大环境对githubusercontent.com域名不太友好,可以考虑将bombardier.yml下载到本地,imports引入本地路径或者直接将文件内容加入到新建的配置文件。
    imports:-https://raw.githubusercontent.com/dotnet/crank/main/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml

    生产中使用推荐imports文件的方式,crank配置文件中做少量配置就可以完成基准测试,并且可以引入不同的Microsoft.Crank.Jobs.XXX/XXX.yml,基于不同的基准测试工具进行测试。
    其他测试工具配置文件都在https://github.com/dotnet/crank/blob/main/src/Microsoft.Crank.XXX下。
    variables:headers:none: ''plaintext: '--header "Accept: text/plain,text/html; q=0.9,application/xhtml+xml; q=0.9,application/xml; q=0.8,*/*; q=0.7" --header "Connection: keep-alive"'html: '--header "Accept: text/html,application/xhtml+xml,application/xml; q=0.9,*/*; q=0.8" --header "Connection: keep-alive"'json: '--header "Accept: application/json,text/html; q=0.9,application/xhtml+xml; q=0.9,application/xml; q=0.8,*/*; q=0.7" --header "Connection: keep-alive"'connectionclose: '--header "Connection: close"'presetHeaders: nonejobs:bombardier:source:repository: https://github.com/dotnet/crank.gitbranchOrCommit: mainproject: src/Microsoft.Crank.Jobs.Bombardier/Microsoft.Crank.Jobs.Bombardier.csprojsourceKey: bombardiernoBuild: truereadyStateText: Bombardier ClientwaitForExit: truevariables:connections: 256 #设置连接数warmup: 15 #设置测试预热次数duration: 15 #设置测试时间requests: 0 #设置测试请求实例数rate: 0 #设置每秒请求频率transport: fasthttp # | http1 | http2设置使用golang的fasthttp库发送http请求serverScheme: httpserverAddress: localhostserverPort: 5000path: bodyFile: # path or url for a file to use as the body contentverb: # GET when nothing is specifiedcustomHeaders: [ ] # list of headers with the format: ': ', e.g. [ 'content-type: application/json' ]arguments: "-c {{connections}} -w {{warmup}} -d {{duration}} -n {{requests}} --insecure -l {% if rate != 0 %} --rate {{ rate }} {% endif %} {% if transport %} --{{ transport}} {% endif %} {{headers[presetHeaders]}} {% for h in customHeaders %}{% assign s = h | split : ':' %}--header \"{{ s[0] }}: {{ s[1] | strip }}\" {% endfor %} {% if serverUri == blank or serverUri == empty %} {{serverScheme}}://{{serverAddress}}:{{serverPort}}{{path}} {% else %} {{serverUri}}:{{serverPort}}{{path}} {% endif %} {% if bodyFile != blank and bodyFile != empty %} -f {{bodyFile}} {% endif %}{% if verb != blank and verb != empty %} -m {{verb}} {% endif %}"onConfigure: # - job.timeout = Number(job.variables.duration) + Number(job.variables.warmup) + 10; server:source: #指定需要测试的项目,本文直接使用本地路径localFolder: .project: crank_demo.csprojreadyStateText: Application started.# source: 指定测试项目的远程仓库地址,并通过branchOrCommit指定分支#repository: https://github.com/dotnet/crank#branchOrCommit: main#project: samples/hello/hello.csproj# readyStateText: Application started.scenarios: #配置基准测试场景crank_demo: #定义方案名,执行crank命令时指定该名称application: job: server # 指定测试项目为上面定义的serverload:job: bombardier # 指定测试工具bombardiervariables:serverPort: 5000 #配置http服务端口path: / #配置http服务地址profiles:local:variables:serverAddress: localhostjobs: application:endpoints: - http://localhost:5010load:endpoints: - http://localhost:5010


    启动Crank-Agent 启动agent后执行crank,会有一个如下安装sdk的动作
    [09:29:05.261] Runtime: 6.0.0 (Current)[09:29:05.262] SDK: 6.0.100 (Current)[09:29:05.263] ASP.NET: 6.0.0 (Current)[09:29:05.265] Creating custom global.json[09:29:05.266] Desktop: 6.0.0 (Current)[09:29:05.266] Installing SDK '6.0.100' ...

    所以启动agent时多指定一个dotnethome参数,避免重复安装sdk。
    crank-agent --dotnethome 'C:\Program Files\dotnet'


    启动Crank
    crank --config .\demo.benchmarks.yml --scenario crank_demo --profile local

    --scenario crank_demo: 指定定义的测试场景
    --profile local :设置输出结果到本地,即控制台输出
    可以通过参数指定结果输出到本地json文件(--output results.json )或者数据库(--sql [connection-string] --table [table-name])

    结果输出
    这里省略压测期间的日志输出,直接列出结果。
    | application||| --------------------- | ------------- || CPU Usage (%)| 56|| Cores usage (%)| 447|| Working Set (MB)| 140|| Private Memory (MB)| 157|| Build Time (ms)| 7,232|| Start Time (ms)| 501|| Published Size (KB)| 91,292|| .NET Core SDK Version | 6.0.100|| ASP.NET Core Version| 6.0.0+ae1a6cb || .NET Runtime Version| 6.0.0+4822e3c || load|| | --------------------- | -------------- || CPU Usage (%)| 46| | Cores usage (%)| 370| | Working Set (MB)| 29|| Private Memory (MB)| 30|| Build Time (ms)| 11,891|| Start Time (ms)| 226|| Published Size (KB)| 68,228|| .NET Core SDK Version | 3.1.415|| ASP.NET Core Version| 3.1.21+458d974 || .NET Runtime Version| 3.1.21+df8abc0 || First Request (ms)| 185|| Requests| 912,005|| Bad responses| 0|| Mean latency (us)| 4,207|| Max latency (us)| 138,999|| Requests/sec| 60,305|| Requests/sec (max)| 128,523|


    更多参考资料 crank readme
    Benchmarks crank为Benchmarks重构版本
    本文示例代码
    以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

      推荐阅读