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
@MarcoFalke friendly ping since it's your idea.
Man that is slick! This works over here.
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 ?
colors = {"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.
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/
Usage: ./src/bitcoind | ./contrib/devtools/colorize.py
pushed, thanks
Tested and works on macOS monterey 12.3
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)?
<details><summary>nit, <code>black</code> linter suggestions</summary><p>
@@ -2,19 +2,23 @@
# Copyright (c) 2022 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
-'''
+"""
Colorize log output
Usage: ./bitcoind | contrib/devtools/colorize.py
-'''
+"""
import re
colors = ("cyan", "red", "blue", "green", "magenta")
color_codes = ("\033[36m", "\033[31m", "\033[34m", "\033[32m", "\033[35m")
+
def colorize(text):
# Colorize groups of brackets
for i, match in enumerate(re.finditer(r"\[.*?\]", text)):
- text = text.replace(match.group(0), color_codes[(i + 1) % len(colors)] + match.group(0) + "\033[0m")
+ text = text.replace(
+ match.group(0),
+ color_codes[(i + 1) % len(colors)] + match.group(0) + "\033[0m",
+ )
# Colorize date
date = re.search(r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z", text)
@@ -23,8 +27,10 @@ def colorize(text):
return text
+
if __name__ == "__main__":
import sys
+
try:
for line in sys.stdin:
print(colorize(line), end="")
</p></details>
pushed thanks
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:
-colors = {"cyan": "\033[36m", "red": "\033[31m", "blue": "\033[34m", "green": "\033[32m", "magenta": "\033[35m"}
+colors = {
+ "cyan": "\033[36m",
+ "red": "\033[31m",
+ "blue": "\033[34m",
+ "green": "\033[32m",
+ "magenta": "\033[35m",
+}
Seeing an issue with the latest push.
(a6c16288f0...):~/bitcoin/bitcoin$ ./src/bitcoind | ./contrib/devtools/colorize_logging.py
Traceback (most recent call last):
File "/bitcoin/./contrib/devtools/colorize_logging.py", line 41, in <module>
print(colorize(line), end="")
File "/bitcoin/./contrib/devtools/colorize_logging.py", line 25, in colorize
colors[(i + 1) % len(colors)] + match.group(0) + "\033[0m",
KeyError: 1
Fixed the script and addressed the comments, thanks @jonatack.
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:
diff --git a/contrib/devtools/README.md b/contrib/devtools/README.md
index 54b1a8558..63aa4a483 100644
--- a/contrib/devtools/README.md
+++ b/contrib/devtools/README.md
@@ -17,6 +17,22 @@ the script should be called from the git root folder as follows.
git diff -U0 HEAD~1.. | ./contrib/devtools/clang-format-diff.py -p1 -i -v
+colorize_logging.py
+===================
+
+Colorizes the terminal log output of `bitcoind` or `bitcoin-qt`.
+Colors can be customized by changing the script's color definitions.
+
+Can be used by running the following command:
+
+```
+./src/bitcoind | ./contrib/devtools/colorize.py
+```
+
+```
+./src/qt/bitcoin-qt -printtoconsole | ./contrib/devtools/colorize_logging.py
+```
+
copyright\_header.py
====================
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--174a7506f384e20aa4161008e828411d-->
No conflicts as of last run.
Why was this deleted? :/