add use local time and show caller infomation #31
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe documentation for the Logger Plugin has been updated to include new configuration options that enhance logging behavior. Two main sections have been introduced: "Use Local Time," which allows logging in local time instead of UTC, and "Show Caller Information," which enables the inclusion of source file and line number in log messages. Examples for both configurations are provided, and the overall structure of the documentation remains unchanged. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
lab/logger.md (3)
116-135: Consider adding timezone considerationsThe documentation clearly explains the local time feature. However, consider adding a note about:
- Potential challenges in distributed systems where servers might be in different timezones
- Impact on log aggregation systems that expect consistent timestamp formats
### Use Local Time RoadRunner uses UTC time in logs by default. However, you can configure it to use local time format if your application operates within a single timezone or when local time is more appropriate for your use case. + +{% hint style="warning" %} +When using local time in distributed systems, ensure all servers are configured with the same timezone to maintain consistent logging. Additionally, consider the impact on log aggregation systems that may expect UTC timestamps. +{% endhint %}🧰 Tools
🪛 Markdownlint
132-132: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
136-154: Add concrete examples and performance noteThe documentation explains the feature well but would benefit from:
- Actual examples of log output in both console and JSON modes
- Note about potential performance impact in production
When enabled, log messages will include the caller information: - In console mode: The caller path will be displayed with color and proper alignment - In JSON mode: The caller information will be included in the "caller" field + +Example output in console mode: +```console +2024-01-10T15:04:05.123Z INFO server/plugin.go:42 Server started +``` + +Example output in JSON mode: +```json +{"level":"info","ts":"2024-01-10T15:04:05.123Z","caller":"server/plugin.go:42","msg":"Server started"} +``` + +{% hint style="info" %} +Note that enabling caller information adds a small performance overhead. Consider this when using in production environments with high log volumes. +{% endhint %}
132-134: Add language specification to code blockThe code block should specify a language for proper syntax highlighting.
-``` +```console 2024-01-10 15:04:05.123 INFO Server started<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary> 132-132: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 5b64bd6e9e93a042589bc5bd7a22bd64c5fa38d9 and 2c3ae759923085d63454144ba62966737eabc027. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `lab/logger.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 Markdownlint</summary> <details> <summary>lab/logger.md</summary> 132-132: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
for this pull request
Summary by CodeRabbit