[codex] Add logging and tracing guide#47
Merged
Conversation
Document the public logging and tracing helpers with structured log metadata examples, span attribute guidance, and their relationship to native Effect instrumentation.\n\nLink the focused guide from the docs index, update the API reference wording, add a README example, and include a patch changeset for the documentation update.
Greptile SummaryThis PR adds a focused
Confidence Score: 5/5Documentation-only change; no runtime code is modified. All changes are prose and Markdown. The documented API signatures match the source implementation exactly. No logic, types, or runtime behaviour are altered. No files require special attention.
|
| Filename | Overview |
|---|---|
| docs/logging-tracing.md | New guide covering fx.log/logWarn/logError and fx.span/trace; API signatures verified against src/logging.ts. One code block is missing the ts language tag. |
| README.md | Section heading updated and fx.log example added; consistent with the new guide and existing examples. |
| docs/README.md | New guide linked correctly in the docs index. |
| docs/api-reference.md | API table descriptions tightened to mention structured metadata and span options. |
| .changeset/fair-pandas-trace.md | Patch changeset added as required by AGENTS.md conventions. |
Reviews (2): Last reviewed commit: "docs: fix logging example yield syntax" | Re-trigger Greptile
Address the review comment by making the structured logging example use the same yield* generator syntax as the rest of the guide.\n\nThe Markdown fence is left generic because oxfmt rewrites yield* to yield * inside TypeScript Markdown fences.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/logging-tracing.mdguide coveringfx.log,fx.logWarn,fx.logError,fx.span, andfx.trace.docs/README.md, tighten the API reference wording, add a README example, and include a patch changeset.Why
Issue #35 notes that logging and tracing helpers are public API but only listed in the API reference. This PR gives users a focused behavior guide so they do not need to infer metadata and span semantics from source or Effect docs.
Validation
bun fmtbun lint:fixbun lintbun typecheckbun testCloses #35.