Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(dashmate)!: enhance core logging configuration #2121

Merged
merged 11 commits into from
Sep 17, 2024

Conversation

shumkov
Copy link
Member

@shumkov shumkov commented Sep 15, 2024

Issue being fixed or feature implemented

Dashmate enables core logging into file by default. Users do not expect it and not aware of this file. Furthermore, the log file is growing in size quite fast and might crash node taking all available disk space.

What was done?

  • Disabled Core logging into file by default.
  • Changed core logging configuration structure to make it more understandable:
         log: {
           filePath: null,
           debug: {
             enabled: false,
             ips: false,
             sourceLocations: false,
             threadNames: false,
             timeMicros: false,
             includeOnly: [],
             exclude: [],
           },
         },
  • Added sourceLocations, threadNames, timeMicros, and exclude options

How Has This Been Tested?

Running locally and CI

Breaking Changes

  • Core is not logging anymore to file by default
  • Configuration option core.log.file.path changed to core.log.filePath
  • Configuration option core.log.file.categories changed to core.log.debug.includeOnly
  • Configuration option core.logIps changed to core.log.debug.ips

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

@shumkov shumkov added this to the v1.3.0 milestone Sep 15, 2024
pshenmic
pshenmic previously approved these changes Sep 15, 2024
@shumkov shumkov self-assigned this Sep 16, 2024
@shumkov shumkov merged commit 79da90a into v1.3-dev Sep 17, 2024
21 checks passed
@shumkov shumkov deleted the feat/dashmate/enchance-core-logging branch September 17, 2024 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants