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

Enhance Logging Documentation with Default Values and Examples #5106

Open
mavci42 opened this issue Jan 6, 2025 · 0 comments
Open

Enhance Logging Documentation with Default Values and Examples #5106

mavci42 opened this issue Jan 6, 2025 · 0 comments

Comments

@mavci42
Copy link

mavci42 commented Jan 6, 2025

## Problem
The "Logging" section explains LOG_LEVEL and LOG_FORMAT but does not:

  1. Mention the default values for these variables.
  2. Provide examples of how to set them in a .env file or during runtime.

This lack of information may confuse new developers who are integrating logging functionality.

Additionally, the list of possible values for LOG_LEVEL and LOG_FORMAT is missing. Adding a table with these details would make the documentation clearer.

## Solution

  • Add a table or list with default values for LOG_LEVEL and LOG_FORMAT. For example:

    Variable Possible Values Default Value
    LOG_LEVEL DEBUG, INFO, WARN, ERROR, OFF INFO
    LOG_FORMAT PRETTY, JSON JSON
  • Provide examples of how to set these variables in a .env file or inline during runtime, for example:

    LOG_LEVEL=DEBUG LOG_FORMAT=PRETTY yarn start
    

## Nice to Have
-Warnings for invalid LOG_LEVEL or LOG_FORMAT values ​​would be very useful.
-Add a show-log-config command to display the current logging configuration for easier debugging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant