Skip to content

Agent CLI ​

logcore-agent status      [-config FILE] [-json]   Show the running agent's status
logcore-agent run         [-config FILE]           Run in the foreground (default)
logcore-agent configcheck [-config FILE]           Validate config and list matched files (alias: test-config)
logcore-agent service <install|uninstall|start|stop|restart|status> [-config FILE]
logcore-agent version

On Linux, run these commands with sudo. On Windows, run them in an Administrator PowerShell.

-config defaults to /etc/logcore-agent/logcore.yaml on Linux and C:\ProgramData\Logcore\logcore.yaml on Windows.

status ​

Shows a health report from the running agent: connection, queue, host metrics, APM, and every service with its files. See Agent status.

Flag
-jsonMachine-readable output

The exit code is 0 if the agent is running and 3 if it isn't.

configcheck ​

Validates logcore.yaml and every service file, then lists the log files each service matches right now. Run it after every change, before you restart:

sh
sudo logcore-agent configcheck

It reports YAML errors, invalid regexes, relative paths, duplicate service names, and whether APM is enabled.

run ​

Runs the agent in the foreground and logs to the terminal. This is useful for debugging; stop the service first so the two don't conflict:

sh
sudo systemctl stop logcore-agent
sudo -u logcore-agent logcore-agent run

service ​

Manages the system service (systemd on Linux, the Windows Service Manager on Windows).

SubcommandAction
installRegisters the service. The one-line installer does this for you.
uninstallRemoves the service registration
start / stop / restartControls the service
statusShows whether the service is running

On Linux you can also use systemctl directly:

sh
sudo systemctl restart logcore-agent
sudo systemctl status logcore-agent
sudo journalctl -u logcore-agent -f

version ​

Prints the agent version.

Daily commands ​

TaskLinuxWindows (Administrator)
Statussudo logcore-agent statuslogcore-agent status
Validate configsudo logcore-agent configchecklogcore-agent configcheck
Restart after changessudo systemctl restart logcore-agentlogcore-agent service restart
Agent's own logsudo journalctl -u logcore-agent -fGet-Content C:\ProgramData\Logcore\logs\agent.log -Tail 50 -Wait
Upgradere-run the install commandre-run the install command
UninstallUninstallUninstall