summaryrefslogtreecommitdiff
path: root/tools/catalog-report.py
blob: b65869d02b6cd1d0b14dffe70828e270b9047aee (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
#!/usr/bin/env python3
# -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
# SPDX-License-Identifier: MIT
#
# This file is distributed under the MIT license, see below.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

"""
Prints out journal entries with no or bad catalog explanations.
"""

import re
from systemd import journal, id128

j = journal.Reader()

logged = set()
pattern = re.compile('@[A-Z0-9_]+@')

mids = {v:k for k,v in id128.__dict__.items()
        if k.startswith('SD_MESSAGE')}

freq = 1000

def log_entry(x):
    if 'CODE_FILE' in x:
        # some of our code was using 'CODE_FUNCTION' instead of 'CODE_FUNC'
        print('{}:{} {}'.format(x.get('CODE_FILE', '???'),
                                x.get('CODE_LINE', '???'),
                                x.get('CODE_FUNC', None) or x.get('CODE_FUNCTION', '???')))
    print('    {}'.format(x.get('MESSAGE', 'no message!')))
    for k, v in x.items():
        if k.startswith('CODE_') or k in {'MESSAGE_ID', 'MESSAGE'}:
            continue
        print('    {}={}'.format(k, v))
    print()

for i, x in enumerate(j):
    if i % freq == 0:
        print(i, end='\r')

    try:
        mid = x['MESSAGE_ID']
    except KeyError:
        continue
    name = mids.get(mid, 'unknown')

    try:
        desc = journal.get_catalog(mid)
    except FileNotFoundError:
        if mid in logged:
            continue

        print('{} {.hex}: no catalog entry'.format(name, mid))
        log_entry(x)
        logged.add(mid)
        continue

    fields = [field[1:-1] for field in pattern.findall(desc)]
    for field in fields:
        index = (mid, field)
        if field in x or index in logged:
            continue
        print('{} {.hex}: no field {}'.format(name, mid, field))
        log_entry(x)
        logged.add(index)