Skip to content

Say which thread the Logger runs on, and that CI runs UBSan - #22

Merged
dmccoystephenson merged 1 commit into
mainfrom
feature/docs-sweep-logger-thread-ci
Oct 31, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
feature/docs-sweep-logger-thread-ci

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

Stage A documentation accuracy sweep: every claim in README.md and the comments in trace_client.hpp was checked against the code, Makefile, CMakeLists.txt and .github/workflows/build.yml. Three drifts were found and fixed; no code behavior is changed.

  • Logger thread — the "Never throws" row of the promise table now states which thread the Logger is called on. The header's Logger typedef comment already said it (failed deliveries on the client's thread via deliver, a full queue on the reporting thread via enqueue); the README did not, and a program supplying a non-thread-safe logger needs to know.
  • CI description — "Building" listed ThreadSanitizer and AddressSanitizer, but the linux-sanitizers job runs thread and address,undefined; UndefinedBehaviorSanitizer is now named.
  • TIMEOUT_SECONDS comment — said it is "the most close() waits for queued reports", which close(seconds) / close(INFINITY) make untrue; it now says "by default". Comment-only change in trace_client.hpp.

Everything else checked held: queue capacity 256, 5 s timeout, 255-byte limits, 32 tags, opt-out values and precedence, all four disabledReason() strings, the curl command line and config lines, the User-Agent version (0.3.0 in all three places), and the CMake test binary path.

No tracking issue — gap found during triage.

Deferred issues

The README still says every event carries version and that TRACE_CLIENT_CURL overrides the executable; those statements are the subject of #21 and #1 and were left as they are.

Test plan

  • make clean && make test (g++, C++11): 59 tests, 0 failed checks, 59 entries in tests[]
  • CI Build green on the PR head

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

The README now states what the header comment on Logger already did: a
failed delivery is mentioned on the client's thread, a full queue on the
thread that called report. The CI description names the
UndefinedBehaviorSanitizer leg the address,undefined job runs, and the
TIMEOUT_SECONDS comment no longer says it is the most close() can wait,
which close(seconds) has made untrue.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric (performed inline in a headless dispatch; not an independent review):

  • Scope: PASS — two README sentences and one comment line in trace_client.hpp; each corresponds to one drift named in the PR body. No formatting churn.
  • Tests-new: PASS (n/a) — no new public function or behavior.
  • Tests-fix: PASS (n/a) — no bug fix; documentation and comment only.
  • Sibling structure / renames: PASS (n/a) — no new files, no renamed identifiers.
  • Docs: PASS — the new Logger sentence was checked against every log( call site: trace_client.hpp:819 and :823 (inside deliver, run by drain on the sending thread) and trace_client.hpp:1180 (inside enqueue, on the caller of report). No other call site exists. The sanitizer wording matches .github/workflows/build.yml (sanitize: ['thread', 'address,undefined']).
  • Issue resolution: PASS (n/a) — no Closes; no tracking issue.
  • CI: PASS — all 12 Build jobs green on the head commit, including both linux-sanitizers legs, macos and windows.
  • Registered: PASS (n/a) — no test functions added; local run printed 59 tests, 0 failed checks, unchanged.
  • C++11: PASS — make test (g++, -std=c++11 -Werror) built clean; CI c++11 legs green.
  • No new dependency / Never throws / Curl argv fixed: PASS — the only header change is inside a /** */ comment.
  • Version triple: PASS (n/a) — unchanged at 0.3.0 in all three places.

Judgment call flagged: README.md:104 — the "Never throws" row grows by one sentence; the thread note could alternatively live under its own row. It was kept in the row that already introduces the Logger so the definition and its threading stay together.

Do-not-auto-merge paths: none touched (no workflow, Makefile, CMakeLists, curl/spawn code, version or wire-format change).

This comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 60f47be into main Oct 31, 2026
11 checks passed
@dmccoystephenson
dmccoystephenson deleted the feature/docs-sweep-logger-thread-ci branch October 31, 2026 02:31
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