Skip to content

More-controllable logging#3591

Draft
mwoodiupui wants to merge 5 commits intoDSpace:mainfrom
mwoodiupui:logging
Draft

More-controllable logging#3591
mwoodiupui wants to merge 5 commits intoDSpace:mainfrom
mwoodiupui:logging

Conversation

@mwoodiupui
Copy link
Member

@mwoodiupui mwoodiupui commented Oct 31, 2024

Description

Use Winston to make logging more controllable, handle log cutoff, and the like.

Instructions for Reviewers

List of changes in this PR:

  • Invented a logging module and interface, using Winston to provide flexible logging behavior.
  • Extended the configuration to express logging options.
  • Revamped logging in the server to use the new module.

Include guidance for how to test or review your PR. This may include: steps to reproduce a bug, screenshots or description of a new feature, or reasons behind specific changes.

Checklist

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

@mwoodiupui mwoodiupui added improvement work in progress needs discussion needs documentation PR is missing documentation. All new features and config changes require documentation. labels Oct 31, 2024
@mwoodiupui mwoodiupui self-assigned this Oct 31, 2024
@mwoodiupui
Copy link
Member Author

I need to extend this throughout the project -- right now it only affects server.ts. I'm providing a PR now to make it easy to tell me what's wrong with my approach.

@github-actions
Copy link

github-actions bot commented Nov 1, 2024

Hi @mwoodiupui,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

@github-actions
Copy link

Hi @mwoodiupui,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement merge conflict needs discussion needs documentation PR is missing documentation. All new features and config changes require documentation. work in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant