Logging¶
What Is Logged¶
By default, Citus Cloud logs all errors and other useful information that happen on any of the Citus instances and makes it available to you.
The logs will contain the following messages:
- Citus and PostgreSQL errors
- Slow queries that take longer than 30 seconds
- Checkpoint statistics
- Temporary files that are written and bigger than 64 MB
- Autovacuum that takes more than 30 seconds
Recent Logs¶
The Citus Cloud dashboard automatically shows you the most recent 100 log lines from each of your servers. You don’t need to configure anything to access this information.
External Log Destinations¶
For anything more than a quick look at your logs, we recommend setting up an external provider as a log destination. Through this method you’ll receive all logs using the Syslog protocol, and can analyze and retain them according to your own preferences.
As an example, the process for setting up Papertrail, a common log provider, goes like this:
- Determine Syslog host and port number (note that Citus only supports providers that can accept incoming Syslog data)
- Add a new log destination in your Citus Cloud dashboard in the “Logs” tab, like this:
For Papertrail leave Message Template empty. Other providers might require a token to be set - follow the syslog-ng instructions for the provider, if they make them available.
- After creation, it might take up to 5 minutes for logging to be configured. You’ll then see it show up in your favorite provider’s dashboard.
Supported External Providers¶
We’re currently testing with these providers:
- Papertrail
- Splunk Enterprise
- Loggly
We likely also support other providers that can receive syslog. Please reach out if you encounter any issues.