zephyr/samples/net/syslog_net
Fin Maaß 6e12b0210f log: net: move log_backend_net_get() to header
This moves the declaration of log_backend_net_get() to
zephyr/logging/log_backend_net.h

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
2024-03-08 15:18:30 +00:00
..
src log: net: move log_backend_net_get() to header 2024-03-08 15:18:30 +00:00
CMakeLists.txt cmake: increase minimal required version to 3.20.0 2021-08-20 09:47:34 +02:00
docker-test.sh samples: net: syslog: Add Docker based testing support 2020-12-09 15:56:44 +02:00
Kconfig logging: runtime setting of syslog server ip address 2023-09-27 09:13:23 +02:00
overlay-runtime-srv-addr.conf logging: runtime setting of syslog server ip address 2023-09-27 09:13:23 +02:00
prj.conf log: net: Convert syslog network transmitter to use sockets 2024-02-01 10:22:47 -06:00
README.rst samples: net: doc: Use new Sphinx extension to document networking samples 2023-09-19 15:22:59 +01:00
sample.yaml samples: Switch from NEWLIB_LIBC to REQUIRES_FULL_LIBC 2023-10-25 08:32:06 +02:00

.. zephyr:code-sample:: syslog-net
   :name: Remote syslog
   :relevant-api: log_backend log_ctrl

   Enable a remote syslog service that sends syslog messages to a remote server

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: