CommandBox : CLI, Package Manager, REPL & More
Search…
5.4.0
Introduction
About This Book
Authors
Overview
Release History
Getting Started Guide
Setup
Usage
IDE Integrations
Config Settings
Embedded Server
Multi-Engine Support
Server Versions
Start HTML Server
Offline Server Starts
Debugging Server Starts
Server Processes
Manage Servers
FusionReactor
Server Logs
Configuring Your Server
External Web Server
Starting as a Service
Single Server Mode
Server.json
Package Management
Task Runners
Helpful Commands
Deploying CommandBox
TestBox Integration
Developing For CommandBox
ForgeBox Enterprise
Introduction
Storage
Commands
Usage
Powered By GitBook
Debugging Server Starts
If a server isn't starting, the first thing to run is the server log command. It will show you the console log for that server. Note, this dumps the entire log file to the console, which may be very large. We recommend using the tail or --follow tricks below.
1
server log
2
server log serverName
Copied!

Tailing and Following logs

If the log is very large, use the tail command to just see the last few lines of it.
1
server log | tail
2
server log | tail lines=100
Copied!
To get a live stream of the console log from a running server, use the --follow flag and the command will continue streaming new lines to the console until you press Ctrl-C to stop.
1
server log --follow
Copied!
You can also look at your server's access log (if enabled) and rewrite log (if enabled).
1
server log --follow -access
2
server log --follow --rewrite
Copied!

Start server in console mode

You can use the --console flag to the server start command to start a server in the foreground. The console log will be live-streamed to the CLI and the log will continue streaming as long as the server is running. Press Ctrl-C to stop the server and stop streaming the log file.
1
server start --console
Copied!

Debug Logging

You can get additional information about a server start with the --debug flag. When debug is set, the start command will not exit immediately, but wait for the server to come up and live stream the debugging information and server logs to the console while the server is coming up.
1
server start --debug
2
server start --debug --console
Copied!

Maximum logging! (trace)

You may still really be having issues getting your server to start up correctly due to a setting not getting picked up, rewrites not working, or maybe a jar not loading. You can "drink from the firehose" so to speak by turning on trace level logging. This works best when starting the server via the console so you can watch the logging as it streams past.
1
server start --trace --console
Copied!
Previous
Offline Server Starts
Next
Server Processes
Last modified 3yr ago
Copy link
Edit on GitHub
Contents
Tailing and Following logs
Start server in console mode
Debug Logging
Maximum logging! (trace)