Proof of concept and an alternative to #26026. Adds a script to colorize the logs in order to make them more readable. This script removes the burden of maintaining code for colorizing in the actual logger.
Can be used with ./src/bitcoind | ./contrib/devtools/colorize_logging.py
Concept ACK
Wouldn’t be controversial to have this in contrib while we have logging; better approach than essentially forcing it all the time with an environmental opt out in #26026. In terms of color compatibility with themes, some documentation can a) point out that this script exists and b) explain how one could change the colors to their liking
7+Usage: ./bitcoind | contrib/devtools/colorize.py
8+'''
9+import re
10+
11+colors = ("cyan", "red", "blue", "green", "magenta")
12+color_codes = ("\033[36m", "\033[31m", "\033[34m", "\033[32m", "\033[35m")
Maybe a dict ?
0colors = {"cyan": "\033[36m", "red": "\033[31m", "blue": "\033[34m", "green": "\033[32m", "magenta": "\033[35m"}
12+color_codes = ("\033[36m", "\033[31m", "\033[34m", "\033[32m", "\033[35m")
13+
14+def colorize(text):
15+ # Colorize groups of brackets
16+ for i, match in enumerate(re.finditer(r"\[.*?\]", text)):
17+ text = text.replace(match.group(0), color_codes[(i + 1) % len(colors)] + match.group(0) + "\033[0m")
Since the colors variable is being used only to calculate len(colors), it can be removed.
0 text = text.replace(match.group(0), color_codes[(i + 1) % len(color_codes)] + match.group(0) + "\033[0m")
Concept ACK
Does it need to set stdin/out to line-buffered to accept realtime piping to it?
Addressed your suggestions @w0xlt, thanks.
Does it need to set stdin/out to line-buffered to accept realtime piping to it?
I’m unfamiliar with Python, not sure if there are better methods.
0@@ -0,0 +1,32 @@
1+#!/usr/bin/env python3
2+# Copyright (c) 2022 The Bitcoin Core developers
3+# Distributed under the MIT software license, see the accompanying
4+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5+'''
6+Colorize log output
7+Usage: ./bitcoind | contrib/devtools/colorize.py
missing src/
0Usage: ./src/bitcoind | ./contrib/devtools/colorize.py
27+ try:
28+ for line in sys.stdin:
29+ print(colorize(line), end="")
30+ except KeyboardInterrupt:
31+ print()
32+ sys.exit(0)
Should the file be named colorize_logging.py (or colorize_logs.py)?
0@@ -2,19 +2,23 @@
1 # Copyright (c) 2022 The Bitcoin Core developers
2 # Distributed under the MIT software license, see the accompanying
3 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
4-'''
5+"""
6 Colorize log output
7 Usage: ./bitcoind | contrib/devtools/colorize.py
8-'''
9+"""
10 import re
11
12 colors = ("cyan", "red", "blue", "green", "magenta")
13 color_codes = ("\033[36m", "\033[31m", "\033[34m", "\033[32m", "\033[35m")
14
15+
16 def colorize(text):
17 # Colorize groups of brackets
18 for i, match in enumerate(re.finditer(r"\[.*?\]", text)):
19- text = text.replace(match.group(0), color_codes[(i + 1) % len(colors)] + match.group(0) + "\033[0m")
20+ text = text.replace(
21+ match.group(0),
22+ color_codes[(i + 1) % len(colors)] + match.group(0) + "\033[0m",
23+ )
24
25 # Colorize date
26 date = re.search(r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z", text)
27@@ -23,8 +27,10 @@ def colorize(text):
28
29 return text
30
31+
32 if __name__ == "__main__":
33 import sys
34+
35 try:
36 for line in sys.stdin:
37 print(colorize(line), end="")
6+Colorize log output
7+Usage: ./src/bitcoind | ./contrib/devtools/colorize_logging.py
8+"""
9+import re
10+
11+colors = {"cyan": "\033[36m", "red": "\033[31m", "blue": "\033[34m", "green": "\033[32m", "magenta": "\033[35m"}
naming nit, maybe COLORS for the constant
black suggestion:
0-colors = {"cyan": "\033[36m", "red": "\033[31m", "blue": "\033[34m", "green": "\033[32m", "magenta": "\033[35m"}
1+colors = {
2+ "cyan": "\033[36m",
3+ "red": "\033[31m",
4+ "blue": "\033[34m",
5+ "green": "\033[32m",
6+ "magenta": "\033[35m",
7+}
Seeing an issue with the latest push.
0(a6c16288f0...):~/bitcoin/bitcoin$ ./src/bitcoind | ./contrib/devtools/colorize_logging.py
1Traceback (most recent call last):
2 File "/bitcoin/./contrib/devtools/colorize_logging.py", line 41, in <module>
3 print(colorize(line), end="")
4 File "/bitcoin/./contrib/devtools/colorize_logging.py", line 25, in colorize
5 colors[(i + 1) % len(colors)] + match.group(0) + "\033[0m",
6KeyError: 1
Example of how we could document it’s existence and hint towards user customization options so it can be compatible with everyone’s color scheme:
0
1diff --git a/contrib/devtools/README.md b/contrib/devtools/README.md
2index 54b1a8558..63aa4a483 100644
3--- a/contrib/devtools/README.md
4+++ b/contrib/devtools/README.md
5@@ -17,6 +17,22 @@ the script should be called from the git root folder as follows.
6 git diff -U0 HEAD~1.. | ./contrib/devtools/clang-format-diff.py -p1 -i -v
7+colorize_logging.py
8+===================
9+
10+Colorizes the terminal log output of `bitcoind` or `bitcoin-qt`.
11+Colors can be customized by changing the script's color definitions.
12+
13+Can be used by running the following command:
14+
15+```
16+./src/bitcoind | ./contrib/devtools/colorize.py
17+```
18+
19+```
20+./src/qt/bitcoin-qt -printtoconsole | ./contrib/devtools/colorize_logging.py
21+```
22+
23 copyright\_header.py
24 ====================
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
No conflicts as of last run.