README.rst
1.. zephyr:code-sample:: syslog-net
2 :name: Remote syslog
3 :relevant-api: log_backend log_ctrl
4
5 Enable a remote syslog service that sends syslog messages to a remote server
6
7Overview
8********
9
10This sample application enables a remote syslog service that will
11send syslog messages to a remote server, as configured in ``prj.conf``.
12See https://tools.ietf.org/html/rfc5424 and https://tools.ietf.org/html/rfc5426
13for more details about syslog protocol over UDP.
14
15The source code for this sample application can be found at:
16:zephyr_file:`samples/net/syslog_net`.
17
18Requirements
19************
20
21- :ref:`networking_with_host`
22
23Building and Running
24********************
25
26For configuring the remote IPv6 syslog server, set the following
27variables in prj.conf file:
28
29.. code-block:: cfg
30
31 CONFIG_LOG_BACKEND_NET=y
32 CONFIG_LOG_BACKEND_NET_SERVER="[2001:db8::2]:514"
33
34Default port number is 514 if user does not specify a value.
35The following syntax is supported for the server address
36and port:
37
38.. code-block:: console
39
40 192.0.2.1:514
41 192.0.2.42
42 [2001:db8::1]:514
43 [2001:db8::2]
44 2001:db::42
45
46Build syslog_net sample application like this:
47
48.. zephyr-app-commands::
49 :zephyr-app: samples/net/syslog_net
50 :board: <board to use>
51 :conf: <config file to use>
52 :goals: build
53 :compact:
54
55Wi-Fi
56=====
57
58The IPv4 Wi-Fi support can be enabled in the sample with
59:ref:`Wi-Fi snippet <snippet-wifi-ipv4>`.
60