pvl/syslog/args.py
author Tero Marttila <terom@fixme.fi>
Fri, 04 Jan 2013 18:44:58 +0200
changeset 50 0bbe2e7561a1
parent 48 40ccb8d3c96e
child 52 f04df0db2acd
permissions -rw-r--r--
pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
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
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
    26
    syslog.add_option('--syslog-tail',          type='float', metavar='TIMEOUT',
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    27
            help="Continuously poll file")
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
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    32
    syslog.add_option('--syslog-prog',          metavar='PROG',     default=prog,
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    33
            help="Filter by given prog: %default")
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    34
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    35
    return syslog
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    36
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    37
def apply (options, optional=False) :
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    38
    """
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    39
        Handle options, returning a SyslogSource, if any.
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    40
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    41
        May log.error/sys.exit
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    42
    """
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
    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
    45
        # fifo pipe
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    46
        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
    47
        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
    48
9d13b101beab pvl.syslog: implement pvl.syslog.args.apply -> SyslogSource as in pvl.verkko-dhcp
Tero Marttila <terom@fixme.fi>
parents: 31
diff changeset
    49
    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
    50
        # tail 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
    51
        source = tail.TailFile(options.syslog_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
    52
        poll = options.syslog_tail # select(float)
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    53
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    54
    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
    55
        # read 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
    56
        source = tail.Tail(open(options.syslog_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
    57
        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
    58
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    59
    elif optional :
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    60
        return None
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
    else :
48
40ccb8d3c96e pvl.verkko-syslog: syslog -> irker gateway
Tero Marttila <terom@fixme.fi>
parents: 46
diff changeset
    63
        # 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
    64
        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
    65
            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
    66
        
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
        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
    68
        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
    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
    # options
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    71
    parser = SyslogParser(
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    72
        raw     = options.syslog_raw,
44
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents: 43
diff changeset
    73
    )
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents: 43
diff changeset
    74
977442ccb72d pvl.syslog: split out SyslogFilter
Tero Marttila <terom@fixme.fi>
parents: 43
diff changeset
    75
    filter = SyslogFilter(
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    76
        prog    = options.syslog_prog,
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    77
    )
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    78
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
    79
    # chain iterables
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    80
    syslog = filter(parser(source))
31
3e6d0feb115c pvl.syslog: import from pvl-collectd
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    81
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
    82
    # polling
0bbe2e7561a1 pvl.syslog: simplify SyslogSource, and implement better handling for sys.stdin using tail.Tail
Tero Marttila <terom@fixme.fi>
parents: 48
diff changeset
    83
    return SyslogSource(syslog, source, poll)