Diagnostics
Where XPLG reports on itself: the System Health console and its sections, the administrators' Support Portal, the system log families, the System Report, and the export to attach to a ticket.
What you will do: read the built-in diagnostics before you change anything, and collect the right export for support in one pass.
System Health
XPLG > System > System Health (the System Status console) monitors every node and sends alerts when a section crosses its threshold. Each section has an edit link to enable or disable it, change thresholds, add rules and set the alerting policy (email, SNMP trap, recovery alert).
| Section | What it reports |
|---|---|
| Overview | Status of every section, the latest alerts, each node's last report (every five minutes) |
| Data | Volume per folder, log, app, server and collection policy; rules for abnormal volume and silent sources; parsing and time-zone configuration checks; thresholds against the license volume |
| System Tasks | Execution time of XPLG's own tasks, with alerts on slow tasks |
| Listeners | Received and dropped events per listener |
| Memory, Disk Space, Storage Response Time | Heap and host memory, free space per path, disk latency |
| Network | Connectivity to remote sources and destinations |
| Configuration | Validity of the applied configuration, version conflicts between nodes |
| System Information | Version and build, Java version, time zone, host details per node |
Support Portal
XPLG > Settings > About > Open Support Portal — administrators only. It is the built-in diagnostics console, not the public support site.
- Basic Information: the system logs with size, modification time and logging level — view, export, Export Light, change the level, add the system logs as searchable logs; and System Information.
- Activity Information: running processes, threads, SSH connections, jobs and HTTP sessions, each of which an administrator can stop, interrupt, terminate or destroy (with care: users waiting on them see partial results).
- Data Information: indexing status per log (delete or re-index), monitors and the other data stores.
- Actions and Advanced Settings: maintenance operations and the advanced configuration keys.
In a cluster, pick the node at the top or view all nodes together.
System logs
Under log/ in the configuration directory (Log4j, configurable in conf/general/log4jXpoLog.properties):
| Log | Content |
|---|---|
| audit | Every user action, from sign-in on; kept as long as you need for compliance |
| system audit | Server-side activity: collection, indexing, monitors, dashboards |
| xpologlog | Every error XPLG encounters |
| ssh | SSH connection and collection errors |
| scanner | Directory scans: sources scanned, logs found |
| XpoLogMemory | Memory consumption |
| Servlet Container | Tomcat's own logs |
| Cluster Activity | Cluster events |
| Data Activity | Collection and data management |
| ant.out | Patch deployments |
| Events | Alerts, exports, task executions sent out |
| System Alerts | Alerts raised by System Health |
| collectionstat | Per-log collection statistics |
| portxstat | Per-forwarder and per-log forwarding statistics |
X8 adds docker compose logs <role> and verify.sh.
What to send with a ticket
- Version and build from System > About, the deployment name from Deployments in dock.
- The System Report (XML) exported from About.
- A Support Portal Export All Light (or a full export when asked) of the system logs, from every node that is involved.
- The current System Health alerts; on X8 the
verify.shoutput and the failing role's compose log. - What you expected, what happened, when, and how to reproduce.
Remove secrets from attachments; Data handling lists what the products mask on the way out. Then follow Getting help.
Next: FAQ
Source: XPLG wiki, pages 1594132938, 1594132940, 1594132942, 1594131939, 3151659011 (https://xpolog.atlassian.net/wiki/spaces/XPOL/pages/1594132940).
