Configure the Log Server
After the Log Server is running, you may need to adjust retention, enable remote access for Director/Monitor, verify health, or scale OpenSearch memory. Advanced settings are stored in the start script — changing them requires stopping the container, editing the script, and restarting.
Configuration Reference
| Variable | Default | Range | Description |
|---|---|---|---|
MAX_RESERVE_DAYS |
7 | 1–30 | Log retention in days. Logs older than this value are deleted. Checked every 10 minutes. |
MAX_DISK_USAGE_PERCENTAGE |
85 | 10–90 | Disk usage threshold. When exceeded, old logs are deleted day by day until usage falls below this value. |
LOCAL_DOWN_ONLY |
true | true/false | When true, only the Log Server machine can call the /Download/ APIs. Set to false to allow Director/Monitor and remote CLI access. |
OPENSEARCH_JAVA_OPTS |
"-Xms2G -Xmx2G" |
2G → MaxMem/2 | OpenSearch heap memory. Increase for larger environments. |
LOG_LEVEL |
2 | 0–4 | Log verbosity. 0=Trace, 1=Debug, 2=Info, 3=Warning, 4=Error. |
CORS_ORIGINS |
(unset) | URL or url1;url2
|
Required for CWA HTML5/Chrome clients. Enter the allowed origin URLs separated by ;. |
Editing Configuration on Linux or Windows
Step 1 — Stop the Container
docker stop logserver
<!--NeedCopy-->
Step 2 — Edit the Start Script
Open StartLogServer.sh (Linux) or StartLogServer.bat (Windows) in a text editor. Find the environment variable block and edit the values:
-e MAX_RESERVE_DAYS=14
-e MAX_DISK_USAGE_PERCENTAGE=85
-e LOCAL_DOWN_ONLY=false
-e OPENSEARCH_JAVA_OPTS="-Xms4G -Xmx4G"
<!--NeedCopy-->
Step 3 — Restart the Log Server
# Linux
./StartLogServer.sh
# Windows
StartLogServer.bat
<!--NeedCopy-->
Enabling Director/Monitor Access
By default, LOCAL_DOWN_ONLY=true restricts log downloads to the Log Server machine. To allow Citrix Director or Monitor to retrieve logs remotely:
- Stop the container.
- Set
LOCAL_DOWN_ONLY=falsein the start script. - Restart the Log Server.
Note:
When installed in HTTPS mode (version 2603 and later),
LOCAL_DOWN_ONLYis automatically set tofalse. When installed in HTTP mode, it defaults totrueand must be manually changed.
OpenSearch Memory Scaling
| Connected Machines | Recommended Setting |
|---|---|
| 0–999 | -Xms2G -Xmx2G |
| 1,000–1,999 | -Xms4G -Xmx4G |
| 2,000–9,999 | -Xms6G -Xmx6G |
Verifying Health
Ping Endpoint
https://YourLogServerFQDN:8443/Ping
<!--NeedCopy-->
Expected: Pong UTC:<timestamp> Version: <version>
Docker Logs
docker logs logserver
<!--NeedCopy-->
Container Health
docker exec -it logserver bash
curl http://localhost:5000/Ping
curl http://localhost:9200/_cluster/health?pretty
tail Config/applogs.txt
tail Config/weblogs.txt
exit
<!--NeedCopy-->
Check Current Configuration Values
docker exec -it logserver env | grep MAX_RESERVE_DAYS
<!--NeedCopy-->
Startup Log Location
| Platform | Default Path |
|---|---|
| Linux | $HOME/LogServer/Config/weblogs.txt |
| Windows | C:\Users\<username>\LogServer\Config\weblogs.txt |
| Custom install | <your-config-path>\weblogs.txt |
Note:
Configuration on Citrix Connector Appliance is managed via the REST API. See the API section in Install on Connector Appliance.