Skip to content

docs(logger): complete stack Preview example walkthrough - #247

Merged
jinxiao merged 1 commit into
mainfrom
docs/logger-stack-preview-readme
Oct 15, 2026
Merged

jinxiao merged 1 commit into
mainfrom
docs/logger-stack-preview-readme

Conversation

@jinxiao

@jinxiao jinxiao commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

Issue

Refs #246

Summary

Make the Logger stack Preview example readable and runnable directly from its GitHub README. Include the complete program with imports, repository and standalone setup (including PowerShell), and the two observed JSON records. Explain source versus logging-site locations, stderr and exit behavior, and the logging-failure branches.

Show the opt-out configuration and its resulting error objects. Keep the main-only Preview notice and explain where handler panic logging belongs without suggesting this local program starts Lambda.

Testing

  • Ran the existing repository example with CGO_ENABLED=0: two ERROR records and successful exit.
  • Created an independent module with GOWORK=off, CGO_ENABLED=0, no local replacements, and logger@main from the direct Git origin. It resolved to v1.2.1-0.20261015103609-39ffe806f2c7.
  • Verified the README program exactly matches main.go; compared both complete JSON records with actual stderr after normalizing only timestamps and source paths. Stdout was empty.
  • Ran the documented opt-out variant and compared both error objects with the README; it also exited successfully.
  • website/check_guides.py: passed all 26 guides and application logging checks.
  • git diff --check: passed.

Risks and compatibility

Documentation only. No Go source, API, module metadata, version tags, or releases changed. The Preview remains available only from main and absent from v1.2.0. No cloud tests were run.

Release notes

  • examples | documentation | Complete the Logger stack Preview walkthrough with setup, full source, observed output, and opt-out behavior.

Checklist

  • The issue records the scope and acceptance criteria
  • Tests and documentation match the change, or I explained why they are not applicable
  • I kept CGO disabled and did not run cloud AWS tests without authorization
  • I excluded credentials, personal configuration, and generated build artifacts

@jinxiao
jinxiao merged commit 35f9d08 into main Oct 15, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant