Logs and diagnostic information
Each service maintains its own set of logs. By default, the logs are maintained in the
install_path/log folder on each instance in the system. During installation, you can configure each service to store its logs in a different, non-default location.
You can manage any of the log files yourself, deleting or archiving them as necessary.
System logs are managed automatically in these ways:
- All log files are periodically added to a compressed file and moved to install_path/retired/. This occurs at least one time a day, but can also occur:
- Whenever you run the
- Hourly, if the system instance's disk space is more than 60% full.
- Whenever you run the
- When a log file grows larger than 10MB in size, the system stops writing to
that file, renames it, and begins writing to a new file. For example, if the file
exampleService.log.0grows too large, it is renamed to
exampleService.log.1and the system creates a new file named
exampleService.log.0to write to.
log_download lets you easily retrieve logs and
diagnostic information from all instances in the system. This tool is located at this path
on each instance:
For information about running the tool, use this command:
- When using the tool
log_download, if you specify the option
--output, do not specify an output path that contains colons, spaces, or symbolic links. If you omit the option
--output, you cannot run the script from within a folder path that contains colons, spaces, or symbolic links.
- When you run the script
log_download, all log files are automatically compressed and moved to the folder install_path/retired/.
- If an instance is down, you need to specify the option
--offlineto collect the logs from that instance. If your whole system is down, you need to run the log_download script with the
--offlineoption on each instance.
By default, each service stores its logs in its own folder at this path:
This table shows the default log folder names for each service. Depending on how your system was configured when first deployed, your system's logs might not be stored in these directories.
|Default log folder name||Related service||Contains information about|
|com.hds.ensemble.plugins.service.adminApp||Admin-App||The System Management application.|
|com.hds.ensemble.plugins.service.chronos||Scheduling||Workflow task scheduling.|
|com.hds.ensemble.plugins.service.elasticsearch||Metrics||The storage and indexing of:|
|com.hds.ensemble.plugins.service.haproxy||Network-Proxy||Network requests between instances.|
|com.hds.ensemble.plugins.service.kafka||Message Queue||Transmission of data between instances.|
|com.hds.ensemble.plugins.service.logstash||Logging||The transport of system events and workflow task metrics to the Metrics service.|
|com.hds.ensemble.plugins.service.marathon||Service-Deployment||The deployment of high-level services across system instances. High-level services are the ones that you can move and configure (such as Index), not the services grouped under System Services.|
|com.hds.ensemble.plugins.service.mesosAgent||Cluster-Worker||Work ordered by the Cluster-Coordination service.|
|com.hds.ensemble.plugins.service.mesosMaster||Cluster-Coordination||Hardware resource allocation.|
|com.hds.ensemble.plugins.service.remoteAction||Watchdog||Internal system processes.|
|com.hds.ensemble.plugins.service.sentinel||Sentinel||Internal system processes.|
|com.hds.ensemble.plugins.service.solr||Index||Index collections and search indexes.|
|com.hds.ensemble.plugins.service.watchdog||Watchdog||General diagnostic information.|
|com.hds.ensemble.plugins.service.zookeeper||Synchronization||Coordination of actions and database operations across instances.|