Support bundle and logs
Get help
Open or track a support request from Get help in the menu under your name at the top right of the console. It opens your account on gardience.com (sign in if you are not), where every request gets a number, an emailed receipt with its response time, and every reply in one place. Or email george@gardience.com with your license ID.
Read the logs
Gardience runs as a set of containers, called services:
| Service | What it is |
|---|---|
gardience | The Gardience service: console pages, API, scans, runs and the audit log. |
salt-master | The Salt master and salt-api. All-in-one installs only. |
runner | Runs Ansible playbooks, isolated from the rest. |
nginx | The web front end, on the HTTPS and HTTP ports (443 and 80 by default). |
To follow the last 100 lines of every service, and then new lines as they come:
/opt/gardience/gardience logsTo follow one service:
/opt/gardience/gardience logs gardiencePress Ctrl-C to stop. Any extra options are passed to docker compose logs.
Most lines from the gardience service are JSON objects with ts, level, component and msg fields. An unexpected error is written to the log with a reference code. The console shows only that code, so you can find the full detail in the log.
Each service's log is capped at five files of 50 MB, so logs never fill the disk.
Change how much the service logs
/opt/gardience/gardience log-level debugThe levels are debug, info (the default) and warning. The setting is saved as GARDIENCE_LOG_LEVEL in .env, and the gardience service is recreated to apply it. Run the command with no level to see the usage line and the current setting.
This changes only the Gardience service. The Salt master's own log level is in its configuration.
Set it back to info when you are done: debug is verbose.
Build a support bundle
/opt/gardience/gardience support-bundleThis writes gardience-support-YYYYMMDD-HHMMSS.tar.gz in the install directory. Nothing is sent anywhere. Review the file, then attach it to your support request.
The bundle contains:
| File | Contents |
|---|---|
versions.txt | Gardience, Docker and Docker Compose versions, and uname -a. |
services.txt | Which services are running (docker compose ps). |
doctor.txt | The output of gardience doctor. |
log-SERVICE.txt | The last 3,000 lines of each service's log. |
env-keys.txt | The names of the settings in .env, with every value replaced by .... |
nginx.conf | The web server configuration. |
master-gardience.conf | The generated Salt master configuration. |
users.yaml | Account names and roles. Password hashes are replaced. |
health.json | The service's full health detail, including each component's problem. |
What is redacted
Before anything is written:
- Every secret value from
.env(SVC_PASS,AUTOMATION_PASS,GARDIENCE_INTERNAL_TOKEN,GARDIENCE_SSO_KEY,RUNNER_TOKEN) and the LDAP bind password fromusers.yamlare replaced with[REDACTED]wherever they appear. - Any value that follows a name like
password,passwd,bindpw,secret,client_secret,token,api_keyorkeyis replaced. - Anything that looks like an API key (
gdn_...) is replaced. - Password hashes in
users.yamlare replaced.
Redaction works on patterns, so read the bundle before you send it. Host names, node names and IP addresses are not removed.
What to send with a support request
- The support bundle.
- The time the problem happened, in your time zone.
- What the screen showed, or the exact error message.