mirror of
https://github.com/bluenviron/mediamtx.git
synced 2026-01-20 02:19:48 -08:00
9e9fae9a10
Some checks are pending
code_lint / go (push) Waiting to run
code_lint / go_mod (push) Waiting to run
code_lint / docs (push) Waiting to run
code_lint / api_docs (push) Waiting to run
code_test / test_64 (push) Waiting to run
code_test / test_32 (push) Waiting to run
code_test / test_e2e (push) Waiting to run
Co-authored-by: aler9 <46489434+aler9@users.noreply.github.com>
86 lines
2.2 KiB
Markdown
86 lines
2.2 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](start-on-boot), 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 (JSON).
|
|
logStructured: true
|
|
```
|
|
|
|
Obtaining:
|
|
|
|
```
|
|
{"timestamp":"2003-05-01T20:34:14+01:00","level":"INF","message":"[RTSP] listener opened on :8554 (TCP), :8000 (UDP/RTP), :8001 (UDP/RTCP)"}
|
|
```
|
|
|
|
## 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
|
|
...
|
|
```
|