Skip to content

Commit

Permalink
refactor: refine log_setting to support new src layout (#317)
Browse files Browse the repository at this point in the history 
This PR fixes otaclient logging upload only covers otaclient since project layout restruct phase2, while applies some refinements over the log_setting module and move this module directly under otaclient package.
  • Loading branch information
@Bodong-Yang
Bodong-Yang authored Jun 10, 2024
1 parent 3fc05d4 commit 15e9974
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 29 deletions.
1 change: 1 addition & 0 deletions src/otaclient/app/configs.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ class BaseConfig(_InternalSettings):
"otaclient": INFO,
"otaclient_api": INFO,
"otaclient_common": INFO,
"otaproxy": INFO,
}
LOG_FORMAT = (
"[%(asctime)s][%(levelname)s]-%(name)s:%(funcName)s:%(lineno)d,%(message)s"
Expand Down
2 changes: 1 addition & 1 deletion src/otaclient/app/main.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
from otaclient import __version__
from otaclient.app.configs import config as cfg
from otaclient.app.configs import ecu_info, server_cfg
from otaclient.app.log_setting import configure_logging
from otaclient.app.ota_client_stub import OTAClientServiceStub
from otaclient.log_setting import configure_logging
from otaclient_api.v2 import otaclient_v2_pb2_grpc as v2_grpc
from otaclient_api.v2.api_stub import OtaClientServiceV2
from otaclient_common.common import read_str_from_file, write_str_to_file_sync
Expand Down
2 changes: 1 addition & 1 deletion src/otaclient/app/ota_client_stub.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
from ota_proxy import OTAProxyContextProto
from ota_proxy import config as local_otaproxy_cfg
from ota_proxy import subprocess_otaproxy_launcher
from otaclient.app import log_setting
from otaclient import log_setting
from otaclient.configs.ecu_info import ECUContact
from otaclient_api.v2 import types as api_types
from otaclient_api.v2.api_caller import ECUNoResponse, OTAClientCall
Expand Down
45 changes: 19 additions & 26 deletions src/otaclient/app/log_setting.py → src/otaclient/log_setting.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
# 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.
"""Configure the logging for otaclient."""


from __future__ import annotations
Expand All @@ -24,10 +25,8 @@

import requests

import otaclient

from .configs import config as cfg
from .configs import ecu_info, proxy_info
from otaclient.app.configs import config as cfg
from otaclient.app.configs import ecu_info, proxy_info


class _LogTeeHandler(logging.Handler):
Expand Down Expand Up @@ -69,36 +68,30 @@ def _thread_exit():
atexit.register(_thread_exit)


def configure_logging():
def configure_logging() -> None:
"""Configure logging with http handler."""
# configure the root logger
# ------ suppress logging from non-first-party modules ------ #
# NOTE: force to reload the basicConfig, this is for overriding setting
# when launching subprocess.
# NOTE: for the root logger, set to CRITICAL to filter away logs from other
# external modules unless reached CRITICAL level.
logging.basicConfig(level=logging.CRITICAL, format=cfg.LOG_FORMAT, force=True)
# NOTE: set the <loglevel> to the otaclient package root logger
_otaclient_logger = logging.getLogger(otaclient.__name__)
_otaclient_logger.setLevel(cfg.DEFAULT_LOG_LEVEL)

# configure each sub loggers
for _module_name, _log_level in cfg.LOG_LEVEL_TABLE.items():
_logger = logging.getLogger(_module_name)
_logger.setLevel(_log_level)

if iot_logger_url := proxy_info.logging_server:
iot_logger_url = f"{str(iot_logger_url).strip('/')}/"
# ------ configure each sub loggers and attach ota logging handler ------ #
log_upload_handler = None
if logging_upload_endpoint := proxy_info.logging_server:
logging_upload_endpoint = f"{str(logging_upload_endpoint).strip('/')}/"

ch = _LogTeeHandler()
log_upload_handler = _LogTeeHandler()
fmt = logging.Formatter(fmt=cfg.LOG_FORMAT)
ch.setFormatter(fmt)
log_upload_handler.setFormatter(fmt)

# star the logging thread
log_upload_endpoint = urljoin(iot_logger_url, ecu_info.ecu_id)
ch.start_upload_thread(log_upload_endpoint)

# NOTE: "otaclient" logger will be the root logger for all loggers name
# starts with "otaclient.", and the settings will affect its child loggers.
# For example, settings for "otaclient" logger will also be effective to
# "otaclient.app.*" logger and "ota_proxy.*" logger.
_otaclient_logger.addHandler(ch)
log_upload_endpoint = urljoin(logging_upload_endpoint, ecu_info.ecu_id)
log_upload_handler.start_upload_thread(log_upload_endpoint)

for logger_name, loglevel in cfg.LOG_LEVEL_TABLE.items():
_logger = logging.getLogger(logger_name)
_logger.setLevel(loglevel)
if log_upload_handler:
_logger.addHandler(log_upload_handler)
2 changes: 1 addition & 1 deletion tests/test_otaclient/test_log_setting.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

import logging

from otaclient.app import log_setting
from otaclient import log_setting

MODULE = log_setting.__name__
logger = logging.getLogger(__name__)
Expand Down

1 comment on commit 15e9974

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/ota_metadata/legacy
   __init__.py110100% 
   parser.py3263589%145, 150, 186–187, 197–198, 201, 213, 271, 281–284, 323–326, 406, 409, 417–419, 432, 441–442, 445–446, 720, 723, 735–740
   types.py841384%37, 40–42, 112–116, 122–125
src/ota_proxy
   __init__.py361072%59, 61, 63, 72, 81–82, 102, 104–106
   __main__.py770%16–18, 20, 22–23, 25
   _consts.py150100% 
   cache_control.py68494%71, 91, 113, 121
   config.py180100% 
   db.py1461589%75, 81, 103, 113, 116, 145–147, 166, 199, 208–209, 229, 258, 300
   errors.py50100% 
   orm.py1121091%92, 97, 102, 108, 114, 141–142, 155, 232, 236
   ota_cache.py4018678%98–99, 218, 229, 256–258, 278, 294–295, 297, 320–321, 327, 331, 333, 360–362, 378, 439–440, 482–483, 553, 566–569, 619, 638–639, 671–672, 683, 717–721, 725–727, 729, 731–738, 740–742, 745–746, 750–751, 755, 802, 810–812, 891–894, 898, 901–902, 916–917, 919–921, 925–926, 932–933, 964, 970, 997, 1026–1028
   server_app.py1383971%76, 79, 85, 101, 103, 162, 171, 213–214, 216–218, 221, 226–228, 231–232, 235, 238, 241, 244, 257–258, 261–262, 264, 267, 293–296, 299, 313–315, 321–323
   utils.py23195%33
src/otaclient
   __init__.py5260%17, 19
   __main__.py110%16
   log_setting.py52590%53, 55, 64–66
src/otaclient/app
   __main__.py110%16
   configs.py750100% 
   errors.py1120100% 
   interface.py50100% 
   main.py46589%52–53, 75–77
   ota_client.py39213166%67, 75, 96, 201–203, 214, 260–263, 275–278, 281–284, 294–297, 302–303, 305, 314, 317, 322–323, 326, 332, 334, 337, 379–382, 387, 391, 394, 410–413, 416–423, 426–433, 439–442, 471, 474–475, 477, 480–483, 485–486, 491–492, 495, 509–516, 523, 526–532, 579–582, 590, 626, 631–634, 639–641, 644–645, 647–648, 650–651, 653, 713–714, 717, 725–726, 729, 740–741, 744, 752–753, 756, 767, 786, 813, 832, 850
   ota_client_stub.py39410972%76–78, 80–81, 89–92, 95–97, 101, 106–107, 109–110, 113, 115–116, 119–121, 124–125, 128–130, 135–140, 144, 147–151, 153–154, 162–164, 167, 204–206, 211, 247, 272, 275, 278, 382, 406, 408, 432, 478, 535, 605–606, 645, 664–666, 672–675, 679–681, 688–690, 693, 697–700, 753, 842–844, 851, 881–882, 885–889, 898–907, 914, 920, 923–924, 928, 931
   update_stats.py106298%162, 172
src/otaclient/app/boot_control
   __init__.py40100% 
   _common.py2337667%73–74, 95–97, 113–114, 134–135, 154–155, 174–175, 194–195, 210–211, 232, 240, 258, 266, 285–286, 289–290, 313, 315–324, 326–335, 337–339, 358, 361, 369, 377, 393–395, 397–402, 495, 500, 505, 618, 622–623, 626, 634, 636–637, 711–712, 722, 740
   _grub.py41712869%216, 264–267, 273–277, 314–315, 322–327, 330–336, 339, 342–343, 348, 350–352, 361–367, 369–370, 372–374, 383–385, 387–389, 468–469, 473–474, 526, 532, 558, 580, 584–585, 600–602, 626–629, 641, 645–647, 649–651, 710–713, 738–741, 764–767, 779–780, 783–784, 819, 825, 845–846, 848, 860, 863, 866, 869, 873–875, 893–896, 924–927, 932–940, 945–953
   _jetson_cboot.py27021420%69–70, 77–78, 96–105, 117, 124–125, 137, 143–144, 154–156, 168–169, 180–181, 184–185, 188–189, 192–196, 199–200, 204–205, 210–211, 213–217, 219–225, 227–228, 233, 236, 239–240, 243, 247–248, 252–253, 257, 260, 263, 267–273, 275–277, 282, 285, 288, 292, 299, 301–304, 317, 320, 324, 326–328, 332, 339, 341, 344, 350–351, 356, 364, 372–374, 383–384, 386–388, 394, 397–399, 403–404, 406, 409, 418–420, 423, 426, 429–434, 436–438, 441, 444, 448–453, 457–459, 464–465, 469–470, 473, 476, 479–480, 483, 486, 491, 494, 497–498, 500, 502, 505, 508, 510–511, 514–518, 523–524, 526, 534–538, 540, 543, 546, 557–558, 563, 573, 576–584, 589–597, 602–610, 616–618, 621, 624
   _jetson_common.py1416653%50, 74, 129–134, 136, 141–143, 148–151, 159–160, 167–168, 173–174, 190–191, 193–195, 198–200, 203, 207, 211, 215–217, 223–224, 226, 259, 285–286, 288–290, 294–297, 299–300, 302–306, 308, 315–316, 319, 321, 331, 334–335, 338, 340
   _rpi_boot.py25812252%88–90, 96–97, 99–101, 103, 106–107, 112–113, 122–123, 127, 129, 133, 137–140, 145–147, 151–154, 178–180, 186–188, 201–203, 209–211, 224–231, 233, 237–239, 242–245, 248–249, 254, 258, 262, 266, 300, 327–329, 339–342, 346–352, 392–394, 436–440, 459–462, 467, 470, 494–497, 502–510, 515–523, 537–540, 546–548, 551
   configs.py460100% 
   protocol.py40100% 
   selecter.py382631%44–46, 49–50, 54–55, 58–60, 63, 65, 69, 77–79, 81–82, 84–85, 89, 91–93, 95, 97
src/otaclient/app/create_standby
   __init__.py12558%28–30, 32, 34
   common.py2194380%63, 66–67, 71–73, 75, 79–80, 82, 128, 176–178, 180–182, 184, 187–190, 194, 205, 279–280, 282–287, 300, 355, 358–360, 376–377, 391, 395, 417–418
   interface.py50100% 
   rebuild_mode.py99990%94–96, 108–113
src/otaclient/configs
   _common.py80100% 
   ecu_info.py57198%107
   proxy_info.py52296%88, 90
src/otaclient_api/v2
   __init__.py140100% 
   api_caller.py39684%45–47, 83–85
   api_stub.py170100% 
   types.py2562391%86, 89–92, 131, 209–210, 212, 259, 262–263, 506–508, 512–513, 515, 518–519, 522–523, 586
src/otaclient_common
   __init__.py34876%42–44, 59, 61, 67, 74–75
   common.py1582087%40, 44, 126, 232, 235–237, 252, 259–261, 327–329, 339, 348–350, 396, 400
   downloader.py2694384%72, 85–86, 301, 306, 328–329, 379–383, 402–404, 407–408, 411–412, 433–436, 440–441, 445–446, 450–451, 460, 535–537, 553, 573–575, 579, 581, 584, 589–591
   linux.py471176%45–47, 53, 63, 68, 70, 102–103, 127–128
   logging.py29196%55
   persist_file_handling.py1131884%112, 114, 146–148, 150, 176–179, 184, 188–192, 218–219
   proto_streamer.py42880%33, 48, 66–67, 72, 81–82, 100
   proto_wrapper.py3984588%87, 165, 172, 184–186, 205, 210, 221, 257, 263, 268, 299, 303, 307, 402, 462, 469, 472, 492, 499, 501, 526, 532, 535, 537, 562, 568, 571, 573, 605, 609, 611, 625, 642, 669, 672, 676, 707, 713, 760–763, 765
   retry_task_map.py84396%141, 143, 158
   typing.py250100% 
TOTAL5967135477% 

Tests Skipped Failures Errors Time
179 0 💤 0 ❌ 0 🔥 5m 5s ⏱️

Please sign in to comment.