Skip to content
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.

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

[Job](Fix)Improve Event Publishing with Timeout #45103

Merged
merged 8 commits into from
Dec 11, 2024
Merged
Changes from 3 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

import com.lmax.disruptor.EventFactory;
import com.lmax.disruptor.EventTranslatorVararg;
import com.lmax.disruptor.RingBuffer;
import com.lmax.disruptor.WaitStrategy;
import com.lmax.disruptor.WorkHandler;
import com.lmax.disruptor.dsl.Disruptor;
Expand All @@ -28,6 +27,7 @@
import org.apache.logging.log4j.Logger;

import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;

/**
* Utility class for creating and managing a Disruptor instance.
Expand Down Expand Up @@ -73,20 +73,42 @@ public void start() {
*/
public boolean publishEvent(Object... args) {
try {
RingBuffer<T> ringBuffer = disruptor.getRingBuffer();
// Check if the RingBuffer has enough capacity to reserve 10 slots for tasks
// If there is insufficient capacity (less than 10 slots available)
// log a warning and drop the current task
if (!ringBuffer.hasAvailableCapacity(10)) {
LOG.warn("ring buffer has no available capacity,task will be dropped,"
+ "please check the task queue size.");
return false;
// Set the timeout to 1 second, converted to nanoseconds for precision
long timeoutInNanos = TimeUnit.SECONDS.toNanos(1); // Timeout set to 1 second
long startTime = System.nanoTime(); // Record the start time

// Loop until the timeout is reached
while (System.nanoTime() - startTime < timeoutInNanos) {
// Check if there is enough remaining capacity in the ring buffer
// Adjusting to check if the required capacity is available (instead of hardcoding 1)
if (disruptor.getRingBuffer().remainingCapacity() > 1) {
// Publish the event if there is enough capacity
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will there be concurrency? When making a judgment, it is greater than 1, and when publishing, there is no capacity left

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently, only the time wheel is in use, and since the time wheel itself is single-threaded, there are no issues.

disruptor.getRingBuffer().publishEvent(eventTranslator, args);
if (LOG.isDebugEnabled()) {
LOG.debug("publishEvent success,the remaining buffer size is {}",
disruptor.getRingBuffer().remainingCapacity());
Copy link
Contributor

@zddr zddr Dec 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of 'remainingCapacity'?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simply to add debug logs.

}
return true;
}

// Wait for a short period before retrying
try {
Thread.sleep(10); // Adjust the wait time as needed (maybe increase if not high-frequency)
} catch (InterruptedException e) {
// Log the exception and return false if interrupted
Thread.currentThread().interrupt(); // Restore interrupt status
LOG.warn("Thread interrupted while waiting to publish event", e);
return false;
}
}
ringBuffer.publishEvent(eventTranslator, args);
return true;

// Timeout reached without publishing the event
LOG.warn("Failed to publish event within the specified timeout (1 second)."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In log, it should be current size of the buffer, not remaining size of the buffer?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes...done

+ "Queue may be full. the remaining buffer size is {}",
CalvinKirs marked this conversation as resolved.
Show resolved Hide resolved
disruptor.getRingBuffer().remainingCapacity());
} catch (Exception e) {
LOG.warn("Failed to publish event", e);
// Handle the exception, e.g., retry or alert
// Catching general exceptions to handle unexpected errors
LOG.warn("Failed to publish event due to an unexpected error", e);
}
return false;
}
Expand Down
Loading