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