DAS-2382: Improve internal logging handling. (#47)

Author: flamingbear

.github/pull_request_template.md

@@ -12,5 +12,6 @@ A short description of the changes in this PR.
 * [ ] Jira ticket acceptance criteria met.
 * [ ] `CHANGELOG.md` updated to include high level summary of PR changes and link to release.
 * [ ] `docker/service_version.txt` updated if publishing a release.
+* [ ] Jira Smart Checklist item `harmony-regridder-X.Y.Z` added Ticket
 * [ ] Tests added/updated and passing.
 * [ ] Documentation updated (if needed).

CHANGELOG.md

@@ -4,6 +4,13 @@ The Harmony Regridding Service follows semantic versioning. All notable changes
 to this project will be documented in this file. The format is based on [Keep a
 Changelog](http://keepachangelog.com/en/1.0.0/).
 
+## [v1.9.1] - 2025-10-14
+
+### Changed
+
+- Changed internal handling of logging to ensure all logs are included with appropriate metadata when running as a harmony service.
+
+
 ## [v1.9.0] - 2025-10-08
 
 ### Added
@@ -172,6 +179,7 @@ include updated documentation and files outlined by the
 For more information on internal releases prior to NASA open-source approval,
 see legacy-CHANGELOG.md.
 
+[v1.9.1]: https://github.com/nasa/harmony-regridding-service/releases/tag/1.9.1
 [v1.9.0]: https://github.com/nasa/harmony-regridding-service/releases/tag/1.9.0
 [v1.8.0]: https://github.com/nasa/harmony-regridding-service/releases/tag/1.8.0
 [v1.7.1]: https://github.com/nasa/harmony-regridding-service/releases/tag/1.7.1

docker/service_version.txt

@@ -1 +1 @@
-1.9.0
+1.9.1

harmony_regridding_service/adapter.py

@@ -26,6 +26,7 @@
 )
 from pystac import Asset, Catalog, Item
 
+from harmony_regridding_service import log_context
 from harmony_regridding_service.exceptions import (
     InvalidInterpolationMethod,
     InvalidTargetCRS,
@@ -45,6 +46,7 @@ class RegriddingServiceAdapter(BaseHarmonyAdapter):
     def __init__(self, message, catalog=None, config=None):
         """Initialize the custom adapter."""
         super().__init__(message, catalog=catalog, config=config)
+        log_context.set_logger(self.logger)
         self.cache = {'grids': {}}
 
     def invoke(self) -> Catalog:

harmony_regridding_service/file_io.py

@@ -1,6 +1,5 @@
 """Module that handles source file copy and writing to target output."""
 
-from logging import getLogger
 from mimetypes import guess_type as guess_mime_type
 from os.path import splitext
 from pathlib import PurePath
@@ -13,8 +12,7 @@
 )
 
 from harmony_regridding_service.exceptions import SourceDataError
-
-logger = getLogger(__name__)
+from harmony_regridding_service.log_context import get_logger
 
 KNOWN_MIME_TYPES = {
     '.nc4': 'application/x-netcdf4',
@@ -145,7 +143,7 @@ def clone_variables(
             if s_var.dtype == str and s_var.shape == ():
                 t_var[0] = s_var[0]
             else:
-                logger.error('Unable to clone variable {s_var}')
+                get_logger().error('Unable to clone variable {s_var}')
                 raise SourceDataError('Unhandled variable clone') from vlen_error
 
     return variables

harmony_regridding_service/grid.py

@@ -1,7 +1,6 @@
 """Module for accessing and creating grid parameters."""
 
 from collections.abc import Iterable
-from logging import getLogger
 from typing import Any
 
 import numpy as np
@@ -34,13 +33,12 @@
     InvalidTargetGrid,
     SourceDataError,
 )
+from harmony_regridding_service.log_context import get_logger
 from harmony_regridding_service.message_utilities import (
     get_message_crs,
     target_crs_from_message,
 )
 
-logger = getLogger(__name__)
-
 
 def compute_target_areas(
     message: HarmonyMessage,
@@ -86,6 +84,7 @@ def compute_target_areas(
             filepath, var_info, target_crs
         )
 
+    logger = get_logger()
     logger.debug('Using TARGET Area Definitions:')
     for dim_pair, area in area_definitions.items():
         logger.debug(f'dim_pair: {dim_pair}')
@@ -128,7 +127,7 @@ def create_target_areas_from_source(
     dimension_pairs = get_resampled_dimension_pairs(var_info)
     target_areas = {}
     for dim_pair in dimension_pairs:
-        logger.info(f'Generating Target Areas from Source for: {dim_pair}')
+        get_logger().info(f'Generating Target Areas from Source for: {dim_pair}')
         projected_area = create_area_definition_for_projected_source_grid(
             filepath, dim_pair, var_info
         )
@@ -168,6 +167,7 @@ def convert_projected_area_to_geographic(
         area_extent=geographic_extent,
         resolution=resolution,
     )
+    logger = get_logger()
     logger.debug(f'Source projected Area: {projected_area}')
     logger.debug(f'Converted Geographic Area: {geographic_area}')
 
@@ -311,7 +311,7 @@ def get_area_definition_from_message(
 
     projection = message.format.crs or 'EPSG:4326'
 
-    logger.info(
+    get_logger().info(
         f'Creating target area from message:\n'
         f'proj:{projection}\n'
         f'area_extent:{area_extent}\n'
@@ -375,6 +375,7 @@ def compute_horizontal_source_grids(
     """
     row_dim = get_row_dims(grid_dimensions, var_info)[0]
     column_dim = get_column_dims(grid_dimensions, var_info)[0]
+    logger = get_logger()
     logger.info(f'found row_dim: {row_dim}')
     logger.info(f'found column_dim: {column_dim}')
 
@@ -452,7 +453,7 @@ def create_area_definition_for_projected_source_grid(
                 resolution=(cell_width, cell_height),
             )
     except Exception as e:
-        logger.error(e)
+        get_logger().error(e)
         raise SourceDataError('cannot compute projected source grids') from e
 
 

harmony_regridding_service/log_context.py

@@ -0,0 +1,25 @@
+"""Logging Context.
+
+This module is used to capture the logging context from harmony and allow easy
+access to all of the modules in this service.
+
+We are capturing the logger that harmony service lib has created and allowing
+all of the modules in the service to access and use without having to pass a
+logging object in each function signature.
+
+"""
+
+from logging import getLogger
+
+_LOGGER = None
+
+
+def set_logger(logger):
+    """Set the logger context for this request's session."""
+    global _LOGGER
+    _LOGGER = logger
+
+
+def get_logger(default_name='harmony-service.regridder'):
+    """Get the context logger or fall back to module logger."""
+    return _LOGGER if _LOGGER else getLogger(default_name)

harmony_regridding_service/regridding_cli.py

@@ -4,6 +4,7 @@
 
 from harmony_service_lib.message import Source as HarmonySource
 
+from harmony_regridding_service.log_context import set_logger
 from harmony_regridding_service.message_utilities import get_harmony_message_from_params
 from harmony_regridding_service.regridding_service import regrid
 
@@ -45,5 +46,7 @@ def regrid_cli_entry(
     call_logger: [Logger], a configured logging object.
 
     """
+    if call_logger:
+        set_logger(call_logger)
     harmony_message = get_harmony_message_from_params(params)
-    return regrid(harmony_message, source_filename, HarmonySource(source), call_logger)
+    return regrid(harmony_message, source_filename, HarmonySource(source))

harmony_regridding_service/regridding_service.py

@@ -1,6 +1,6 @@
 """Regridding service code."""
 
-from logging import Logger, getLogger
+from logging import Logger, LoggerAdapter
 from pathlib import Path
 
 from harmony_service_lib.message import Message as HarmonyMessage
@@ -27,6 +27,7 @@
     transfer_metadata,
 )
 from harmony_regridding_service.grid import compute_target_areas
+from harmony_regridding_service.log_context import get_logger
 from harmony_regridding_service.resample import (
     cache_resamplers,
     copy_resampled_dimension_variables,
@@ -36,8 +37,6 @@
 )
 from harmony_regridding_service.var_utilitities import get_unprocessable_variables
 
-logger = getLogger(__name__)
-
 
 def varinfo_config_filename() -> str:
     """Return a path to the varinfo config."""
@@ -48,11 +47,10 @@ def regrid(
     message: HarmonyMessage,
     input_filepath: str,
     source: HarmonySource,
-    call_logger: Logger,
+    logger: Logger | LoggerAdapter | None = None,
 ) -> str:
     """Regrid the input data at input_filepath."""
-    global logger
-    logger = call_logger or logger
+    logger = logger or get_logger()
     logger.info(f'Format:\n {message.format}')
     logger.info(f'Source:\n {source}')
 

harmony_regridding_service/resample.py

@@ -1,6 +1,5 @@
 """Module for resampling functions."""
 
-from logging import getLogger
 from pathlib import PurePath
 
 import numpy as np
@@ -35,8 +34,7 @@
     dims_are_lon_lat,
     dims_are_projected_x_y,
 )
-
-logger = getLogger(__name__)
+from harmony_regridding_service.log_context import get_logger
 
 
 def resample_variable_data(
@@ -78,7 +76,7 @@ def resample_n_dimensional_variables(
 ) -> set[str]:
     """Function to resample any projected variable."""
     processed = set()
-
+    logger = get_logger()
     for var_name in variables:
         logger.debug(f'resampling {var_name}')
         try:
@@ -325,7 +323,7 @@ def cache_resamplers(
     """
     grid_cache = {}
     for dim_pair in get_resampled_dimension_pairs(var_info):
-        logger.debug(f'computing weights for dimensions {dim_pair}')
+        get_logger().debug(f'computing weights for dimensions {dim_pair}')
         # create swath definitions for each grid in the source file.
         source_swath = compute_source_swath(dim_pair, filepath, var_info)
         grid_cache[dim_pair] = DaskEWAResampler(source_swath, target_areas[dim_pair])
@@ -416,7 +414,7 @@ def get_rows_per_scan(total_rows: int) -> int:
         if total_rows % row_number == 0:
             return row_number
 
-    logger.info(f'returning all rows for rows_per_scan = {total_rows}')
+    get_logger().info(f'returning all rows for rows_per_scan = {total_rows}')
     return total_rows
 
 
@@ -468,7 +466,7 @@ def needs_rotation(var_info: VarInfoFromNetCDF4, variable: str) -> bool:
         None,
     )
     if row_loc > column_loc:
-        logger.info(f'Incorrect dimension order on {variable}, needs rotation.')
+        get_logger().info(f'Incorrect dimension order on {variable}, needs rotation.')
         variable_needs_rotation = True
 
     return variable_needs_rotation