1

#!/usr/bin/python

     2

     3

"""

     4

    Setup symlinks for pvl.verkko-rrd -> collectd based on define host/interface names

     5

"""

     6

     7

__version__ = '0.1'

     8

     9

import shlex

    10

import os

    11

    12

import pvl.args

    13

    14

import optparse

    15

import logging; log = logging.getLogger('main')

    16

    17

def hostjoin (*hosts) :

    18

    """

    19

        DNS hostname join.

    20

    """

    21

    22

    return '.'.join(hosts)

    23

    24

def hostreverse (host) :

    25

    """

    26

        Reverse hostname.

    27

    """

    28

    29

    return '.'.join(reversed(host.split('.')))

    30

    31

def collectd_interfaces (options, file, collectd_domain, collectd_plugin) :

    32

    """

    33

        Read collectd (host, type-instance, name) items, and yield (collectd-rrd, out-rrd) tuples.

    34

    35

            file                - read host/ports from file

    36

            collectd_domain     - append given domain to collectd hostname

    37

            collectd_plugin     - use given collectd plugin's type-instances

    38

    """

    39

    40

    host = None

    41

    42

    log.info("scanning %s/<host>.%s/%s/%s-<port>.rrd", options.collectd_rrd, collectd_domain, collectd_plugin, options.collectd_type)

    43

    44

    for idx, line in enumerate(file, 1) :

    45

        line = line.rstrip()

    46

    47

        if not line :

    48

            continue

    49

    50

        # comment?

    51

        if line.startswith('#') :

    52

            continue

    53

    54

        # line

    55

        parts = shlex.split(line)

    56

    57

        if not line[0].isspace() :

    58

            host = parts.pop(0)

    59

    60

        # host-spec?

    61

        if '=' in host :

    62

            collectd_host, interface_host = host.split('=')

    63

        else :

    64

            collectd_host = interface_host = host

    65

    66

        # flip from DNS-ordering -> path-ordering

    67

        if options.reverse_host :

    68

            interface_host = hostreverse(interface_host)

    69

    70

        # host has domain in collectd?

    71

        if collectd_domain :

    72

            collectd_host = hostjoin(collectd_host, collectd_domain)

    73

    74

        if not parts :

    75

            # keep host for following lines

    76

            continue

    77

    78

        port = parts.pop(0)

    79

    80

        # possibly multiple tags..

    81

        for tag in parts :

    93

    94

            if not os.path.exists(collectd_rrd) :

    95

                log.warn("%s: missing collectd rrd: %s", idx, collectd_rrd)

    96

                continue

    97

    98

            # out

    99

            interface_rrd = os.path.join(interface_host, tag + '.rrd')

   100

   101

            log.debug("%s: %s", interface_rrd, collectd_rrd)

   102

   103

            yield collectd_rrd, interface_rrd

   104

   105

def sync_links (options, links, dir) :

   106

    """

   107

        Sync given (collectd, name) symlinks in given dir.

   108

    """

   109

   110

    log.info("%s", dir)

   111

   112

    for path, name in links :

   113

        link = os.path.join(dir, name)

   114

   115

        # sync

   116

        if os.path.exists(link) :

   117

            continue

   118

   119

        log.info("%s: %s: %s", dir, name, path)

   120

   121

        yield link, path

   122

   123

def apply_links (options, links) :

   124

    """

   125

        Apply given symlinks

   126

    """

   127

   128

    for link, path in links :

   129

        linkdir = os.path.dirname(link)

   130

   131

        # do

   132

        if not os.path.exists(linkdir) :

   133

            log.warn("mkdir: %s", linkdir)

   134

            os.mkdir(linkdir)

   135

   136

        print path

   137

   138

        os.symlink(path, link)

   139

   140

COLLECTD_RRD = '/var/lib/collectd/rrd'

   141

COLLECTD_PLUGIN = 'interfaces'

   142

COLLECTD_TYPE = 'if_octets'

   143

   144

def parse_argv (argv, doc = __doc__) :

   145

    """

   146

        Parse command-line argv, returning (options, args).

   147

    """

   148

   149

    prog = argv.pop(0)

   150

    args = argv

   151

   152

    # optparse

   153

    parser = optparse.OptionParser(

   154

        prog        = prog,

   155

        usage       = '%prog: [options] [<input.txt> [...]]',

   156

        version     = __version__,

   157

        description = doc,

   158

    )

   159

   160

    # common

   161

    parser.add_option_group(pvl.args.parser(parser))

   162

   163

    # options

   164

    parser.add_option('--collectd-rrd',     metavar='PATH',     default=COLLECTD_RRD,

   165

            help="Path to collectd rrd: %default")

   166

    parser.add_option('--collectd-plugin',  metavar='PLUGIN',   default=None,

   167

            help="Collectd plugin to use: <input>-<plugin>.txt")

   168

    parser.add_option('--collectd-type',    metavar='TYPE',     default=COLLECTD_TYPE,

   169

            help="Collectd type to use: %default")

   170

   177

    # hostnames

   178

    parser.add_option('--reverse-host',     action='store_true',

   179

            help="Flip host.domain -> domain.host (default)")

   180

    parser.add_option('--no-reverse-host',  action='store_false', dest='reverse_host',

   181

            help="Keep host.domain as host.domain")

   182

    parser.add_option('--domain',           metavar='DOMAIN',  

   183

            help="Append domain to collectd hostnames: <input>.txt -> <input>")

   184

   185

    # output

   186

    parser.add_option('--rrd',              metavar='PATH',

   187

            help="Output directory for .rrd symlinks: <input>.txt -> <input>/")

   188

    parser.add_option('--noop',             action='store_true',

   189

            help="Scan symlinks, but do not update")

   190

   191

    parser.set_defaults(

   194

    )

   195

   196

    # parse

   197

    options, args = parser.parse_args(args)

   198

   199

    # apply

   200

    pvl.args.apply(options)

   201

   202

    return options, args

   203

   204

def main (argv) :

   205

    options, args = parse_argv(argv)

   206

   207

    for txt in args :

   208

        # <path>/<domain>-<plugin>.txt -> <path>/<domain>-<plugin>

   209

        basepath, _ = os.path.splitext(txt)

   210

   211

        # <path>/<domain>-<plugin> -> <path>/<domain>, <plugin>

   212

        if '-' in basepath :

   213

            basepath, collectd_plugin = basepath.rsplit('-', 1)

   214

        else :

   215

            collectd_plugin = None

   216

   217

        # <path>/<domain> -> <domain>

   218

        _, basename = os.path.split(basepath)

   219

   220

        # domain?

   221

        if options.domain is None :

   222

            # reverse-order hostname

   223

            domain = hostreverse(basename)

   224

        else :

   225

            # may be ''

   226

            domain = options.domain

   227

   228

        # output dir?

   229

        if options.rrd :

   230

            rrd_domain = hostreverse(domain) if options.reverse_host else domain

   231

            rrd = os.path.join(options.rrd, rrd_domain)

   232

        else :

   233

            rrd = basepath

   234

   235

        # generate links from spec

   236

        links = list(collectd_interfaces(options, open(txt),

   237

            collectd_domain     = domain,

   238

            collectd_plugin     = options.collectd_plugin or collectd_plugin or COLLECTD_PLUGIN,

   239

        ))

   240

   241

        if not os.path.exists(rrd) :

   242

            log.warn("mkdir: %s", rrd)

   243

   244

            if not options.noop :

   245

                os.mkdir(rrd)

   246

   247

        # sync missing links

   248

        links = list(sync_links(options, links,

   249

            dir     = rrd,

   250

        ))

   251

   252

        # verbose

   253

        if not options.quiet :

   254

            for link, path in links :

   255

                print link, '->', path

   256

   257

        # apply

   258

        if not options.noop :

   259

            apply_links(options, links)

   260

   261

    return 0

   262

   263

if __name__ == '__main__':

   264

    import sys

   265

   266

    sys.exit(main(sys.argv))