Refine logging docs

[osterman]

what

• shorten logging.md section and link to structured-logging.md
• clarify lint rule usage for structured logging keys

why

• reduce duplication and clarify use of Staticcheck ST1019

references

• n/a

---

https://chatgpt.com/codex/tasks/task_b_68535c9aa3488332887d805779c0bc63

Summary by CodeRabbit

• Documentation
  • Expanded and clarified logging guidelines, detailing the distinction between user-facing output and developer logging.
  • Added comprehensive explanations of structured and semantic logging, including best practices and examples.
  • Introduced a new guide on using the Charm Logger and provided references for further reading.
  • Improved clarity on log levels, usage contexts, and tooling for better understanding and consistency.

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

The documentation was expanded to clarify logging practices in Atmos. The updates introduce structured and semantic logging concepts, distinguish between user-facing output and developer logs, and provide detailed guidelines and examples. No code or exported entities were changed; the updates are limited to documentation files.

Changes

Files	Change Summary
docs/logging.md	Expanded with detailed logging guidelines, distinction between UI output and logging, structured logging intro, and clarified usage contexts.
docs/structured-logging.md	New file added explaining structured and semantic logging concepts, benefits, usage, and linting rules.

Possibly related PRs

• cloudposse/atmos#1082: Updates lint rules for loggercheck, validating structured logging keys—related through logging practices and documentation focus.

Suggested labels

no-release

Suggested reviewers

• aknysh

✨ Finishing Touches

🧪 Generate Unit Tests

• [ ] Create PR with Unit Tests
• [ ] Post Copyable Unit Tests in Comment
• [ ] Commit Unit Tests in branch mgs4la-codex/update-docs-on-logging-vs-textui-and-structured-logging

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @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 or @auto-summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

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.

[codecov[bot]]

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 50.14%. Comparing base (913fe03) to head (7886266). :warning: Report is 34 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1320      +/-   ##
==========================================
- Coverage   50.66%   50.14%   -0.53%     
==========================================
  Files         237      237              
  Lines       25777    25777              
==========================================
- Hits        13061    12926     -135     
- Misses      11085    11234     +149     
+ Partials     1631     1617      -14     

Flag	Coverage Δ
unittests	50.14% <ø> (-0.53%)	:arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions[bot]]

These changes were released in v1.189.0-test.0.