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

doc: add best practices for logging #262

Closed
wants to merge 1 commit into from

Conversation

vishnu-narayanan
Copy link
Member

Fixes #252

@pranavrajs
Copy link
Member

pranavrajs commented Apr 22, 2022

@vishnu-narayanan @sojan-official Thanks for this, let us use this as starting point. Can we also include how the choice was made in https://github.com/chatwoot/chatwoot/pull/4314/files?

The expectation is to write down what are the considerations a new person should take while adding a logline. Please see some of the thoughts that need to be captured below.

  1. When is log-level warn used vs error?
  2. What is the default log level to be used?
  3. Should we add any tags to the logs for easy searching?
  4. Should we capitalize the logs (In the PR some of the logs are using all caps, some are using mixed characters)?

@sojan-official
Copy link
Member

  • subsequent changes to be taken in a separate PR

@sojan-official
Copy link
Member

  • we will have this content updated in the chatwoot handbook.
    cc: @pranavrajs parking for table support in markdown

@sojan-official
Copy link
Member

added https://www.chatwoot.com/hc/handbook/en/engineering/401
tables are still not supported

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

Successfully merging this pull request may close these issues.

Add best practices for logging
3 participants