mirror of
https://github.com/aler9/rtsp-simple-server
synced 2026-04-22 23:17:11 +08:00
Alessandro Ros
91 lines
2.7 KiB
Markdown
91 lines
2.7 KiB
Markdown
# Logging
|
|
|
|
## Log verbosity
|
|
|
|
Log verbosity can be set with the `logLevel` parameter:
|
|
|
|
```yml
|
|
# Verbosity of the program; available values are "error", "warn", "info", "debug".
|
|
logLevel: info
|
|
```
|
|
|
|
## Log destinations
|
|
|
|
Log entries can be sent to multiple destinations. By default, they are printed on the console (stdout).
|
|
|
|
It is possible to write logs to a file by using these parameters:
|
|
|
|
```yml
|
|
# Destinations of log messages; available values are "stdout", "file" and "syslog".
|
|
logDestinations: [file]
|
|
# If "file" is in logDestinations, this is the file which will receive the logs.
|
|
logFile: mediamtx.log
|
|
```
|
|
|
|
It is possible to write logs to the system logging server (syslog) by using these parameters:
|
|
|
|
```yml
|
|
# Destinations of log messages; available values are "stdout", "file" and "syslog".
|
|
logDestinations: [syslog]
|
|
# If "syslog" is in logDestinations, use prefix for logs.
|
|
sysLogPrefix: mediamtx
|
|
```
|
|
|
|
Log entries can be queried by using:
|
|
|
|
```sh
|
|
journalctl SYSLOG_IDENTIFIER=mediamtx
|
|
```
|
|
|
|
If _MediaMTX_ is also running as a [system service](18-start-on-boot.md), log entries can be queried by using:
|
|
|
|
```sh
|
|
journalctl -u mediamtx
|
|
```
|
|
|
|
## Structured logging
|
|
|
|
Log collectors (like Loki, Logstash, CloudWatch and fluentd) parse logs in a more reliable way if they are fed with entries in structured format (JSONL). This can be enabled with the `logStructured` parameter:
|
|
|
|
```yml
|
|
# When destination is "stdout" or "file", emit logs in structured format (JSONL).
|
|
logStructured: true
|
|
```
|
|
|
|
Obtaining:
|
|
|
|
```
|
|
{"timestamp":"20XX-YY-ZZT10:45:05.999999999+01:00","level":"INF","message":"[RTSP] listener opened on :8554 (TCP/RTSP), :8000 (UDP/RTP), :8001 (UDP/RTCP)"}
|
|
{"timestamp":"20XX-YY-ZZT10:45:05.999999999+01:00","level":"INF","message":"[RTMP] listener opened on :1935"}
|
|
{"timestamp":"20XX-YY-ZZT10:45:05.999999999+01:00","level":"INF","message":"[HLS] listener opened on :8888"}
|
|
{"timestamp":"20XX-YY-ZZT10:45:05.999999999+01:00","level":"INF","message":"[WebRTC] listener opened on :8889 (TCP/HTTP), :8189 (UDP/ICE)"}
|
|
{"timestamp":"20XX-YY-ZZT10:45:05.999999999+01:00","level":"INF","message":"[SRT] listener opened on :8890 (UDP)"}
|
|
```
|
|
|
|
## Log file rotation
|
|
|
|
The log file can be periodically rotated or truncated by using an external utility.
|
|
|
|
On most Linux distributions, the `logrotate` utility is in charge of managing log files. It can be configured to handle the _MediaMTX_ log file too by creating a configuration file, placed in `/etc/logrotate.d/mediamtx`, with this content:
|
|
|
|
```
|
|
/my/mediamtx/path/mediamtx.log {
|
|
daily
|
|
copytruncate
|
|
rotate 7
|
|
compress
|
|
delaycompress
|
|
missingok
|
|
notifempty
|
|
}
|
|
```
|
|
|
|
This file will rotate the log file every day, adding a `.NUMBER` suffix to older copies:
|
|
|
|
```
|
|
mediamtx.log.1
|
|
mediamtx.log.2
|
|
mediamtx.log.3
|
|
...
|
|
```
|