Using timescaledb-tune

To streamline the configuration process, we’ve created a tool called timescaledb-tune that handles setting the most common parameters to good values based on your system, accounting for memory, CPU, and PostgreSQL version. timescaledb-tune is packaged along with our binary releases as a dependency, so if you installed one of our binary releases (including Docker), you should have access to the tool. Alternatively, with a standard Go environment, you can also go get the repository to install it.

timescaledb-tune reads your system’s postgresql.conf file and offers interactive suggestions for updating your settings:

  1. Using postgresql.conf at this path:
  2. /usr/local/var/postgres/postgresql.conf
  4. Is this correct? [(y)es/(n)o]: y
  5. Writing backup to:
  6. /var/folders/cr/zpgdkv194vz1g5smxl_5tggm0000gn/T/timescaledb_tune.backup201901071520
  8. shared_preload_libraries needs to be updated
  9. Current:
  10. #shared_preload_libraries = 'timescaledb'
  11. Recommended:
  12. shared_preload_libraries = 'timescaledb'
  13. Is this okay? [(y)es/(n)o]: y
  14. success: shared_preload_libraries will be updated
  16. Tune memory/parallelism/WAL and other settings? [(y)es/(n)o]: y
  17. Recommendations based on 8.00 GB of available memory and 4 CPUs for PostgreSQL 11
  19. Memory settings recommendations
  20. Current:
  21. shared_buffers = 128MB
  22. #effective_cache_size = 4GB
  23. #maintenance_work_mem = 64MB
  24. #work_mem = 4MB
  25. Recommended:
  26. shared_buffers = 2GB
  27. effective_cache_size = 6GB
  28. maintenance_work_mem = 1GB
  29. work_mem = 26214kB
  30. Is this okay? [(y)es/(s)kip/(q)uit]:

These changes are then written to your postgresql.conf and will take effect on the next (re)start. If you are starting on fresh instance and don’t feel the need to approve each group of changes, you can also automatically accept and append the suggestions to the end of your postgresql.conf like so:

  1. $ timescaledb-tune --quiet --yes --dry-run >> /path/to/postgresql.conf