Skip to content

Say what the logger hears and that queue drops are silent, in the Javadoc #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmccoystephenson merged 2 commits into from
Oct 19, 2026
Merged

Say what the logger hears and that queue drops are silent, in the Javadoc #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22b5ce4
Say what the logger hears and that queue drops are silent, in the Jav…
dmccoystephenson Oct 19, 2026
6aaeff9
Rewrap the bounded bullet in the class Javadoc
dmccoystephenson Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions src/main/java/software/stephenson/trace/TraceClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,10 @@
* are logged at {@link Level#FINE} if a logger was given, and otherwise
* not at all.</li>
* <li><b>It is bounded.</b> At most {@value #QUEUE_CAPACITY} reports wait to
* be sent; beyond that, new reports are dropped rather than accumulated.
* A trace server that is unreachable for a week costs a few kilobytes,
* not the host's heap.</li>
* be sent; beyond that, new reports are dropped rather than accumulated,
* without a log line, even at {@link Level#FINE}. A trace server
* that is unreachable for a week costs a few kilobytes, not the
* host's heap.</li>
* </ul>
*
* <p>Reporting is opt-out, and the person running the program always has the
Expand Down Expand Up @@ -958,7 +959,14 @@ public Builder installIdFile(File installIdFile) {
return this;
}

/** Where dropped reports are mentioned, at {@link Level#FINE}. Optional. */
/**
* Where problems are mentioned, at {@link Level#FINE}, prefixed
* {@code [trace]}: a report the server did not answer {@code 201}
* to or that could not be delivered, and a server-wide config or
* install ID file that could not be read or written in
* {@link #build()}. A report dropped because the queue is full is
* not mentioned. Optional; without one, nothing is logged.
*/
public Builder logger(Logger logger) {
this.logger = logger;
return this;
Expand Down
Loading