🏇 Insight Harness

Short Description

The Insight Harness provides orchestration and status monitoring for automated test runs and multi-session performance profiling.

Long Description

The Insight Harness (FGorgeousInsightHarness) is the execution utility for the Insight Matrix. it manages the lifecycle of automated runs, including map loading, connection monitoring, and Gauntlet state management. It also handles the serialization of test results to disk for persistent tracking and external reporting.

🚀 Features

  • Run Orchestration: Start and stop complex matrix runs with standardized setup.
  • Status Snapshots: Real-time monitoring of harness state, networking metrics, and Gauntlet status.
  • Result Serialization: Automatic saving of scenario and test results to the project's Saved directory.
  • Gauntlet Support: Deep integration with Epic's Gauntlet Automation Framework for multi-process testing.
  • Network Profiling: Integrated tracking of packet rates and bandwidth usage during harness runs.

📚 Usage Examples

// Checking harness status
FGorgeousInsightHarnessStatus Status = FGorgeousInsightHarness::GetStatus();
if (Status.bHarnessActive)
{
    UE_LOG(LogTemp, Log, TEXT("Current Map: %s"), *Status.HarnessMapPath);
}


// Broadcasting a Gauntlet heartbeat
if (FGorgeousInsightHarness::IsGauntletActive())
{
    FGorgeousInsightHarness::MarkGauntletHeartbeat(TEXT("Executing Stress Test"));
}

Best Practices

  • Use the Gauntlet Heartbeat frequently during long-running tests to prevent automation timeouts.
  • Prefer SaveScenarioResult for high-level run summaries and SaveTestResult for granular provider diagnostics.
  • Monitor the NetworkMetricLines in the harness status for a human-readable summary of replication health.

Troubleshooting

  • Harness Not Starting: Ensure the FGorgeousInsightMatrixRequest contains valid map paths and that all required providers are registered.
  • Gauntlet Inactive: Verify that the project is running with the -Gauntlet command-line argument if multi-session features are required.
  • Serialization Failure: Results are saved to Saved/Automation/InsightMatrix; ensure this path is not write-protected.