pvl/syslog/args.py
author Tero Marttila <terom@paivola.fi>
Sat, 12 Jan 2013 21:41:12 +0200
changeset 98 b11a8ef6725f
parent 74 952ee07efd7a
child 101 6b27d7010bd4
permissions -rw-r--r--
pvl.syslog.args: reimplement --syslog-tail as taking the file, and using an implicit 2.0s timeout
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     1
import optparse, sys
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     2
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     3
from pvl.syslog.parser import SyslogParser
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents: 43
diff changeset
     4
from pvl.syslog.filter import SyslogFilter
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     5
from pvl.syslog.syslog import SyslogSource
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     6
from pvl.syslog import fifo, tail
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     7
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     8
# XXX: use optparse parser.error()?
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     9
import logging; log = logging.getLogger('pvl.syslog.args')
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    10
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    11
def parser (parser, prog=None) :
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    12
    """
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    13
        Optparse option group
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    14
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    15
            prog        - filter to only process lines from given process
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    16
    """
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    17
    
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    18
    syslog = optparse.OptionGroup(parser, 'Syslog collector')
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    19
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    20
    syslog.add_option('--syslog-fifo',          metavar='PATH',
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    21
            help="Read syslog messages from given fifo")
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    22
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    23
    syslog.add_option('--syslog-file',          metavar='FILE',
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    24
            help="Read syslog messages from given file")
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    25
98
b11a8ef6725f pvl.syslog.args: reimplement --syslog-tail as taking the file, and using an implicit 2.0s timeout
Tero Marttila <terom@paivola.fi>
parents: 74
diff changeset
    26
    syslog.add_option('--syslog-tail',          metavar='FILE',
b11a8ef6725f pvl.syslog.args: reimplement --syslog-tail as taking the file, and using an implicit 2.0s timeout
Tero Marttila <terom@paivola.fi>
parents: 74
diff changeset
    27
            help="Continuously poll syslog messages given file")
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    28
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    29
    syslog.add_option('--syslog-raw',           action='store_true',
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    30
            help="Parse raw syslog lines without timestamp/etc")
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    31
74
952ee07efd7a pvl.syslog: implement --syslog-facility, implementing proper glob/regexp support in SyslogFilter
Tero Marttila <terom@paivola.fi>
parents: 65
diff changeset
    32
    syslog.add_option('--syslog-facility',      metavar='FACILITY',
952ee07efd7a pvl.syslog: implement --syslog-facility, implementing proper glob/regexp support in SyslogFilter
Tero Marttila <terom@paivola.fi>
parents: 65
diff changeset
    33
            help="Set/filter by given facility")
952ee07efd7a pvl.syslog: implement --syslog-facility, implementing proper glob/regexp support in SyslogFilter
Tero Marttila <terom@paivola.fi>
parents: 65
diff changeset
    34
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    35
    syslog.add_option('--syslog-prog',          metavar='PROG',     default=prog,
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    36
            help="Filter by given prog: %default")
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    37
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    38
    return syslog
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    39
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    40
def apply (options, optional=False) :
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    41
    """
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    42
        Handle options, returning a SyslogSource, if any.
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    43
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    44
        May log.error/sys.exit
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    45
    """
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    46
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    47
    if options.syslog_fifo :
50
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    48
        # fifo pipe
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    49
        source = fifo.Fifo(options.syslog_fifo)
50
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    50
        poll = True # select(source)
43
9d13b101beab pvl.syslog: implement pvl.syslog.args.apply -> SyslogSource as in pvl.verkko-dhcp
Tero Marttila <terom@fixme.fi>
parents: 31
diff changeset
    51
9d13b101beab pvl.syslog: implement pvl.syslog.args.apply -> SyslogSource as in pvl.verkko-dhcp
Tero Marttila <terom@fixme.fi>
parents: 31
diff changeset
    52
    elif options.syslog_tail :
9d13b101beab pvl.syslog: implement pvl.syslog.args.apply -> SyslogSource as in pvl.verkko-dhcp
Tero Marttila <terom@fixme.fi>
parents: 31
diff changeset
    53
        # tail file
98
b11a8ef6725f pvl.syslog.args: reimplement --syslog-tail as taking the file, and using an implicit 2.0s timeout
Tero Marttila <terom@paivola.fi>
parents: 74
diff changeset
    54
        source = tail.TailFile(options.syslog_tail, skip=True)
b11a8ef6725f pvl.syslog.args: reimplement --syslog-tail as taking the file, and using an implicit 2.0s timeout
Tero Marttila <terom@paivola.fi>
parents: 74
diff changeset
    55
        poll = 2.0 # select(float)
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    56
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    57
    elif options.syslog_file :
43
9d13b101beab pvl.syslog: implement pvl.syslog.args.apply -> SyslogSource as in pvl.verkko-dhcp
Tero Marttila <terom@fixme.fi>
parents: 31
diff changeset
    58
        # read file
65
be2b407c06ff pvl.syslog: fixfix
Tero Marttila <terom@fixme.fi>
parents: 60
diff changeset
    59
        source = tail.Tail(open(options.syslog_file))
50
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    60
        poll = False # do not loop, just read up to EOF
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    61
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    62
    elif optional :
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    63
        return None
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    64
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    65
    else :
48
40ccb8d3c96e pvl.verkko-syslog: syslog -> irker gateway
Tero Marttila <terom@fixme.fi>
parents: 46
diff changeset
    66
        # from stdin
50
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    67
        if sys.stdin.isatty() :
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    68
            log.warning("Reading syslog messages from TTY?")
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    69
        
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    70
        source = tail.Tail(sys.stdin)
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    71
        poll = False # XXX: tty vs pipe vs file?
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    72
    
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    73
    # options
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    74
    parser = SyslogParser(
74
952ee07efd7a pvl.syslog: implement --syslog-facility, implementing proper glob/regexp support in SyslogFilter
Tero Marttila <terom@paivola.fi>
parents: 65
diff changeset
    75
        raw         = options.syslog_raw,
952ee07efd7a pvl.syslog: implement --syslog-facility, implementing proper glob/regexp support in SyslogFilter
Tero Marttila <terom@paivola.fi>
parents: 65
diff changeset
    76
        facility    = options.syslog_facility,
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents: 43
diff changeset
    77
    )
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents: 43
diff changeset
    78
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents: 43
diff changeset
    79
    filter = SyslogFilter(
52
f04df0db2acd pvl.syslog: refactor SyslogFilter for extensive magics
Tero Marttila <terom@fixme.fi>
parents: 50
diff changeset
    80
        # glob pattern
74
952ee07efd7a pvl.syslog: implement --syslog-facility, implementing proper glob/regexp support in SyslogFilter
Tero Marttila <terom@paivola.fi>
parents: 65
diff changeset
    81
        prog        = options.syslog_prog,
952ee07efd7a pvl.syslog: implement --syslog-facility, implementing proper glob/regexp support in SyslogFilter
Tero Marttila <terom@paivola.fi>
parents: 65
diff changeset
    82
        facility    = options.syslog_facility,
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    83
    )
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    84
50
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    85
    # polling
60
9326ed989645 pvl.syslog.source: fix iteration over filter/parser/source
Tero Marttila <terom@fixme.fi>
parents: 52
diff changeset
    86
    return SyslogSource(source, parser, filter, poll)