docs: document the per-actor usage events channel - #1559
Merged
Jeff Luo (JeffLuoo) merged 1 commit intoSep 9, 2026
Conversation
The observability guide covered the actor stats metrics only through the registry pointer; the events channel -- the per-actor half of the cardinality split -- had no documentation at all. Add a Per-Actor Usage Events section to the logging guide: an example record, how to filter (msg plus kind, with the identity label group shared with lifecycle events and container logs so the existing query dimensions apply unchanged), what each measurement means -- the point-in-time fields versus the two that accumulate within an epoch, whose boundary depends on the source -- the sampling knob, and the delivery contract (best-effort behind a bounded queue, independent of --log-level). Close with the rule consumers must not break: a log-based metric over these events must never label by actor identity, which is exactly the cardinality the split keeps out of the TSDB. Cross-link from the metrics section, which names the ate.actor.stats.* instruments and points here for per-actor detail.
Tim Bai (baizhenyu)
added
area/observability
kind/docs
Jeff Luo (JeffLuoo)
approved these changes
Sep 9, 2026
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
2 participants
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.
Documents the per-actor usage events channel that #1206 added, closing the docs request from that review.
New
Per-Actor Usage Eventssection in the logging guide:msg+kind; identity rides the same label group as lifecycle events and container logs, so the guide's existing query dimensions apply unchanged, and onelabels."ate.actor.uid"filter returns an actor's output, transitions, and usage interleaved);memory_current_bytes/memory_working_set_bytesare point-in-time, whilememory_peak_bytes/cpu_usage_usecaccumulate within an epoch whose boundary depends onsource(cgroup restarts on restore, guest-agent survives it) — so window CPU is the increase between samples, never a sum;--actor-stats-poll-interval) and the delivery contract (best-effort behind a bounded queue, independent of--log-level);The metrics section now names the
ate.actor.stats.*instruments in its registry pointer and cross-links here for per-actor detail.Every technical claim is checked against the code and the
WorkloadStatsSampleproto contract (epoch scoping, thememory.peak/Linux 5.19 caveat, trace-context absence, drop-warning text, flag semantics).