PI Nexus+ / Reference
Logs and Support Bundle Reference
This reference lists the log files, log levels, event log sources and the contents of the support bundle. The Administration Guide chapter Support and Diagnostics links here.
Overview
This reference lists the log files, log levels, event log sources and the contents of the support bundle. The Administration Guide chapter Support and Diagnostics links here.
Log files
All files are in C:\ProgramData\Software Athlete\PI Nexus+\Logs on the server that runs the component.
| File | Written by | Contains |
|---|---|---|
pi-nexus-api-<date>.log | Web application (IIS app pool PINexusAppPool) | Web requests, Admin page tests and discovery, SQL Server and schema errors |
pi-nexus-worker-<date>.log | Scanner service (PI Nexus+ Scanner) | Scans, dispatch decisions, supersession, change feeds, runtime polls, host monitoring, emails |
| Installer logs | Installer | Written to %TEMP% and, where possible, to the Logs folder |
| Item | Value |
|---|---|
| New file | Every day, and when a file reaches 50 MB |
| Files kept | 31 per component |
| Line format | Time with offset, level, source, message, exception |
| Microsoft, ASP.NET Core and Hangfire messages | Warning and above only |
Windows event log
| Source | Log | Written |
|---|---|---|
PI Nexus+ API | Application | Warnings and errors of the web application |
PI Nexus+ Worker | Application | Warnings and errors of the scanner service |
PI Nexus+ Installer | Application | Installer events |
Log levels
| Setting | Options | Default | Where |
|---|---|---|---|
| Base log level | Information, Debug, Warning, Error | Information | Admin > Support > Diagnostics; stored in bootstrap.json |
| Temporary debug logging Duration | 15 minutes, 1 hour, 2 hours, 4 hours, 24 hours | Same tab; switches itself off when it expires | |
| Effective Log Level | The level in use now: the base level, or Debug while temporary debug is on |
Both services pick up temporary debug logging within their polling interval, without a restart. On a split installation the Base log level is stored in the web server's bootstrap.json; set the scanner server's own file there.
Support bundle contents
The bundle is a ZIP file named pi-nexus-support-<date>-<time>.zip. Time range (1, 7, 14 or 31 days) limits the logs, event log entries and scan history in it.
| Entry | Contents |
|---|---|
manifest.json | Version, time, requesting user, machine, operating system, license mode, redaction policy |
runtime-status.json | bootstrap.json path, log levels |
runtime-heartbeats.json | Last report of the web application and the scanner service, with their machines |
scanner-server-logs.txt | Split installation only: the scanner server and the folder to copy its logs from |
database-status.json | SQL Server connection, schema and migration history |
configuration.json | Targets, rules and settings, without secrets |
scan-runs.json | Scan runs in the time range |
scan-automation.json | Policy, each target's state with its freshness dates and failure counters, recent work items with their reasons |
scan-history-retention.json | Scan history retention settings and last cleanup |
change-feed.json | Change feed state per target |
dashboard-summary.json | Dashboard and issue summary |
scale-diagnostics.json | The Scale tab's data |
deployment-readiness.json | The Readiness tab's checks |
license-status.json | License status |
security-status.json | ProgramData and configuration ACL health, and a summary of the security audit |
host-monitoring.json | See Host Monitoring Reference |
logs/ | The pi-nexus-*.log files of the server that runs the web application, for the time range |
event-log/application.json | Up to 1,000 Application event log entries of PI Nexus+ API and PI Nexus+ Worker |
collection-errors.json | Parts that could not be collected, and why |
Passwords, tokens, credentials and connection-string secrets are removed. Object, server, path, display and domain user names are kept. Full inventory exports are not included. In the Evaluation edition, issue details are limited to the Evaluation sample; logs are included in every edition.
Scale diagnostics
| Value on Scale | Meaning |
|---|---|
| Inventory Rows | Rows in the largest inventory tables |
| Staging Rows | Rows left in scan staging tables; should be 0 when no scan runs |
| Recent Runs | Scan runs included in the diagnostics |
| SQL Process | Memory used by the SQL Server process, and memory available on the host |
| Single-use Plans | Query plans for the PI Nexus+ database used only once |
| Staging Reserved | Database space reserved for scan staging |
| PI Nexus+ buffer cache | Cached PI Nexus+ data in SQL Server memory; reusable |
| PI Nexus+ prepared plans | Plan cache for the PI Nexus+ database |
| SQL Server max memory | The instance's max server memory setting |
Further tables (largest tables, staging leftovers, recent scan runs, runtime by scope) are under the Reference tables disclosure. The page only reads; it does not clear caches or change SQL Server settings.
Who can do what
| Action | Role |
|---|---|
| Everything under Admin > Support | Admin |
