Skip to content

Diagnostics

Shahid_Reza edited this page Jun 28, 2026 · 2 revisions

πŸ“Š Diagnostics Commands

Detailed reference for all diagnostic commands in Toolmetry Server Doctor.


🩺 Server Audit

tm audit

Runs a comprehensive server audit, generating a 0–100 health score across 5 categories.

Usage:

tm audit              # Run a new audit
tm audit show         # Show last audit results
tm audit recs         # Show recommendations only

Permission: toolmetry.admin

Async: Yes (runs on async thread, never blocks main thread)

Output: Compact chat report with progress bars + Discord forward

πŸ“š See Server Audit for details.


πŸ”Œ Plugin Doctor

tm doctor

Scans every installed plugin for issues.

Usage:

tm doctor             # Run a new scan
tm doctor report      # Show last scan results

Permission: toolmetry.admin

Async: Yes

Output: Chat report with all plugin issues + Discord forward

πŸ“š See Plugin Doctor for details.


⚑ Lag Analyzer

tm lag

Analyzes the server for lag sources.

Usage:

tm lag                # Run a new analysis
tm lag report         # Show last analysis results

Permission: toolmetry.admin

Async: Yes (but world data is read on main thread β€” brief sync pause)

Output: Chat report with lag sources + Discord forward

πŸ“š See Lag Analyzer for details.


πŸ” Security Scanner

tm security

Runs a security vulnerability scan.

Usage:

tm security           # Run a new scan
tm security report    # Show last scan results

Permission: toolmetry.admin

Async: Yes

Output: Chat report with security score + Discord forward

πŸ“š See Security Scanner for details.


πŸ’₯ Crash Analyzer

tm crash

Reads and analyzes crash reports.

Usage:

tm crash                    # Re-analyze all crash reports
tm crash list               # List analyzed crash reports
tm crash analyze <id>       # Show details of a specific report
tm crash analyze log        # Analyze latest.log for errors

Permission: toolmetry.admin

Async: Yes

Output: Chat report with crash diagnosis + Discord forward

πŸ“š See Crash Analyzer for details.


⏱️ Benchmark

tm benchmark

Runs performance benchmarks.

Usage:

tm benchmark          # Run a new benchmark
tm benchmark results  # Show last benchmark results

Permission: toolmetry.admin

Async: Yes

Output: Chat report with test scores + Discord forward

πŸ“š See Benchmark for details.


πŸ“„ Config Validator

tm config

Validates plugin YAML configuration files.

Usage:

tm config             # Validate all plugins
tm config all         # Same as above (explicit)
tm config <plugin>    # Validate a specific plugin's configs

Permission: toolmetry.admin

Async: Yes

Output: Chat report with all config issues + Discord forward

πŸ“š See Config Validator for details.


🌍 Entity Check

tm entitycheck

Shows entity counts per world, broken down by type.

Usage:

tm entitycheck              # All worlds
tm entitycheck <world>      # Specific world
tm entitycheck all          # All worlds (explicit)

Permission: toolmetry.admin

Async: No (reads world data synchronously β€” fast for small entity counts)

Output: Chat report with top 10 entity types per world


πŸ—ΊοΈ Chunk Scan

tm chunkscan

Shows chunk statistics per world.

Usage:

tm chunkscan                # All worlds
tm chunkscan <world>        # Specific world
tm chunkscan all            # All worlds (explicit)

Permission: toolmetry.admin

Async: No (reads world data synchronously)

Output: Chat report with chunk counts, entity counts, tile entity counts per world


πŸ”„ Full Scan

tm scan

Runs all major diagnostics at once: audit + doctor + lag + security.

Usage:

tm scan

Permission: toolmetry.admin

Async: Yes

Output: 4 separate chat reports (one per module) + 4 Discord forwards

Duration: Typically 5–15 seconds total

πŸ’‘ This is the "lazy option" β€” runs everything in one command.


πŸ“ Report Generation

tm report

Generates an HTML report containing all available data.

Usage:

tm report

Permission: toolmetry.admin

Async: Yes

Output: Saves an HTML file to plugins/Toolmetry-Server-Doctor/reports/

πŸ“š See HTML Reports for details.


πŸ”„ Update Check

tm update

Checks for Paper and plugin updates.

Usage:

tm update

Permission: toolmetry.admin

Async: Yes (network calls to PaperMC and Spiget APIs)

Output: Chat report with available updates + Discord forward

πŸ“š See Update Checker for details.


πŸ“‹ Common Patterns

Run a Single Diagnostic

tm audit

Run All Diagnostics

tm scan

View Last Results (without re-running)

tm audit show
tm doctor report
tm lag report
tm security report
tm benchmark results

Generate a Report After Scanning

tm scan               # Run all diagnostics
tm report             # Generate HTML report with all data

Last updated: v1.0.0 β€’ Edit this page