Skip to content

Commit

Permalink
Add new configuration options
Browse files Browse the repository at this point in the history
  • Loading branch information
jesperpedersen committed Aug 26, 2022
1 parent f42f8ab commit 7e2c951
Showing 1 changed file with 43 additions and 3 deletions.
46 changes: 43 additions & 3 deletions doc/man/pgagroal.conf.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,46 @@ unix_socket_dir
metrics
The metrics port. Default is 0 (disabled)

metrics_cache_max_age
The number of seconds to keep in cache a Prometheus (metrics) response.
If set to zero, the caching will be disabled. Can be a string with a suffix, like ``2m`` to indicate 2 minutes.
Default is 0 (disabled)

metrics_cache_max_size
The maximum amount of data to keep in cache when serving Prometheus responses. Changes require restart.
This parameter determines the size of memory allocated for the cache even if ``metrics_cache_max_age`` or
``metrics`` are disabled. Its value, however, is taken into account only if ``metrics_cache_max_age`` is set
to a non-zero value. Supports suffixes: ``B`` (bytes), the default if omitted, ``K`` or ``KB`` (kilobytes),
``M`` or ``MB`` (megabytes), ``G`` or ``GB`` (gigabytes).
Default is 256k

management
The remote management port. Default is 0 (disabled)

log_type
The logging type (console, file, syslog). Default is console

log_level
The logging level (fatal, error, warn, info, debug1, ..., debug5). Default is info
The logging level, any of the (case insensitive) strings ``FATAL``, ``ERROR``, ``WARN``, ``INFO`` and ``DEBUG``
(that can be more specific as ``DEBUG1`` thru ``DEBUG5``). Debug level greater than 5 will be set to ``DEBUG5``.
Not recognized values will make the ``log_level`` be ``INFO``. Default is info

log_path
The log file location. Default is pgagroal.log
The log file location. Default is pgagroal.log. Can be a strftime(3) compatible string

log_rotation_age
The age that will trigger a log file rotation. If expressed as a positive number, is managed as seconds.
Supports suffixes: ``S`` (seconds, the default), ``M`` (minutes), ``H`` (hours), ``D`` (days), ``W`` (weeks).
A value of ``0`` disables. Default is 0 (disabled)

log_rotation_size
The size of the log file that will trigger a log rotation. Supports suffixes: ``B`` (bytes), the default if omitted,
``K`` or ``KB`` (kilobytes), ``M`` or ``MB`` (megabytes), ``G`` or ``GB`` (gigabytes). A value of ``0`` (with or without suffix) disables.
Default is 0

log_line_prefix
A strftime(3) compatible string to use as prefix for every log line. Must be quoted if contains spaces.
Default is ``%Y-%m-%d %H:%M:%S``

log_mode
Append to or create the log file (append, create). Default is append
Expand Down Expand Up @@ -136,7 +165,18 @@ track_prepared_statements
Track prepared statements (transaction pooling). Default is off

pidfile
Path to the PID file
Path to the PID file. If omitted, automatically set to ``unix_socket_dir/pgagroal.port.pid``

update_process_title
The behavior for updating the operating system process title, mainly related to connection processes.
Allowed settings are: ``never`` (or ``off``), does not update the process title; ``strict`` to set the
process title without overriding the existing initial process title length; ``minimal`` to set the process
title to ``username/database``; ``verbose`` (or ``full``) to set the process title to ``user@host:port/database``.
Please note that ``strict`` and ``minimal`` are honored only on those systems that do not provide a native way
to set the process title (e.g., Linux). On other systems, there is no difference between ``strict`` and ``minimal``
and the assumed behaviour is ``minimal`` even if ``strict`` is used. ``never`` and ``verbose`` are always honored,
on every system. On Linux systems the process title is always trimmed to 255 characters, while on system that
provide a natve way to set the process title it can be longer

Danger zone

Expand Down

0 comments on commit 7e2c951

Please sign in to comment.