hjp
/
switchinglogfilehandlers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Document parameters

This commit is contained in:
Peter J. Holzer 2024-02-28 22:00:23 +01:00
parent f27be774a8
commit a2706282de
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -11,7 +11,19 @@ TimedSwitchingFileHandler
-------------------------
This file handler starts a new file at regular intervals, comparable to
the TimedRotatingFileHandler.
the TimedRotatingFileHandler. The switch always occurs at a “round”
time, i.e. at the hour for hourly switches, at midnight for daily
switches, etc. The old file stays open until just before the first log
entry is written to the new file.
### Parameters
| Parameter | Default | Description |
|-|-|-|
| `filename` | (required) | Path to the log files. The timestamp and `.log` is appended |
| `when` | `'h'` | When log files are switched: (every **s**econd, **m**inute, **h**our, **d**ay, **w**eek) |
| `utc` | `False` | Timestamps are in UTC (otherwise local time) |
| `create_directory` | `False` | Intermediate directories in `filename` are created if necessary |
TimeoutSwitchingFileHandler
---------------------------
@ -25,3 +37,12 @@ activity alternate with periods of inactivity. Log switchse will
typically occur during inactivity, so each log file will include one
complete active period. Also, since the log files are closed, they can
be safely compressed or removed.
### Parameters
| Parameter | Default | Description |
|-|-|-|
| `filename` | (required) | Path to the log files. The timestamp is appended |
| `min_timeout` | `60` | Logfile is closed if there hasn't been any activity for `min_timeout` seconds |
| `max_timeout` | `3600` | Logfile is closed if is has been created `max_timeout` seconds ago |
| `create_directory` | `False` | Intermediate directories in `filename` are created if necessary |