atmos Refine logging docs

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 restructured the logging guidelines to clarify the distinction between user-facing UI output and developer-oriented logging.
- Added detailed explanations of structured and semantic logging, including best practices, benefits, and usage examples.
- Introduced a new guide on structured logging, covering conventions, tools, and further reading resources.

Jun 19 '25 22:06 osterman

[!WARNING] This PR is blocked from merging because a required semver label is missing.
major, minor, patch, no-release
You'll need to add one before this PR can be merged.

Jun 19 '25 22:06 github-actions[bot]

[!WARNING] This PR is blocked from merging because a required semver label is missing.
major, minor, patch, no-release
You'll need to add one before this PR can be merged.

Jun 19 '25 22:06 github-actions[bot]

📝 Walkthrough

Walkthrough

The changes expand and reorganize the logging documentation. The main logging guide now distinguishes between terminal UI output and logging, introduces structured and semantic logging concepts, and references a new, dedicated document that details structured logging practices and conventions.

Changes

File(s)	Change Summary
docs/logging.md	Expanded and restructured to clarify logging vs UI output, introduce structured/semantic logging, and reorganize log level guidance.
docs/structured-logging.md	New document added, detailing structured and semantic logging concepts, usage, conventions, and tooling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Atmos CLI
    participant TextUI
    participant Logger

    User->>Atmos CLI: Run Command
    Atmos CLI->>TextUI: Output user-facing info (stderr)
    Atmos CLI->>Logger: Record structured log event (key/value)
    Logger-->>Atmos CLI: Log stored or sent to telemetry

Possibly related PRs

cloudposse/atmos#793: Documents logging conventions and log level usage, overlapping with the current PR's expanded logging documentation.

Suggested labels

no-release

Suggested reviewers

Gowiem

✨ Finishing Touches

🧪 Generate Unit Tests

[ ] Create PR with Unit Tests
[ ] Post Copyable Unit Tests in Comment
[ ] Commit Unit Tests in branch 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

🪧 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.

Jun 19 '25 22:06 coderabbitai[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 50.72%. Comparing base (6fcb820) to head (617e8c7). Report is 13 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1319   +/-   ##
=======================================
  Coverage   50.71%   50.72%           
=======================================
  Files         237      237           
  Lines       25777    25777           
=======================================
+ Hits        13074    13076    +2     
+ Misses      11071    11066    -5     
- Partials     1632     1635    +3

Flag	Coverage Δ
unittests	`50.72% <ø> (+<0.01%)`	:arrow_up:

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.

Jun 19 '25 22:06 codecov[bot]