Skip to content

Emitter: Clarify contract of "emit". #5486

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
leventov merged 2 commits into from
Mar 14, 2018
Merged

Emitter: Clarify contract of "emit". #5486

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce00ba6
Emitter: Clarify contract of "emit".
gianm Mar 14, 2018
bbb1bce
New wording
gianm Mar 14, 2018
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
11 changes: 11 additions & 0 deletions java-util/src/main/java/io/druid/java/util/emitter/core/Emitter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,17 @@
public interface Emitter extends Closeable, Flushable
{
void start();

/**
* Emit an event. This method must not throw exceptions or block.
*
* If an implementation receives too many events and internal queues fill up, it should drop events rather than
* blocking or consuming excessive memory.
*
* If an implementation receives input it considers to be invalid, or has an internal problem, it should deal with
* that by logging a warning rather than throwing an exception. Implementations that log warnings should consider
* throttling warnings to avoid excessive logs, since a busy Druid cluster can emit a high volume of metric events.
*/
void emit(Event event);

@Override
Expand Down