zephyr/samples/net/syslog_net
Reto Schneider 0b4b3ae4dd cmake, samples, tests: Use semi-accurate project names
When using an IDE (e.g. Eclipse, Qt Creator), the project name gets
displayed. This greatly simplifies the navigation between projects when
having many of them open at the same time. Naming multiple projects
"NONE" defeats this functionality.

This patch tries to use sensible project names while not duplicating
too much of what is already represented in the path. This is done by
using the name of the directory the relevant CMakeLists.txt file is
stored in. To ensure unique project names, small, manual adjustments
have been done.

See also 7eabab2f5d ("samples, tests: Use semi-accurate project names")

Signed-off-by: Reto Schneider <reto.schneider@husqvarnagroup.com>
2020-06-09 08:18:29 -04:00
..
src samples: net: syslog: Fix to use proper data type for sleep 2020-04-09 16:07:03 +03:00
CMakeLists.txt cmake, samples, tests: Use semi-accurate project names 2020-06-09 08:18:29 -04:00
prj.conf samples: syslog_net: Remove ref. to CONFIG_SYS_LOG_BACKEND_NET_SERVER 2019-12-09 12:55:07 -05:00
README.rst doc: use :zephyr_file: where appropriate 2019-03-09 09:50:27 -05:00
sample.yaml samples: add test identifier 2019-03-29 17:44:11 -04: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: