Update logger initialization to use module-specific loggers #140

samriddhi99 · 2024-07-19T06:13:58Z

Currently, tirith uses logger = logging.getLogger() to create logger objects in various modules. This approach uses the root logger, which is not ideal as it lacks context about where the logging messages are coming from. We should update these instances to use logger = logging.getLogger(name), which will create a logger named after the module.

Tasks:

Search for all instances of logger = logging.getLogger() in the codebase.
Replace logger = logging.getLogger() with logger = logging.getLogger(name).
Ensure all logging messages continue to work as expected.
Run tests to confirm that no existing functionality is broken by this change.

chetak123 · 2024-07-19T08:38:59Z

I would like to take this up please.

AkashS0510 · 2024-07-24T03:01:38Z

Have resolved the issue. Kindly review the PR.

Changed "logger = logging.getLogger()" line of code to "logger = logging.getLogger(__name__)" in all files Removed the TODO Comments - "# TODO: At least add __name__ as the name for the logger" in all files #140

samriddhi99 · 2024-07-29T13:25:07Z

Closed by Pr #143

Fix: corrected the file name __init__.py Signed-off-by: pravo23 <[email protected]> Enhance GitHub Actions Workflow with PR Triggers (StackGuardian#148) * Add PR triggers to github actions workflow * Update lint.yml Centralized version definition to simplify version management (StackGuardian#142) Co-authored-by: Rafid Aslam <[email protected]> Update build_test.yml (StackGuardian#149) * Update build_test.yml * Update lint.yml Update logger initialization to use module-specific loggers StackGuardian#140 Changed "logger = logging.getLogger()" line of code to "logger = logging.getLogger(__name__)" in all files Removed the TODO Comments - "# TODO: At least add __name__ as the name for the logger" in all files StackGuardian#140 Removed RESULTS text from error Resolved - Generalize the function get_path_value_from_dict Refactor get_path_value_from_dict Moved get_path_value_from_dict to common.py. Refactored Kubernetes and JSON handler files to import from common.py. Updated Common.py Fix linting (StackGuardian#167) Add a getting started guide in README.md (StackGuardian#139) * Add a getting started guide in README.md * Add description of getting started activity, and some minor fixes Add maintainers in README and CODEOWNERS file Add additional rules and guidelines to contributing.md Add examples for commit messages and guidelines for solving issues Update CONTRIBUTING.md with guidelines about solving issues Add separate heading about solving issues, and add examples for writing descriptions in commit changes setup the docs base (StackGuardian#177) * created the template for the official documentation * setting up the environment * cleaned up the documentation setup * adjusted the color scheme * setup the basic pages for the tirith documentation * updated the intro page Add dev container Add dev container Closes StackGuardian#175 Update Readme.MD Simplify type checking in sort_collections() Closes StackGuardian#185 Add Variable Replacement Support in Tirith Policies (StackGuardian#171) * Add support for parameterizing Tirith policies * Use pydash.get() and check for match only if the value is of type str * Add variable replacement for meta and eval_expression in a policy * Add unit tests for policy parameterization, change return type for cases where the path was not found, and change syntax of entering the variable names * Fix linting * tirith parametrization --------- Co-authored-by: Rafid Aslam <[email protected]> Removed RESULTS text from error Resolved - Generalize the function get_path_value_from_dict Refactor get_path_value_from_dict Moved get_path_value_from_dict to common.py. Refactored Kubernetes and JSON handler files to import from common.py. Updated Common.py Fix linting (StackGuardian#167) Add a getting started guide in README.md (StackGuardian#139) * Add a getting started guide in README.md * Add description of getting started activity, and some minor fixes Add maintainers in README and CODEOWNERS file Add additional rules and guidelines to contributing.md Add examples for commit messages and guidelines for solving issues Update CONTRIBUTING.md with guidelines about solving issues Add separate heading about solving issues, and add examples for writing descriptions in commit changes Merge branch 'main' of https://github.com/StackGuardian/tirith

* Requested Changes - Changed some variable names to snake case - Removed unused imports from cli.py - Added Some dev dependencies like autopep8 and pylint for effective searches will remove before final commit - Added a custom py file to filter pylint logs, will remove before final commit * removed filter script and logs, and changed names where's its needed * Add installation instruction to README.md Fix: corrected the file name __init__.py Signed-off-by: pravo23 <[email protected]> Enhance GitHub Actions Workflow with PR Triggers (#148) * Add PR triggers to github actions workflow * Update lint.yml Centralized version definition to simplify version management (#142) Co-authored-by: Rafid Aslam <[email protected]> Update build_test.yml (#149) * Update build_test.yml * Update lint.yml Update logger initialization to use module-specific loggers #140 Changed "logger = logging.getLogger()" line of code to "logger = logging.getLogger(__name__)" in all files Removed the TODO Comments - "# TODO: At least add __name__ as the name for the logger" in all files #140 Removed RESULTS text from error Resolved - Generalize the function get_path_value_from_dict Refactor get_path_value_from_dict Moved get_path_value_from_dict to common.py. Refactored Kubernetes and JSON handler files to import from common.py. Updated Common.py Fix linting (#167) Add a getting started guide in README.md (#139) * Add a getting started guide in README.md * Add description of getting started activity, and some minor fixes Add maintainers in README and CODEOWNERS file Add additional rules and guidelines to contributing.md Add examples for commit messages and guidelines for solving issues Update CONTRIBUTING.md with guidelines about solving issues Add separate heading about solving issues, and add examples for writing descriptions in commit changes setup the docs base (#177) * created the template for the official documentation * setting up the environment * cleaned up the documentation setup * adjusted the color scheme * setup the basic pages for the tirith documentation * updated the intro page Add dev container Add dev container Closes #175 Update Readme.MD Simplify type checking in sort_collections() Closes #185 Add Variable Replacement Support in Tirith Policies (#171) * Add support for parameterizing Tirith policies * Use pydash.get() and check for match only if the value is of type str * Add variable replacement for meta and eval_expression in a policy * Add unit tests for policy parameterization, change return type for cases where the path was not found, and change syntax of entering the variable names * Fix linting * tirith parametrization --------- Co-authored-by: Rafid Aslam <[email protected]> Removed RESULTS text from error Resolved - Generalize the function get_path_value_from_dict Refactor get_path_value_from_dict Moved get_path_value_from_dict to common.py. Refactored Kubernetes and JSON handler files to import from common.py. Updated Common.py Fix linting (#167) Add a getting started guide in README.md (#139) * Add a getting started guide in README.md * Add description of getting started activity, and some minor fixes Add maintainers in README and CODEOWNERS file Add additional rules and guidelines to contributing.md Add examples for commit messages and guidelines for solving issues Update CONTRIBUTING.md with guidelines about solving issues Add separate heading about solving issues, and add examples for writing descriptions in commit changes Merge branch 'main' of https://github.com/StackGuardian/tirith

samriddhi99 added the good first issue Good for newcomers label Jul 19, 2024

AkashS0510 mentioned this issue Jul 24, 2024

Resolved Issue - Update logger initialization to use module-specific loggers #140 #143

Merged

samriddhi99 closed this as completed Jul 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update logger initialization to use module-specific loggers #140

Update logger initialization to use module-specific loggers #140

samriddhi99 commented Jul 19, 2024

chetak123 commented Jul 19, 2024

AkashS0510 commented Jul 24, 2024

samriddhi99 commented Jul 29, 2024