如何禁用Robot Framework自动记录KubeLibrary响应的DEBUG日志？

问题背景 #

使用Robot Framework的KubeLibrary与K8s集群交互时，DEBUG级别的日志会将所有函数调用及响应（包括敏感的Secrets内容）记录到log.html中。需要实现临时禁用部分逻辑的日志记录，或事后清理敏感内容，避免Secrets信息泄露。

当前代码（DEBUG级别下会暴露敏感内容）：

from KubeLibrary import KubeLibrary

...

def some_keyword():
    instance.kube = KubeLibrary(kube_config=instance.kubeconfig)
    secrets_matching_secret_name = instance.kube.get_secrets_in_namespace(
        name_pattern=f"^{secret_name}$",
        namespace=namespace
    )

期望的代码框架：

instance.kube = KubeLibrary(kube_config=instance.kubeconfig)
instance.kube.disable_debug_log()

secrets_matching_secret_name = instance.kube.get_secrets_in_namespace(
    name_pattern=f"^{secret_name}$",
    namespace=namespace
)

instance.kube.enable_debug_log()

解决方案 #

方案一：扩展KubeLibrary添加日志开关 #

KubeLibrary本身没有内置日志开关，可通过继承扩展实现临时调整日志级别：

1. 编写自定义库类，添加日志控制方法：

from KubeLibrary import KubeLibrary
import logging

class CustomKubeLibrary(KubeLibrary):
    def __init__(self, kube_config=None):
        super().__init__(kube_config=kube_config)
        self._original_log_level = None

    def disable_debug_log(self):
        # 获取KubeLibrary的日志器，保存原始级别
        logger = logging.getLogger("KubeLibrary")
        self._original_log_level = logger.getEffectiveLevel()
        # 提升日志级别至INFO，屏蔽DEBUG日志
        logger.setLevel(logging.INFO)

    def enable_debug_log(self):
        if self._original_log_level is not None:
            logger = logging.getLogger("KubeLibrary")
            logger.setLevel(self._original_log_level)
            self._original_log_level = None

2. 在测试代码中使用自定义库：

from CustomKubeLibrary import CustomKubeLibrary

...

def some_keyword():
    instance.kube = CustomKubeLibrary(kube_config=instance.kubeconfig)
    instance.kube.disable_debug_log()
    # 执行敏感操作
    secrets_matching_secret_name = instance.kube.get_secrets_in_namespace(
        name_pattern=f"^{secret_name}$",
        namespace=namespace
    )
    instance.kube.enable_debug_log()

方案二：用rebot事后清理日志 #

如果不想修改测试代码，可在生成log.html前，通过脚本清理output.xml中的敏感内容，再用rebot生成干净的日志：

1. 编写清理脚本（clean_logs.py）：

import xml.etree.ElementTree as ET

tree = ET.parse('original_output.xml')
root = tree.getroot()

# 遍历所有日志消息，替换敏感内容
for msg in root.findall(".//msg"):
    if msg.text and ("secret" in msg.text.lower() or "data" in msg.text.lower()):
        msg.text = "[REDACTED SENSITIVE DATA]"

tree.write('cleaned_output.xml')

2. 执行脚本后生成干净的日志：

python clean_logs.py
rebot cleaned_output.xml

也可直接用rebot参数临时调整日志级别，屏蔽DEBUG内容：

rebot --log-level INFO original_output.xml

方案三：自定义包装关键字临时切换日志级别 #

通过Robot Framework的BuiltIn库临时修改全局日志级别，包裹敏感操作：

from robot.libraries.BuiltIn import BuiltIn

def get_secrets_safely(kube_library, secret_name, namespace):
    builtin = BuiltIn()
    # 保存当前日志级别，切换为INFO
    original_level = builtin.set_log_level("INFO")
    try:
        return kube_library.get_secrets_in_namespace(
            name_pattern=f"^{secret_name}$",
            namespace=namespace
        )
    finally:
        # 恢复原始日志级别
        builtin.set_log_level(original_level)

在测试关键字中调用这个包装函数即可，无需修改KubeLibrary本身。

内容的提问来源于stack exchange，提问作者Kspr