zephyr

History

David B. Kinder 505cc2bb0e doc: use :zephyr_file: where appropriate A new role :zephyr_file: is available that renders to a link to the file or folder in GitHub. Find appropriate references using :file: and convert to :zephyr_file: to take advantage of its linking capability. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>		2019-03-09 09:50:27 -05:00
..
src	samples: net: Convert to use generic logging macros	2018-12-07 12:00:04 +02:00
CMakeLists.txt	cmake: increase minimal required version to 3.13.1	2019-01-03 11:51:29 -05:00
README.rst	doc: use :zephyr_file: where appropriate	2019-03-09 09:50:27 -05:00
prj.conf	samples: net: syslog: Remote syslog service example	2018-12-04 15:55:53 -05:00
sample.yaml	samples: net: syslog: Remote syslog service example	2018-12-04 15:55:53 -05:00

README.rst

.. _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: