[bitnami/pgbouncer] log to stdout only by default

[taraspos]

Description of the change

Add option to disable logging to file by setting PGBOUNCER_LOG_FILE=disable.
Change default to log to stdout only (instead of stdout and file) by default.

Benefits

pgbouncer is running in the foreground (without the -d flag) mode so logs are written to stdout anyway.

When running on Kubernetes/ECS/etc this is enough and having same information in a logfile is unnecessary. From my experience this logfile can grow quite large and having option to disable can fix potential disk space problems.

logfile definition from pgbouncer config documentation:

Generic settings

logfile
Specifies the log file. For daemonization (-d), either this or syslog need to be set.

The log file is kept open, so after rotation, kill -HUP or on console RELOAD; should be done. On Windows, the service must be stopped and started.

Note that setting logfile does not by itself turn off logging to stderr. Use the command-line option -q or -d for that.

Default: not set

Possible drawbacks

N/A

Applicable issues

• fixes [bitnami/pgbouncer] Option to disable writing logs to a file #68508

Additional information

pgbouncer.ini with default PGBOUNCER_LOG_FILE value

[databases]
postgres=host=postgresql port=5432 dbname=postgres

[pgbouncer]
listen_port=6432
listen_addr=0.0.0.0
unix_socket_dir=/tmp/
unix_socket_mode=0777
auth_file=/opt/bitnami/pgbouncer/conf/userlist.txt
auth_type=scram-sha-256
pidfile=/opt/bitnami/pgbouncer/tmp/pgbouncer.pid
admin_users=postgres
client_tls_sslmode=disable
server_tls_sslmode=disable
ignore_startup_parameters=extra_float_digits
stats_period=60
server_round_robin=0
server_fast_close=0

pgbouncer.ini with PGBOUNCER_LOG_FILE=/tmp/test

[databases]
postgres=host=postgresql port=5432 dbname=postgres

[pgbouncer]
listen_port=6432
listen_addr=0.0.0.0
unix_socket_dir=/tmp/
unix_socket_mode=0777
auth_file=/opt/bitnami/pgbouncer/conf/userlist.txt
auth_type=scram-sha-256
pidfile=/opt/bitnami/pgbouncer/tmp/pgbouncer.pid
logfile=/tmp/test
admin_users=postgres
client_tls_sslmode=disable
server_tls_sslmode=disable
ignore_startup_parameters=extra_float_digits
stats_period=60
server_round_robin=0
server_fast_close=0

[lancedikson]

Would be nice to have this feature! LGTM! 👍

[migruiz4]

Hi @taraspos,

Thank you very much for your contribution! Although, I would like to request some changes.

Because the best practice for containers would be to only log to stdout, to prevent filling the container filesystem with unnecessary files, I would like to make it the default behavior.

To do so, I would like to request the following changes:

• Remove the extra logic from libpgbouncer.sh
• Change the default value at pgbouncer-env.sh:

- export PGBOUNCER_LOG_FILE="${PGBOUNCER_LOG_FILE:-${PGBOUNCER_LOG_DIR}/pgbouncer.log}"
+ export PGBOUNCER_LOG_FILE="${PGBOUNCER_LOG_FILE:-}"

• Update the README.md with the new value and description for the variable PGBOUNCER_LOG_FILE:

- | `PGBOUNCER_LOG_FILE`                  | PgBouncer log file.                                                                                                                                                                        | `${PGBOUNCER_LOG_DIR}/pgbouncer.log` |
+ | `PGBOUNCER_LOG_FILE`                  | If set, log PgBouncer output to log file in addition to stdout.                                                                                                                            | `nil`                                |

[taraspos]

@migruiz4 all done!

[migruiz4]

Thank you very much!

[taraspos]

@migruiz4 thank you!
Is this ready to be merged now?

[lancedikson]

May I ask what the ETA for the release is? :)

[migruiz4]

I triggered a new release now, so in about 30 more minutes or so a new PR should be submitted, tested, and merged automatically if everything goes well.
Shortly after the image should be available in Dockerhub as well.

[taraspos]

It's out 🎉

• [bitnami/pgbouncer] Release 1.23.0-debian-12-r2 #69156

[lancedikson]

Thanks! 💪