zephyr/samples/net/syslog_net
Jukka Rissanen 6136965251 samples: net: syslog: Add info how to manually start net backend
If CONFIG_LOG_BACKEND_NET_AUTOSTART is disabled, then the syslog
network backend is not started automatically. This option is
enabled by default but it might be that application needs to
start the backend manually if the network is slow to start or
some special routes needs to be set by the application.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2021-01-26 07:12:14 -05:00
..
boards samples: net: syslog: Add Docker based testing support 2020-12-09 15:56:44 +02:00
src samples: net: syslog: Add info how to manually start net backend 2021-01-26 07:12:14 -05:00
CMakeLists.txt cmake, samples, tests: Use semi-accurate project names 2020-06-09 08:18:29 -04:00
docker-test.sh samples: net: syslog: Add Docker based testing support 2020-12-09 15:56:44 +02:00
Kconfig samples: net: syslog: Add Docker based testing support 2020-12-09 15:56:44 +02:00
prj.conf logging: Revamp menuconfig 2021-01-26 06:15:42 -05:00
README.rst
sample.yaml samples: net: syslog: Add info how to manually start net backend 2021-01-26 07:12:14 -05:00

.. _syslog-net-sample:

Syslog net Application
######################

Overview
********

This sample application enables a remote syslog service that will
send syslog messages to a remote server, as configured in ``prj.conf``.
See https://tools.ietf.org/html/rfc5424 and https://tools.ietf.org/html/rfc5426
for more details about syslog protocol over UDP.

The source code for this sample application can be found at:
:zephyr_file:`samples/net/syslog_net`.

Requirements
************

- :ref:`networking_with_host`

Building and Running
********************

For configuring the remote IPv6 syslog server, set the following
variables in prj.conf file:

.. code-block:: console

	CONFIG_LOG_BACKEND_NET=y
	CONFIG_LOG_BACKEND_NET_SERVER="[2001:db8::2]:514"

Default port number is 514 if user does not specify a value.
The following syntax is supported for the server address
and port:

.. code-block:: console

	192.0.2.1:514
	192.0.2.42
	[2001:db8::1]:514
	[2001:db8::2]
	2001:db::42

Build syslog_net sample application like this:

.. zephyr-app-commands::
   :zephyr-app: samples/net/syslog_net
   :board: <board to use>
   :conf: <config file to use>
   :goals: build
   :compact: