Create cyhy logging module #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
felddy
added
documentation
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
Pull Request Test Coverage Report for Build 11446008098Details
💛 - Coveralls |
- Add a better summary - Add example usage - Add example output
- Removing undocumented pins (setuptools) - Removing unneeded pins (coveralls)
dav3r
reviewed
Oct 21, 2024
- Add developer name and email - Upgrade development status to production / stable Co-authored-by: dav3r <david.redmin@trio.dhs.gov> Update setup.py Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
jsf9k
approved these changes
Oct 21, 2024
felddy
added
the
hacktoberfest-accepted
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗣 Description
This PR introduces initial logging configuration for the
cyhy-loggingrepository, including setting up a basic logging infrastructure that aligns with our current standards.This configuration aims to streamline log collection and standardize logging across different components of CyHy.
💭 Motivation and context
The CyHy system requires consistent and centralized logging to effectively monitor activities, identify issues, and analyze the health of services.
This change establishes a consistent logging standard and integrates the logging service into the codebase, ensuring uniformity in logging practices across services. The approach was to implement a well-tested configuration using Python's
loggingmodule.🧪 Testing
The changes were tested using unit tests to ensure that logging output follows the desired format and level settings. Additionally, the service was run in a test environment, and logs were inspected for proper content and format.
Tests were executed in a local Docker environment running Python 3.12. Logging was validated in both
stdoutand file outputs. Verified that different log levels were correctly captured.✅ Pre-approval checklist
in code comments.
to reflect the changes in this PR.
✅ Pre-merge checklist
✅ Post-merge checklist