Creating a Diagnostics Bundle

The diagnostics bundle collects all information needed for troubleshooting into a single ZIP archive. It includes configuration files, log files, health check results, event pipeline state, and environment details. This file is the recommended attachment when contacting support.


How to Create a Bundle (GUI)

  1. On the Dashboard, locate the Health status tile and click Diagnose.
  2. The "System Health" window opens, showing the overall status and a DataGrid of all health check results (Name, Status, Message).
  3. Click Export Diagnostics at the bottom of the window.
  4. The bundle is saved to your Desktop as APS_Diagnostics_YYYYMMDD_HHmmss.zip.
  5. A confirmation dialog shows the full path to the generated file.

The bundle is created without any user interaction required — no file picker dialog is shown. The timestamp in the file name ensures that multiple bundles do not overwrite each other.


What the Bundle Contains

Folder in ZIP Contents Source
config/ siem.xml, webhook.xml, redaction.xml, eventpipeline.xml Event Pipeline configuration
config/schemas/ All XSD schema files Schema folder from settings.xml
health/ health-current.json — Snapshot of all health check results Health Checks
pipeline/ queue-summary.json — Active queue statistics
deadletter-recent.json — Last 100 dead-letter entries
Event Pipeline
logs/ 3 most recent application log files Log folder
reports/ 5 most recent report files Report folder
environment.json Machine name, user, domain, OS version, 64-bit flag, .NET version, app version, timestamp, available disk space Collected at bundle creation time


Environment Info Example

The environment.json file contains a snapshot of the system at the time the bundle was created:

{
  "MachineName": "WORKSTATION-01",
  "UserName": "admin",
  "Domain": "CORP",
  "OsVersion": "Microsoft Windows NT 10.0.19045.0",
  "Is64Bit": true,
  "DotNetVersion": "8.0.11",
  "AppVersion": "1.0.0.0",
  "TimestampUtc": "2026-02-13T15:30:00Z",
  "DiskFreeBytes": 53687091200
}


Important Notes

  • No sensitive data — The bundle does not include the license file, the private key, the audit log, or application definition files. It is safe to share with support.
  • GUI only — The diagnostics bundle is currently available only through the GUI. There is no CLI command for bundle creation.
  • File selection — Log and report files are selected by last write time (most recent first). The bundle does not include all historical files.
  • Disk space — Ensure sufficient free disk space on the Desktop drive for the ZIP file. Typical bundle sizes range from a few hundred KB to several MB, depending on log volume.