fix(docs): Correct minutes format specifier in example format string (fixes #164).

[kirkrodrigues]

Description

As #164 describes, in the docs, the example format string uses the wrong format specifier for minutes (the issue says months, but means minutes). This PR fixes the doc.

Validation performed

Validated that opening the following file in the log viewer, and formatting it with the format string in the example showed the minutes of the second log as 59 (✅) rather than 12 (❌).

{"@timestamp":1735689600000,"level":"INFO","an.odd.key{name}":"Happy New Year!"}
{"@timestamp":1735689599999,"level":"INFO","an.odd.key{name}":"We need to go back to the future!"}

Summary by CodeRabbit

• Documentation
  • Updated structured log format string documentation
  • Corrected timestamp minute representation from uppercase MM to lowercase mm

[coderabbitai]

Walkthrough

The documentation for structured log format strings has been updated to correct the timestamp formatting syntax. The change involves modifying the minutes representation in the timestamp format from uppercase MM (months) to lowercase mm (minutes) in the example format string. This adjustment ensures more accurate representation of time formatting in the structured log documentation.

Changes

File	Change Summary
docs/src/user-guide/format-struct-logs-syntax.md	Updated timestamp format string from HH\:MM\:ss.SSS to HH\:mm\:ss.SSS to correctly represent minutes

The modification is a minor documentation correction that clarifies the correct syntax for time formatting in structured log format strings, specifically addressing the representation of minutes in the timestamp placeholder.

Finishing Touches

• 📝 Generate Docstrings

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/src/user-guide/format-struct-logs-syntax.md (1)

83-83: Consider adding a reference table for timestamp format specifiers

To prevent similar confusion in the future, consider adding a quick reference table showing common timestamp format specifiers and their meanings (e.g., MM=month, mm=minutes, etc.).

Here's a suggested addition:

Common timestamp format specifiers:
- YYYY: Year (e.g., 2024)
- MM: Month (01-12)
- DD: Day (01-31)
- HH: Hour in 24h format (00-23)
- mm: Minutes (00-59)
- ss: Seconds (00-59)
- SSS: Milliseconds (000-999)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f74bacf and 47d7b96.

📒 Files selected for processing (1)

• docs/src/user-guide/format-struct-logs-syntax.md (1 hunks)

🔇 Additional comments (1)

docs/src/user-guide/format-struct-logs-syntax.md (1)

83-83: The format specifier correction looks good, eh!

The change from MM (months) to mm (minutes) in the timestamp format string is correct and matches the expected behaviour for time formatting.

[junhaoliao]

For the PR title, how about

fix(docs): Correct minute format specifier in example format string (fixes #164).

[kirkrodrigues]

For the PR title, how about

fix(docs): Correct minute format specifier in example format string (fixes #164).

Sure. Mind if I use "minutes"? "minute" technically has two meanings (a period of time or something small).

[junhaoliao]

For the PR title, how about

fix(docs): Correct minute format specifier in example format string (fixes #164).

Sure. Mind if I use "minutes"? "minute" technically has two meanings (a period of time or something small).

sure