README.rst
1.. zephyr:code-sample:: logging-dictionary
2 :name: Dictionary-based logging
3 :relevant-api: log_api
4
5 Output binary log data using the dictionary-based logging API.
6
7Overview
8********
9
10This is a sample app which utilizes :ref:`dictionary-based logging <logging_guide_dictionary>` and
11the UART backend. This is configured to output binary log data
12in hexadecimal so it could be run in terminal.
13
14
15Building and Running
16********************
17
18This application can be built and executed on QEMU as follows:
19
20.. zephyr-app-commands::
21 :zephyr-app: samples/subsys/logging/dictionary
22 :host-os: unix
23 :board: qemu_x86
24 :goals: run
25 :compact:
26
27To build for another board, change "qemu_x86" above to that board's name.
28
29
30Sample Output
31=============
32
33 .. code-block:: none
34
35 SeaBIOS (version zephyr-v1.0.0-0-g31d4e0e-dirty-20200714_234759-fv-az50-zephyr)
36 Booting from ROM..##ZLOGV1##000004000000000000ecd7000004000000f76a10001e6b10001d6b1000000003000000000000b3e30000030000004d6410004464100000080200000000000093e70000020000005e64100000200300000000000076eb0000030000006b641000dc60100000180200000000000043ef0000020000007c64100000200500000000000066f300000500000088641000dc60100001000000020000000020050000000000008cf7000005000000a2641000dc6010001000000011000000002005000000000000b3fb000005000000be641000dc60100020000000210000000020070000000000000600010007000000da641000dc60100040000000000000004100000000000000002004000000000000491f0100040000000e651000dc60100021000000002004000000000000e02801000400000025651000dc6010001a651000006007000000000000993501000401000032651000dc601000000000000364796e616d6963207374720000201b0000000000000c5701000a04000043651000dc601000000000003f651000000000003f651000000000003f651000000000000364796e616d696320737472000564796e616d6963207374720007616e6f746865722064796e616d6963207374720009616e6f746865722064796e616d6963207374720000600b000000000000736a01000801000066651000dc601000210000001a651000000000001a651000210000000564796e616d696320737472000020040000000000008c6e01000400000083651000dc601000da0310000020041a0000000000967a010004000000ba651000dc601000ad65100048455844554d50212048455844554d50402048455844554d5023
37
38
39Running the Log Parser
40======================
41
421. Pipe the run output or copy the hexadecimal string into a temporary file ``/tmp/serial.log``:
43
44 .. code-block:: none
45
46 ##ZLOGV1##000004000000000000ecd7000004000000f76a10001e6b10001d6b1000000003000000000000b3e30000030000004d6410004464100000080200000000000093e70000020000005e64100000200300000000000076eb0000030000006b641000dc60100000180200000000000043ef0000020000007c64100000200500000000000066f300000500000088641000dc60100001000000020000000020050000000000008cf7000005000000a2641000dc6010001000000011000000002005000000000000b3fb000005000000be641000dc60100020000000210000000020070000000000000600010007000000da641000dc60100040000000000000004100000000000000002004000000000000491f0100040000000e651000dc60100021000000002004000000000000e02801000400000025651000dc6010001a651000006007000000000000993501000401000032651000dc601000000000000364796e616d6963207374720000201b0000000000000c5701000a04000043651000dc601000000000003f651000000000003f651000000000003f651000000000000364796e616d696320737472000564796e616d6963207374720007616e6f746865722064796e616d6963207374720009616e6f746865722064796e616d6963207374720000600b000000000000736a01000801000066651000dc601000210000001a651000000000001a651000210000000564796e616d696320737472000020040000000000008c6e01000400000083651000dc601000da0310000020041a0000000000967a010004000000ba651000dc601000ad65100048455844554d50212048455844554d50402048455844554d5023
47
482. Run the log parser to get the text output:
49
50 .. code-block:: console
51
52 ./scripts/logging/dictionary/log_parser.py build/zephyr/log_dictionary.json /tmp/serial.log --hex
53
54 And here is the output:
55
56 .. code-block:: none
57
58 *** Booting Zephyr OS build zephyr-v2.5.0-2471-g09b9eaf333e6 ***
59 Hello World! qemu_x86
60 [ 77820] <err> hello_world: error string
61 [ 86332] <dbg> hello_world: main: debug string
62 [ 96275] <inf> hello_world: info string
63 [ 104784] <dbg> hello_world: main: int8_t 1, uint8_t 2
64 [ 117609] <dbg> hello_world: main: int16_t 16, uint16_t 17
65 [ 130454] <dbg> hello_world: main: int32_t 32, uint32_t 33
66 [ 143299] <dbg> hello_world: main: int64_t 64, uint64_t 65
67 [ 166374] <dbg> hello_world: main: char !
68 [ 179452] <dbg> hello_world: main: s str static str
69 [ 193395] <dbg> hello_world: main: d str dynamic str
70 [ 217283] <dbg> hello_world: main: mixed str dynamic str --- dynamic str --- another dynamic str --- another dynamic str
71 [ 266022] <dbg> hello_world: main: mixed c/s ! static str dynamic str static str !
72 [ 287888] <dbg> hello_world: main: pointer 0x10651a
73 [ 301600] <dbg> hello_world: main: For HeXdUmP!
74 48 45 58 44 55 4d 50 21 20 48 45 58 44 55 4d 50 |HEXDUMP! HEXDUMP
75 40 20 48 45 58 44 55 4d 50 23 |@ HEXDUM P#
76
