bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2e3cfec25d
zephyr/samples/subsys/logging/logger
History
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.

The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.

NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-09-05 16:31:47 +02:00
..
boards
src includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
CMakeLists.txt
Kconfig
prj.conf sample: logging: logger: Extend sample to use tag 2022-01-04 14:57:31 -06:00
README.rst
sample.yaml

README.rst 

.. _logger_sample:

Logging
###########

Overview
********
A simple application that demonstrates use of logging subsystem. It demonstrates
main features: severity levels, timestamping, module level filtering and
instance level filtering. It also showcases logging capabilities in terms of
performance.

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

This project outputs multiple log message to the console.  It can be built and
executed on QEMU as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/logging/logger
   :host-os: unix
   :board: qemu_x86
   :goals: run
   :compact:


Sample Output
=============

.. code-block:: console

        Module logging showcase.
        [00:00:00.106,051] <inf> sample_module: log in test_module 11
        [00:00:00.106,054] <inf> sample_module: Inline function.
        Disabling logging in the sample_module module
        Function called again but with logging disabled.
        Instance level logging showcase.
        [00:00:00.106,200] <inf> sample_instance.inst1: Inline call.
        [00:00:00.106,204] <inf> sample_instance.inst1: counter_value: 0
        [00:00:00.106,209] <wrn> sample_instance.inst1: Example of hexdump:
        01 02 03 04             |....
        [00:00:00.106,214] <inf> sample_instance.inst2: Inline call.
        [00:00:00.106,218] <inf> sample_instance.inst2: counter_value: 0
        [00:00:00.106,223] <wrn> sample_instance.inst2: Example of hexdump:
        01 02 03 04             |....
        Changing filter to warning on sample_instance.inst1 instance.
        [00:00:00.106,297] <wrn> sample_instance.inst1: Example of hexdump:
        01 02 03 04             |....
        [00:00:00.106,302] <inf> sample_instance.inst2: Inline call.
        [00:00:00.106,307] <inf> sample_instance.inst2: counter_value: 1
        [00:00:00.106,311] <wrn> sample_instance.inst2: Example of hexdump:
        01 02 03 04             |....
        Disabling logging on both instances.
        Function call on both instances with logging disabled.
        String logging showcase.
        [00:00:01.122,316] <inf> main: Logging transient string:transient_string
        Severity levels showcase.
        [00:00:01.122,348] <err> main: Error message example.
        [00:00:01.122,352] <wrn> main: Warning message example.
        [00:00:01.122,355] <inf> main: Info message example.
        Logging performance showcase.
        [00:00:02.151,602] <inf> main: performance test - log message 0
        Estimated logging capabilities: 42000000 messages/second
        Logs from external logging system showcase.
        [00:00:03.165,977] <err> ext_log_system: critical level log
        [00:00:03.165,991] <err> ext_log_system: error level log, 1 arguments: 1
        [00:00:03.166,006] <wrn> ext_log_system: warning level log, 2 arguments: 12
        [00:00:03.166,025] <inf> ext_log_system: notice level log, 3 arguments: 105
        [00:00:03.166,044] <inf> ext_log_system: info level log, 4 arguments : 1 24

Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.