xref: /netbsd-src/external/bsd/unbound/dist/pythonmod/doc/examples/example1.rst (revision 0cd9f4ecf44538bbdd5619b5b2081449960ab3e6)
1.. _log_handler:
2
3Packet logger
4=============
5
6This example shows how to log and print details about query and response.
7As soon as the ``iterator`` has finished (event is
8:data:`module_event_moddone`), ``qstate.return_msg`` contains response packet
9or ``None``.
10This packet will be send to a client that asked for it.
11
12Complete source code
13--------------------
14
15.. literalinclude:: ../../examples/log.py
16   :language: python
17
18Testing
19-------
20Run the unbound server:
21
22``root@localhost>unbound -dv -c ./test-log.conf``
23
24In case you use own configuration file, don't forget to enable python module:
25``module-config: "validator python iterator"`` and use valid script path:
26``python-script: "./examples/log.py"``.
27
28Example of output::
29
30   [1231790168] unbound[7941:0] info: response for <f.gtld-servers.NET. AAAA IN>
31   [1231790168] unbound[7941:0] info: reply from <gtld-servers.NET.> 192.5.6.31#53
32   [1231790168] unbound[7941:0] info: query response was ANSWER
33   [1231790168] unbound[7941:0] info: pythonmod: operate called, id: 1, event:module_event_moddone
34   ----------------------------------------------------------------------------------------------------
35   Query: f.gtld-servers.NET., type: AAAA (28), class: IN (1)
36   ----------------------------------------------------------------------------------------------------
37   Return    reply :: flags: 8080, QDcount: 1, Security:0, TTL=86400
38             qinfo :: qname: ['f', 'gtld-servers', 'NET', ''] f.gtld-servers.NET., qtype: AAAA, qclass: IN
39   Reply:
40   0 : ['gtld-servers', 'NET', ''] gtld-servers.NET. flags: 0000 type: SOA (6) class: IN (1)
41      0 : TTL= 86400
42          0x00 | 00 3A 02 41 32 05 4E 53 54 4C 44 03 43 4F 4D 00 05 | . : . A 2 . N S T L D . C O M . .
43          0x10 | 05 6E 73 74 6C 64 0C 76 65 72 69 73 69 67 6E 2D 67 | . n s t l d . v e r i s i g n - g
44          0x20 | 67 72 73 03 43 4F 4D 00 77 74 2D 64 00 00 0E 10 00 | g r s . C O M . w t - d . . . . .
45          0x30 | 00 00 03 84 00 12 75 00 00 01 51 80                | . . . . . . u . . . Q .
46
47