Skip to content

VMFleet Reporting ​

Tool: VMFleetCategory: Tool Guide

The reporting subsystem generates comprehensive VMFleet test reports in three formats: PDF, Word (DOCX), and Excel (XLSX).

Report Formats ​

FormatToolUse Case
PDFasciidoctor-pdf with custom themeExecutive summaries, formal documentation, archival
DOCX (Word)Pandoc (AsciiDoc → DocBook → DOCX)Editable reports, stakeholder collaboration
XLSX (Excel)PowerShell ImportExcel moduleData analysis, pivot tables, custom charting

Output Files ​

ArtifactExample pathDescription
Aggregate JSONreports/<run-id>/<run-id>-aggregate.jsonRun-level totals and averages
Per-VM JSONreports/<run-id>/<run-id>-per-vm.jsonVM-level performance detail
Dashboard HTMLreports/<run-id>/dashboard.htmlInteractive summary dashboard
PDF Reportreports/<run-id>/<run-id>.pdfExecutive/shareable report
DOCX Reportreports/<run-id>/<run-id>.docxEditable report
XLSX Workbookreports/<run-id>/<run-id>.xlsxDetailed analysis workbook

Generating Reports ​

powershell
# Generate all three formats from a completed test run
Import-Module ./common/modules/ReportGenerator/ReportGenerator.psm1

New-TestReport `
    -RunId "run-2026-02-13-001" `
    -ResultsPath "results/run-2026-02-13-001/" `
    -OutputPath "reports/run-2026-02-13-001/" `
    -Formats @("PDF", "DOCX", "XLSX") `
    -IncludeMetrics `
    -ClusterConfig "config/clusters/my-cluster.yml"

Or generate reports as part of the results collection:

powershell
.\tools\vmfleet\scripts\Collect-VMFleetResults.ps1 `
    -ResultsPath "results/current-run/" `
    -GenerateReports `
    -ReportFormats @("PDF", "DOCX", "XLSX")

PDF / DOCX Report Sections ​

Both PDF and DOCX reports contain the same sections:

  1. Cover Page — Cluster name, test date, run ID, framework version
  2. Executive Summary — Key findings, pass/fail assessment, top-line metrics
  3. Cluster Configuration — Node details, storage layout, network configuration
  4. Test Results by Profile — For each workload profile:
    • IOPS (read/write/total)
    • Throughput (MB/s)
    • Latency (average, P50, P95, P99)
    • Per-node breakdown
  5. Storage Metrics — Time-series charts for CSVFS counters
  6. Network Metrics — RDMA/SMB throughput, packet loss summary
  7. Compute Metrics — Host and guest CPU utilization
  8. Recommendations — Automated assessment based on metric thresholds
  9. Appendix — Raw configuration, full variable dump, log excerpts

Aggregate JSON Example ​

json
{
  "run_id": "vmfleet-20260323-184500",
  "timestamp": "2026-03-23T18:45:00.000Z",
  "cluster_name": "iic-azl-cluster-01",
  "vm_count": 40,
  "profile_name": "SQL OLTP",
  "total_read_iops": 142500,
  "total_write_iops": 97500,
  "total_iops": 240000,
  "avg_latency_ms": 3.41,
  "total_read_throughput_mbps": 890.15,
  "total_write_throughput_mbps": 640.22
}

Excel Report ​

The XLSX workbook contains multiple worksheets:

SheetContents
SummaryExecutive summary with key metrics, conditional formatting (red/yellow/green)
Storage MetricsIOPS, throughput, latency time-series data with line charts
Network MetricsRDMA/SMB throughput, packet loss data with charts
Compute MetricsCPU/memory utilization data with charts
Profile ComparisonSide-by-side comparison across workload profiles (pivot table)
Raw DataComplete metric dump for custom analysis

Custom Themes ​

The PDF report uses a custom AsciiDoc theme defined in docs/themes/azurelocal-theme.yml:

yaml
extends: default
page:
  margin: [0.75in, 0.75in, 0.75in, 0.75in]
  size: A4
base:
  font-family: Segoe UI
  font-size: 10
heading:
  font-color: #0078D4
  font-family: Segoe UI Semibold
title-page:
  logo-image: image:azure-local-logo.png[width=200]

Report Templates ​

Templates in reports/templates/ define the structure:

  • report-template.adoc — AsciiDoc template with attribute placeholders for test data
  • cover-page.adoc — Separated cover page for PDF output

Excel workbooks are generated dynamically by the ImportExcel PowerShell module — no pre-built template is required.

Released under the MIT License.