Skip to content

Commit 7e2c951

Browse files
author
jesperpedersen
committed
Add new configuration options
1 parent f42f8ab commit 7e2c951

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

doc/man/pgagroal.conf.5.rst

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,46 @@ unix_socket_dir
3939
metrics
4040
The metrics port. Default is 0 (disabled)
4141

42+
metrics_cache_max_age
43+
The number of seconds to keep in cache a Prometheus (metrics) response.
44+
If set to zero, the caching will be disabled. Can be a string with a suffix, like ``2m`` to indicate 2 minutes.
45+
Default is 0 (disabled)
46+
47+
metrics_cache_max_size
48+
The maximum amount of data to keep in cache when serving Prometheus responses. Changes require restart.
49+
This parameter determines the size of memory allocated for the cache even if ``metrics_cache_max_age`` or
50+
``metrics`` are disabled. Its value, however, is taken into account only if ``metrics_cache_max_age`` is set
51+
to a non-zero value. Supports suffixes: ``B`` (bytes), the default if omitted, ``K`` or ``KB`` (kilobytes),
52+
``M`` or ``MB`` (megabytes), ``G`` or ``GB`` (gigabytes).
53+
Default is 256k
54+
4255
management
4356
The remote management port. Default is 0 (disabled)
4457

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

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

5166
log_path
52-
The log file location. Default is pgagroal.log
67+
The log file location. Default is pgagroal.log. Can be a strftime(3) compatible string
68+
69+
log_rotation_age
70+
The age that will trigger a log file rotation. If expressed as a positive number, is managed as seconds.
71+
Supports suffixes: ``S`` (seconds, the default), ``M`` (minutes), ``H`` (hours), ``D`` (days), ``W`` (weeks).
72+
A value of ``0`` disables. Default is 0 (disabled)
73+
74+
log_rotation_size
75+
The size of the log file that will trigger a log rotation. Supports suffixes: ``B`` (bytes), the default if omitted,
76+
``K`` or ``KB`` (kilobytes), ``M`` or ``MB`` (megabytes), ``G`` or ``GB`` (gigabytes). A value of ``0`` (with or without suffix) disables.
77+
Default is 0
78+
79+
log_line_prefix
80+
A strftime(3) compatible string to use as prefix for every log line. Must be quoted if contains spaces.
81+
Default is ``%Y-%m-%d %H:%M:%S``
5382

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

138167
pidfile
139-
Path to the PID file
168+
Path to the PID file. If omitted, automatically set to ``unix_socket_dir/pgagroal.port.pid``
169+
170+
update_process_title
171+
The behavior for updating the operating system process title, mainly related to connection processes.
172+
Allowed settings are: ``never`` (or ``off``), does not update the process title; ``strict`` to set the
173+
process title without overriding the existing initial process title length; ``minimal`` to set the process
174+
title to ``username/database``; ``verbose`` (or ``full``) to set the process title to ``user@host:port/database``.
175+
Please note that ``strict`` and ``minimal`` are honored only on those systems that do not provide a native way
176+
to set the process title (e.g., Linux). On other systems, there is no difference between ``strict`` and ``minimal``
177+
and the assumed behaviour is ``minimal`` even if ``strict`` is used. ``never`` and ``verbose`` are always honored,
178+
on every system. On Linux systems the process title is always trimmed to 255 characters, while on system that
179+
provide a natve way to set the process title it can be longer
140180

141181
Danger zone
142182

0 commit comments

Comments
 (0)