Skip to content

docs: document LOG_LEVEL as a backend env variable (#258)#438

Open
olaayoade27-coder wants to merge 1 commit into
dev-fatima-24:mainfrom
olaayoade27-coder:feat/issue-258-structured-json-logging
Open

docs: document LOG_LEVEL as a backend env variable (#258)#438
olaayoade27-coder wants to merge 1 commit into
dev-fatima-24:mainfrom
olaayoade27-coder:feat/issue-258-structured-json-logging

Conversation

@olaayoade27-coder
Copy link
Copy Markdown

pr close #258

Add LOG_LEVEL to the backend environment variable table in README.md, .env.example, and docs/configuration.md. The Winston-based structured JSON logging with request IDs was already implemented; this commit closes the documentation gap so operators know the variable is configurable for the backend (error|warn|info|http|debug).

Description

Please include a summary of the changes and related context.

Closes #(issue number)

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Changes Made

Testing

Please describe the tests you ran and how to reproduce them:

  • Unit tests pass
  • Integration tests pass
  • Manual testing completed

Test Coverage:

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests passed locally with my changes
  • Any dependent changes have been merged and published
  • If this PR adds a new directory or key file, I have updated docs/folder-structure.md.

Screenshots (if applicable)

If your changes include UI modifications, please add screenshots here.

Additional Notes

Any additional information that reviewers should know.

Add LOG_LEVEL to the backend environment variable table in README.md,
.env.example, and docs/configuration.md. The Winston-based structured
JSON logging with request IDs was already implemented; this commit
closes the documentation gap so operators know the variable is
configurable for the backend (error|warn|info|http|debug).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BACKEND] Add structured JSON logging with request IDs

1 participant