feat: add new logger #161
Closed
feat: add new logger #161
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
- use winston logger with custom format for dev/test and prod - add custom redactor - reviewed existing log calls for standardization - remove logger from front end components
zkoppert
reviewed
Jun 11, 2024
| @@ -1,58 +1,98 @@ | |||
| import { Logger } from 'tslog' | |||
There was a problem hiding this comment.
Since we are replacing tslog, does it need to be removed from the package.json or is it a builtin library?
zkoppert
reviewed
Jun 11, 2024
zkoppert
reviewed
Jun 11, 2024
zkoppert
reviewed
Jun 11, 2024
zkoppert
reviewed
Jun 11, 2024
| @@ -38,24 +38,34 @@ export const createAllPushProtection = async ( | |||
| 'all-branch-protections-icf', | |||
| ['~ALL'], | |||
| ) | |||
|
|
|||
| rulesLogger.info('Branch protection created') | |||
There was a problem hiding this comment.
I'd be interested to hear the logic behind when you use info level versus debug.
zkoppert
reviewed
Jun 11, 2024
| @@ -23,7 +23,7 @@ export const checkInstallationHandler = async ({ | |||
|
|
|||
| return { installed: false } | |||
| } catch (error) { | |||
| octokitApiLogger.info('Failed to check installation', { input, error }) | |||
| octokitApiLogger.info(new Error('Failed to check installation')) | |||
There was a problem hiding this comment.
Suggested change
| octokitApiLogger.info(new Error('Failed to check installation')) | |
| octokitApiLogger.info(new Error('Failed to check app installation')) |
zkoppert
reviewed
Jun 11, 2024
| @@ -59,7 +59,7 @@ export const createMirrorHandler = async ({ | |||
| } | |||
|
|
|||
| if (!(e as Error).message.includes('Not Found')) { | |||
| logger.error({ error: e }) | |||
| logger.error(e) | |||
There was a problem hiding this comment.
Why use the main logger here rather than the reposApiLogger?
zkoppert
reviewed
Jun 11, 2024
src/utils/logger.ts
Outdated
Comment on lines
20
to
24
| if ( | ||
| process.env.NODE_ENV === 'development' || | ||
| process.env.NODE_ENV === 'test' || | ||
| process.env.TEST_LOGGING === '1' | ||
| ) { |
|
Closing this PR in favor of #166. |
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.
Pull Request
Proposed Changes
Readiness Checklist
Author/Contributor
npm run lintand fix any linting issues that have been introducednpm run testand run tests@jeffrey-luszczReviewer
bug,documentation,enhancement,infrastructure,maintenance, orbreaking