Skip to content
BILLETKnowledge Base

Collect logs for support

Where each part of Billet writes its log, how to turn on more detail, and what to send with a support request.

For
Administrators
Applies to
Billet 1.0
Updated

What to send

  • What happened, and what you expected.
  • The time it happened, with the time zone.
  • The desktop's name, and the person's sign-in address, if it is about one session.
  • The version of each part involved. Every Billet program writes its version and build as the first line of its log.
  • The logs below, for the parts involved.

Logs can contain machine names, addresses and sign-in addresses. They never contain passwords, and Billet never logs what Type Clipboard types.

Where the logs are

Part Log
Desktop app on Windows %LOCALAPPDATA%\billet\logs (one file per session)
Desktop app on a Mac ~/.local/state/billet/logs (one file per session)
Billet Host and the Billet stats agent (Windows) %ProgramData%\Billet\logs
Portal journalctl -u billet-portal
Relay journalctl -u billet-relay -u billet-relay-agent

On a portal or relay server, to collect the last day:

journalctl -u billet-portal --since "24 hours ago" --no-pager > billet-portal.log
journalctl -u billet-relay -u billet-relay-agent --since "24 hours ago" --no-pager > billet-relay.log

More detail

Ask Billet support which level to use before turning one up, because the most detailed levels are large. Set it back afterwards.

Relay, stats agent and host agent read the BILLET_LOG setting from their environment. Unset, they log at info. On a relay server:

sudo systemctl edit billet-relay
#   [Service]
#   Environment=BILLET_LOG=debug
sudo systemctl restart billet-relay

On a Windows host, add a line BILLET_LOG=debug to the Environment value (a multi-string) under HKLM\SYSTEM\CurrentControlSet\Services\billet-host-agent, then restart the Billet host agent service. Reinstalling or upgrading Billet Host rewrites that value, which also removes the line.

Portal: add BEAM_LOG_LEVEL=debug to /etc/billet/portal.env, then sudo systemctl restart billet-portal.

From the console

The console's Audit page records who changed what, and each desktop's page shows its recent sessions and check-ins, which often answers the question without any log.