Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions config/default.py
Original file line number Diff line number Diff line change
Expand Up @@ -343,20 +343,20 @@ def logging_addition_settings(logging_dict: dict, environment="prod"):
"propagate": True,
}

logging_dict["loggers"]["pipeline"] = {"handlers": ["root"], "level": "INFO", "propagate": True}
logging_dict["loggers"]["pipeline"] = {"handlers": ["root"], "level": "INFO", "propagate": False}

logging_dict["loggers"]["pipeline.eri.log"] = {"handlers": ["pipeline_eri"], "level": "INFO", "propagate": True}

logging_dict["loggers"]["bamboo_engine"] = {
"handlers": ["root", "bamboo_engine_context"],
"level": "INFO",
"propagate": True,
"propagate": False,
}

logging_dict["loggers"]["pipeline_engine"] = {
"handlers": ["root", "pipeline_engine_context"],
"level": "INFO",
"propagate": True,
"propagate": False,
}

logging_dict["loggers"]["bk-monitor-report"] = {
Expand All @@ -373,8 +373,6 @@ def logging_addition_settings(logging_dict: dict, environment="prod"):
for handler in logger_config["handlers"]
if handler not in ["pipeline_engine_context", "bamboo_engine_context", "pipeline_eri"]
]
if not logger_config["handlers"]:
logger_config["handlers"] = ["root"]

def handler_filter_injection(filters: list):
for _, handler in logging_dict["handlers"].items():
Expand Down
99 changes: 99 additions & 0 deletions tests/project_settings/test_logging_settings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
"""
TencentBlueKing is pleased to support the open source community by making
BlueKing Flow Engine Service available.
Copyright (C) 2024 THL A29 Limited,
a Tencent company. All rights reserved.
Licensed under the MIT License (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://opensource.org/licenses/MIT
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the
specific language governing permissions and limitations under the License.

We undertake not to change the open source license (MIT license) applicable

to the current version of the project delivered to anyone in the future.
"""

from copy import deepcopy

import pytest

import env
from config.default import logging_addition_settings

BASE_LOGGING = {
"version": 1,
"disable_existing_loggers": False,
"formatters": {
"verbose": {"format": "%(levelname)s %(message)s"},
"simple": {"format": "%(levelname)s %(message)s"},
},
"handlers": {
"root": {"class": "logging.StreamHandler", "formatter": "verbose"},
"component": {"class": "logging.StreamHandler", "formatter": "verbose"},
},
"loggers": {
"root": {"handlers": ["root"], "level": "INFO", "propagate": True},
},
}


def count_handler_calls(logging_config, logger_name, handler_name):
count = 0
current_name = logger_name

while current_name:
logger_config = logging_config["loggers"].get(current_name)
if logger_config:
count += logger_config["handlers"].count(handler_name)
if not logger_config.get("propagate", True):
break

current_name = current_name.rpartition(".")[0] or ("root" if current_name != "root" else "")

return count


@pytest.mark.parametrize("data_source", ["DATABASE", "PaaS3"])
@pytest.mark.parametrize(
"logger_name",
["bamboo_engine", "pipeline_engine", "pipeline.logging", "pipeline.eri.log"],
)
def test_engine_log_is_written_to_root_handler_once(monkeypatch, data_source, logger_name):
monkeypatch.setattr(env, "NODE_LOG_DATA_SOURCE", data_source)
logging_config = deepcopy(BASE_LOGGING)

logging_addition_settings(logging_config)

assert count_handler_calls(logging_config, logger_name, "root") == 1


def test_database_node_log_handlers_are_preserved(monkeypatch):
monkeypatch.setattr(env, "NODE_LOG_DATA_SOURCE", "DATABASE")
logging_config = deepcopy(BASE_LOGGING)

logging_addition_settings(logging_config)

assert count_handler_calls(logging_config, "bamboo_engine", "bamboo_engine_context") == 1
assert count_handler_calls(logging_config, "pipeline_engine", "pipeline_engine_context") == 1
assert count_handler_calls(logging_config, "pipeline.eri.log", "pipeline_eri") == 1


@pytest.mark.parametrize(
"logger_name,handler_name",
[
("bamboo_engine", "bamboo_engine_context"),
("pipeline_engine", "pipeline_engine_context"),
("pipeline.eri.log", "pipeline_eri"),
],
)
def test_database_node_log_handlers_are_disabled_for_paas3(monkeypatch, logger_name, handler_name):
monkeypatch.setattr(env, "NODE_LOG_DATA_SOURCE", "PaaS3")
logging_config = deepcopy(BASE_LOGGING)

logging_addition_settings(logging_config)

assert count_handler_calls(logging_config, logger_name, handler_name) == 0
Loading