summaryrefslogtreecommitdiff
path: root/cloudinit/analyze/__main__.py
blob: 71cba4f2b723bda3309f537c0d52558f68988ab1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# Copyright (C) 2017 Canonical Ltd.
#
# This file is part of cloud-init. See LICENSE file for license information.

import argparse
import re
import sys

from . import dump
from . import show


def get_parser(parser=None):
    if not parser:
        parser = argparse.ArgumentParser(
            prog='cloudinit-analyze',
            description='Devel tool: Analyze cloud-init logs and data')
    subparsers = parser.add_subparsers(title='Subcommands', dest='subcommand')
    subparsers.required = True

    parser_blame = subparsers.add_parser(
        'blame', help='Print list of executed stages ordered by time to init')
    parser_blame.add_argument(
        '-i', '--infile', action='store', dest='infile',
        default='/var/log/cloud-init.log',
        help='specify where to read input.')
    parser_blame.add_argument(
        '-o', '--outfile', action='store', dest='outfile', default='-',
        help='specify where to write output. ')
    parser_blame.set_defaults(action=('blame', analyze_blame))

    parser_show = subparsers.add_parser(
        'show', help='Print list of in-order events during execution')
    parser_show.add_argument('-f', '--format', action='store',
                             dest='print_format', default='%I%D @%Es +%ds',
                             help='specify formatting of output.')
    parser_show.add_argument('-i', '--infile', action='store',
                             dest='infile', default='/var/log/cloud-init.log',
                             help='specify where to read input.')
    parser_show.add_argument('-o', '--outfile', action='store',
                             dest='outfile', default='-',
                             help='specify where to write output.')
    parser_show.set_defaults(action=('show', analyze_show))
    parser_dump = subparsers.add_parser(
        'dump', help='Dump cloud-init events in JSON format')
    parser_dump.add_argument('-i', '--infile', action='store',
                             dest='infile', default='/var/log/cloud-init.log',
                             help='specify where to read input. ')
    parser_dump.add_argument('-o', '--outfile', action='store',
                             dest='outfile', default='-',
                             help='specify where to write output. ')
    parser_dump.set_defaults(action=('dump', analyze_dump))
    return parser


def analyze_blame(name, args):
    """Report a list of records sorted by largest time delta.

    For example:
      30.210s (init-local) searching for datasource
       8.706s (init-network) reading and applying user-data
        166ms (modules-config) ....
        807us (modules-final) ...

    We generate event records parsing cloud-init logs, formatting the output
    and sorting by record data ('delta')
    """
    (infh, outfh) = configure_io(args)
    blame_format = '     %ds (%n)'
    r = re.compile('(^\s+\d+\.\d+)', re.MULTILINE)
    for idx, record in enumerate(show.show_events(_get_events(infh),
                                                  blame_format)):
        srecs = sorted(filter(r.match, record), reverse=True)
        outfh.write('-- Boot Record %02d --\n' % (idx + 1))
        outfh.write('\n'.join(srecs) + '\n')
        outfh.write('\n')
    outfh.write('%d boot records analyzed\n' % (idx + 1))


def analyze_show(name, args):
    """Generate output records using the 'standard' format to printing events.

    Example output follows:
        Starting stage: (init-local)
          ...
        Finished stage: (init-local) 0.105195 seconds

        Starting stage: (init-network)
          ...
        Finished stage: (init-network) 0.339024 seconds

        Starting stage: (modules-config)
          ...
        Finished stage: (modules-config) 0.NNN seconds

        Starting stage: (modules-final)
          ...
        Finished stage: (modules-final) 0.NNN seconds
    """
    (infh, outfh) = configure_io(args)
    for idx, record in enumerate(show.show_events(_get_events(infh),
                                                  args.print_format)):
        outfh.write('-- Boot Record %02d --\n' % (idx + 1))
        outfh.write('The total time elapsed since completing an event is'
                    ' printed after the "@" character.\n')
        outfh.write('The time the event takes is printed after the "+" '
                    'character.\n\n')
        outfh.write('\n'.join(record) + '\n')
    outfh.write('%d boot records analyzed\n' % (idx + 1))


def analyze_dump(name, args):
    """Dump cloud-init events in json format"""
    (infh, outfh) = configure_io(args)
    outfh.write(dump.json_dumps(_get_events(infh)) + '\n')


def _get_events(infile):
    rawdata = None
    events, rawdata = show.load_events(infile, None)
    if not events:
        events, _ = dump.dump_events(rawdata=rawdata)
    return events


def configure_io(args):
    """Common parsing and setup of input/output files"""
    if args.infile == '-':
        infh = sys.stdin
    else:
        try:
            infh = open(args.infile, 'r')
        except (FileNotFoundError, PermissionError):
            sys.stderr.write('Cannot open file %s\n' % args.infile)
            sys.exit(1)

    if args.outfile == '-':
        outfh = sys.stdout
    else:
        try:
            outfh = open(args.outfile, 'w')
        except PermissionError:
            sys.stderr.write('Cannot open file %s\n' % args.outfile)
            sys.exit(1)

    return (infh, outfh)


if __name__ == '__main__':
    parser = get_parser()
    args = parser.parse_args()
    (name, action_functor) = args.action
    action_functor(name, args)

# vi: ts=4 expandtab