1
0
mirror of https://github.com/weechat/weechat.git synced 2026-07-04 00:33:13 +02:00

doc/user: add chapter on log file rotation/compression

This commit is contained in:
Sébastien Helleu
2022-09-29 09:46:43 +02:00
parent 486df38a8d
commit 9817372553
7 changed files with 300 additions and 0 deletions
+43
View File
@@ -2475,6 +2475,49 @@ Erstellt eine Struktur in folgender Form:
...
....
// TRANSLATION MISSING
[[logger_rotation_compression]]
==== Rotation and compression
It is possible to define a max size for log files, and when it is reached,
there is automatic rotation of log file.
The rotated log files can be compressed with gzip or
https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
[NOTE]
As the compression of a file can take some time, it is performed in background.
Example with a max size of 2GB and compression with gzip, using good compression
level (slower than default one):
----
/set logger.file.rotation_compression_type gzip
/set logger.file.rotation_compression_level 80
/set logger.file.rotation_size_max "2g"
----
If you want to use a decimal number, you can use the unit below and multiply
by 1000, for example to set max size to 2.5GB:
----
/set logger.file.rotation_size_max "2500m"
----
With these settings, you'll end with files like these ones (in this example
there is rotation only for the log of #weechat channel):
....
~/.local/share/weechat
└── logs
├── core.weechat.weechatlog
├── irc.server.libera.weechatlog
├── irc.libera.#weechat.weechatlog
├── irc.libera.#weechat.weechatlog.1.gz
├── irc.libera.#weechat.weechatlog.2.gz
└── irc.libera.#weechat.weechatlog.3.gz
....
[[logger_commands]]
==== Befehle
+42
View File
@@ -2430,6 +2430,48 @@ You'll have following files:
...
....
[[logger_rotation_compression]]
==== Rotation and compression
It is possible to define a max size for log files, and when it is reached,
there is automatic rotation of log file.
The rotated log files can be compressed with gzip or
https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
[NOTE]
As the compression of a file can take some time, it is performed in background.
Example with a max size of 2GB and compression with gzip, using good compression
level (slower than default one):
----
/set logger.file.rotation_compression_type gzip
/set logger.file.rotation_compression_level 80
/set logger.file.rotation_size_max "2g"
----
If you want to use a decimal number, you can use the unit below and multiply
by 1000, for example to set max size to 2.5GB:
----
/set logger.file.rotation_size_max "2500m"
----
With these settings, you'll end with files like these ones (in this example
there is rotation only for the log of #weechat channel):
....
~/.local/share/weechat
└── logs
├── core.weechat.weechatlog
├── irc.server.libera.weechatlog
├── irc.libera.#weechat.weechatlog
├── irc.libera.#weechat.weechatlog.1.gz
├── irc.libera.#weechat.weechatlog.2.gz
└── irc.libera.#weechat.weechatlog.3.gz
....
[[logger_commands]]
==== Commands
+43
View File
@@ -2499,6 +2499,49 @@ Vous obtiendrez les fichiers suivants :
...
....
[[logger_rotation_compression]]
==== Rotation et compression
Il est possible de définir une taille maximale pour les fichiers de logs, et
lorsqu'elle est atteinte, il y a une rotation automatique du fichier de log.
Les fichiers de logs qui ont tourné peuvent être compressés avec gzip ou
https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
[NOTE]
La compression du fichier pouvant prendre du temps, elle est exécutée en tâche
de fond.
Exemple avec une taille maximale de 2 Go et la compression avec gzip, en utilisant
un bon niveau de compression (plus lent que celui par défaut) :
----
/set logger.file.rotation_compression_type gzip
/set logger.file.rotation_compression_level 80
/set logger.file.rotation_size_max "2g"
----
Si vous voulez utiliser un nombre décimal, vous pouvez utiliser l'unité en
dessous et multiplier par 1000, par exemple pour une taille maximale de 2,5 Go :
----
/set logger.file.rotation_size_max "2500m"
----
Avec cette configuration, vous aurez des fichiers comme ceux-ci (dans cet exemple
il y a eu une rotation seulement pour le log du canal "#weechat"):
....
~/.local/share/weechat
└── logs
├── core.weechat.weechatlog
├── irc.server.libera.weechatlog
├── irc.libera.#weechat.weechatlog
├── irc.libera.#weechat.weechatlog.1.gz
├── irc.libera.#weechat.weechatlog.2.gz
└── irc.libera.#weechat.weechatlog.3.gz
....
[[logger_commands]]
==== Commandes
+43
View File
@@ -2652,6 +2652,49 @@ Si avranno i seguenti file:
...
....
// TRANSLATION MISSING
[[logger_rotation_compression]]
==== Rotation and compression
It is possible to define a max size for log files, and when it is reached,
there is automatic rotation of log file.
The rotated log files can be compressed with gzip or
https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
[NOTE]
As the compression of a file can take some time, it is performed in background.
Example with a max size of 2GB and compression with gzip, using good compression
level (slower than default one):
----
/set logger.file.rotation_compression_type gzip
/set logger.file.rotation_compression_level 80
/set logger.file.rotation_size_max "2g"
----
If you want to use a decimal number, you can use the unit below and multiply
by 1000, for example to set max size to 2.5GB:
----
/set logger.file.rotation_size_max "2500m"
----
With these settings, you'll end with files like these ones (in this example
there is rotation only for the log of #weechat channel):
....
~/.local/share/weechat
└── logs
├── core.weechat.weechatlog
├── irc.server.libera.weechatlog
├── irc.libera.#weechat.weechatlog
├── irc.libera.#weechat.weechatlog.1.gz
├── irc.libera.#weechat.weechatlog.2.gz
└── irc.libera.#weechat.weechatlog.3.gz
....
[[logger_commands]]
==== Comandi
+43
View File
@@ -2550,6 +2550,49 @@ IRC サーバ名を使ったディレクトリに、チャンネル名を使っ
...
....
// TRANSLATION MISSING
[[logger_rotation_compression]]
==== Rotation and compression
It is possible to define a max size for log files, and when it is reached,
there is automatic rotation of log file.
The rotated log files can be compressed with gzip or
https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
[NOTE]
As the compression of a file can take some time, it is performed in background.
Example with a max size of 2GB and compression with gzip, using good compression
level (slower than default one):
----
/set logger.file.rotation_compression_type gzip
/set logger.file.rotation_compression_level 80
/set logger.file.rotation_size_max "2g"
----
If you want to use a decimal number, you can use the unit below and multiply
by 1000, for example to set max size to 2.5GB:
----
/set logger.file.rotation_size_max "2500m"
----
With these settings, you'll end with files like these ones (in this example
there is rotation only for the log of #weechat channel):
....
~/.local/share/weechat
└── logs
├── core.weechat.weechatlog
├── irc.server.libera.weechatlog
├── irc.libera.#weechat.weechatlog
├── irc.libera.#weechat.weechatlog.1.gz
├── irc.libera.#weechat.weechatlog.2.gz
└── irc.libera.#weechat.weechatlog.3.gz
....
[[logger_commands]]
==== コマンド
+43
View File
@@ -2464,6 +2464,49 @@ Spowoduje powstanie następującej struktury:
...
....
// TRANSLATION MISSING
[[logger_rotation_compression]]
==== Rotation and compression
It is possible to define a max size for log files, and when it is reached,
there is automatic rotation of log file.
The rotated log files can be compressed with gzip or
https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
[NOTE]
As the compression of a file can take some time, it is performed in background.
Example with a max size of 2GB and compression with gzip, using good compression
level (slower than default one):
----
/set logger.file.rotation_compression_type gzip
/set logger.file.rotation_compression_level 80
/set logger.file.rotation_size_max "2g"
----
If you want to use a decimal number, you can use the unit below and multiply
by 1000, for example to set max size to 2.5GB:
----
/set logger.file.rotation_size_max "2500m"
----
With these settings, you'll end with files like these ones (in this example
there is rotation only for the log of #weechat channel):
....
~/.local/share/weechat
└── logs
├── core.weechat.weechatlog
├── irc.server.libera.weechatlog
├── irc.libera.#weechat.weechatlog
├── irc.libera.#weechat.weechatlog.1.gz
├── irc.libera.#weechat.weechatlog.2.gz
└── irc.libera.#weechat.weechatlog.3.gz
....
[[logger_commands]]
==== Komendy
+43
View File
@@ -2289,6 +2289,49 @@ logger.file.mask
...
....
// TRANSLATION MISSING
[[logger_rotation_compression]]
==== Rotation and compression
It is possible to define a max size for log files, and when it is reached,
there is automatic rotation of log file.
The rotated log files can be compressed with gzip or
https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
[NOTE]
As the compression of a file can take some time, it is performed in background.
Example with a max size of 2GB and compression with gzip, using good compression
level (slower than default one):
----
/set logger.file.rotation_compression_type gzip
/set logger.file.rotation_compression_level 80
/set logger.file.rotation_size_max "2g"
----
If you want to use a decimal number, you can use the unit below and multiply
by 1000, for example to set max size to 2.5GB:
----
/set logger.file.rotation_size_max "2500m"
----
With these settings, you'll end with files like these ones (in this example
there is rotation only for the log of #weechat channel):
....
~/.local/share/weechat
└── logs
├── core.weechat.weechatlog
├── irc.server.libera.weechatlog
├── irc.libera.#weechat.weechatlog
├── irc.libera.#weechat.weechatlog.1.gz
├── irc.libera.#weechat.weechatlog.2.gz
└── irc.libera.#weechat.weechatlog.3.gz
....
[[logger_commands]]
==== Команде