doc/man_pages/sdjournal.adoc

   1 include::../attributes.adoc[]
   2 = sdjournal(1)
   3 :doctype: manpage
   4 :stylesheet: ws.css
   5 :linkcss:
   6 :copycss: {css_dir}/{stylesheet}
   7
   8 == NAME
   9
  10 sdjournal - Provide an interface to capture systemd journal entries.
  11
  12 == SYNOPSIS
  13
  14 [manarg]
  15 *sdjournal*
  16 [ *--help* ]
  17 [ *--version* ]
  18 [ *--extcap-interfaces* ]
  19 [ *--extcap-dlts* ]
  20 [ *--extcap-interface*=<interface> ]
  21 [ *--extcap-config* ]
  22 [ *--capture* ]
  23 [ *--fifo*=<path to file or pipe> ]
  24 [ *--start-from*=<entry count> ]
  25
  26 == DESCRIPTION
  27
  28 *sdjournal* is an extcap tool that allows one to capture systemd
  29 journal entries. It can be used to correlate system events with
  30 network traffic.
  31
  32 Supported interfaces:
  33
  34 1. sdjournal
  35
  36 == OPTIONS
  37
  38 --help::
  39 Print program arguments.
  40
  41 --version::
  42 Print program version.
  43
  44 --extcap-interfaces::
  45 List available interfaces.
  46
  47 --extcap-interface=<interface>::
  48 Use specified interfaces.
  49
  50 --extcap-dlts::
  51 List DLTs of specified interface.
  52
  53 --extcap-config::
  54 List configuration options of specified interface.
  55
  56 --capture::
  57 Start capturing from specified interface and write raw packet data to the location specified by --fifo.
  58
  59 --fifo=<path to file or pipe>::
  60 Save captured packet to file or send it through pipe.
  61
  62 --start-from=<entry count>::
  63 +
  64 --
  65 Start from the last <entry count> entries, similar to the
  66 "-n" or "--lines" argument for the tail(1) command. Values prefixed
  67 with a *+* sign start from the beginning of the journal, otherwise
  68 the count starts from the end. The default value is 10. To include
  69 all entries use *+0*.
  70 --
  71
  72 == EXAMPLES
  73
  74 To see program arguments:
  75
  76     sdjournal --help
  77
  78 To see program version:
  79
  80     sdjournal --version
  81
  82 To see interfaces:
  83
  84     sdjournal --extcap-interfaces
  85
  86 Only one interface (sdjournal) is supported.
  87
  88 .Example output
  89     interface {value=sdjournal}{display=systemd journal capture}
  90
  91 To see interface DLTs:
  92
  93     sdjournal --extcap-interface=sdjournal --extcap-dlts
  94
  95 .Example output
  96     dlt {number=147}{name=sdjournal}{display=USER0}
  97
  98 To see interface configuration options:
  99
 100     sdjournal --extcap-interface=sdjournal --extcap-config
 101
 102 .Example output
 103     arg {number=0}{call=--start-from}{display=Starting position}{type=string}
 104         {tooltip=The journal starting position. Values with a leading "+" start from the beginning, similar to the "tail" command}
 105
 106 To capture:
 107
 108     sdjournal --extcap-interface=sdjournal --fifo=/tmp/sdjournal.pcap --capture
 109
 110 To capture all entries since the system was booted:
 111
 112     sdjournal --extcap-interface=sdjournal --fifo=/tmp/sdjournal.pcap --capture --start-from +0
 113
 114 NOTE: To stop capturing CTRL+C/kill/terminate the application.
 115
 116 == SEE ALSO
 117
 118 xref:wireshark.html[wireshark](1), xref:tshark.html[tshark](1), xref:dumpcap.html[dumpcap](1), xref:extcap.html[extcap](4), xref:https://www.tcpdump.org/manpages/tcpdump.1.html[tcpdump](1)
 119
 120 == NOTES
 121
 122 *sdjournal* is part of the *Wireshark* distribution.  The latest version
 123 of *Wireshark* can be found at https://www.wireshark.org.
 124
 125 HTML versions of the Wireshark project man pages are available at
 126 https://www.wireshark.org/docs/man-pages.
 127
 128 == AUTHORS
 129
 130 .Original Author
 131 [%hardbreaks]
 132 Gerald Combs <gerald[AT]wireshark.org>