doc/README

   1 djbdns-logparse: convert tinydns and dnscache logs to human-readable form
   2
   3 == What is it? ==
   4
   5 djbdns is Daniel J. Bernstein's suite of DNS software from,
   6
   7   https://cr.yp.to/djbdns.html
   8
   9 Two of its daemons, tinydns and dnscache, resolve DNS queries while
  10 simultaneously logging obscure gibberish to a file. For example, this
  11 is what tinydns logs if I request the 'A' record for www.example.com:
  12
  13   @4000000063227a320c4f3114 7f000001:9d61:be69 - 0001 www.example.com
  14
  15 djbdns-logparse converts these into something that you can actually
  16 read. The line above gets turned into,
  17
  18   2022-09-14 21:04:40.206516500 dropped query (no authority) from
  19   127.0.0.1:40289 (id 48745): a www.example.com
  20
  21 and surely you agree that this is preferable.
  22
  23
  24 == Requirements ==
  25
  26 There are only two:
  27
  28   a) python-3.6 or later, for f-strings support
  29   b) the tai64nlocal program from djbdns in your PATH
  30
  31
  32 == History ==
  33
  34 This is a modernish fork of Greg Ward's parse_djbdns_log program
  35 from,
  36
  37   https://www.gerg.ca/hacks/parse_djbdns_log
  38
  39 The original was inspired by Faried Nawaz's dnscache log parser,
  40
  41       http://www.hungry.com/~fn/dnscache-log.pl.txt
  42
  43 with heavy assistance from Rob Mayoff's documentation:
  44
  45   * https://www.dqd.com/~mayoff/notes/djbdns/tinydns-log.html
  46   * https://www.dqd.com/~mayoff/notes/djbdns/dnscache-log.html