github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_syslog (markdown)

master
Chris Caron 2021-09-18 14:10:01 -04:00
parent 0195e46141
commit e45b4f7f62
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Notify_syslog.md

@ -10,13 +10,22 @@ Syslog is a way for network devices to send event messages to a logging server
Valid syntaxes are as follows: Valid syntaxes are as follows:
* `syslog://` * `syslog://`
* `syslog://{facility}` * `syslog://{facility}`
* `syslog://{host}`
* `syslog://{host}:{port}`
* `syslog://{host}/{facility}`
* `syslog://{host}:{port}/{facility}`
One might change the facility from it's default like so: One might change the facility from it's default like so:
* `syslog://local5` * `syslog://local5`
One might change the facility on a remote syslog (rsyslog) server from it's default like so:
* `syslog://localhost/local5`
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | Variable | Required | Description
| ----------- | -------- | ----------- | ----------- | -------- | -----------
| host | No | Query a remote Syslog server (rsyslog) by optionally specifying the hostname
| port | No | The remote port associated with your rsyslog server provided. By default if this value isn't sent port **514** is used by default.
| facility | No | The facility to use, by default it is `user`. Valid options are **kern**, **user**, **mail**, **daemon**, **auth**, **syslog**, **lpr**, **news**, **uucp**, **cron**, **local0**, **local1**, **local2**, **local3**, **local4**, **local5**, **local6**, and **local7** | facility | No | The facility to use, by default it is `user`. Valid options are **kern**, **user**, **mail**, **daemon**, **auth**, **syslog**, **lpr**, **news**, **uucp**, **cron**, **local0**, **local1**, **local2**, **local3**, **local4**, **local5**, **local6**, and **local7**
| logperror | No | Additionally send the log message to _stderr_. This method is ignored when preforming a remote query. | logperror | No | Additionally send the log message to _stderr_. This method is ignored when preforming a remote query.
| logpid | Yes | Include PID as part of the log output. | logpid | Yes | Include PID as part of the log output.