Skip to content

onboard.md

Latest commit

 

History

History
43 lines (29 loc) · 2.76 KB

onboard.md

File metadata and controls

43 lines (29 loc) · 2.76 KB

Onboarding your project

Create the performance testing workflow for your project in .github/workflows/<project>.yml e.g. quic.yml, ebpf.yml... etc. with a repository dispatch trigger.

The details of your performance test (what you measure, how you measure it) is entirely up to you. Netperf merely supplies the hardware + engineering systems infrastructure to run the tests. See lab_consumption.md to leverage the lab infrastructure. Open an issue if you want to leverage the Azure infrastructure.

Netperf also offers an API to collect the results into a database, and then visualize them in a dashboard. You do not have to use this API to use Netperf. Currently, MsQuic leverages this API to collect data and the results of perf tests can be seen on https://microsoft.github.io/netperf/dist/, while eBPF for Windows does not (they use Grafana instead).

If you're interested in this API, see internal/database.md to learn our schema of representing performance data, /dashboard for our React frontend dashboard, and open an issue if this works for your project.

Triggering a netperf Run

The run-workflow.ps1 script is used to trigger the appropriate test and wait for it to complete. The script leverages the GitHub REST API to trigger the workflow, wait for it to complete and then use the result to pass or fail the original caller. For example:

$url = "https://raw.githubusercontent.com/microsoft/netperf/main/run-workflow.ps1"
iex "& { $(irm $url) } ${{ secrets.NET_PERF_TRIGGER }} <your_project> ${{ github.sha }} ${{ github.ref }} ${{ github.event.pull_request.number }}"

To call this script, you must have a GitHub Personal Access Token (PAT) with the public_repo scope. This token is stored as a secret in the repository and is passed to the script as the first argument. The other arguments are the name of the test to run, the SHA of the commit to test, the branch or tag to test, and the pull request number if applicable.

Running from Another GitHub Repository

Here are a couple explicit steps to onboard a GitHub repo to trigger netperf.

  1. Create a new PAT with the public_repo scope.
  2. Add the PAT as a secret your GitHub repository.
  3. Add a step to your workflow to trigger the netperf run. Example:
steps:
- name: Run NetPerf Workflow
  shell: pwsh
  run: |
    $url = "https://raw.githubusercontent.com/microsoft/netperf/main/run-workflow.ps1"
    if ('${{ secrets.NET_PERF_TRIGGER }}' -eq '') {
        Write-Host "Not able to run because no secrets are available!"
        return
    }
    iex "& { $(irm $url) } ${{ secrets.NET_PERF_TRIGGER }} <your_project> ${{ github.sha }} ${{ github.ref }} ${{ github.event.pull_request.number }}"