Skip to content
This repository was archived by the owner on May 8, 2026. It is now read-only.

Commit 2b57baa

Browse files
SamuelSchaubSamuelSchaub
committed
fix: typo, renaming, and using throwable on failure for logging util
1 parent a5159f5 commit 2b57baa

4 files changed

Lines changed: 24 additions & 36 deletions

File tree

‎google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/LoggingUtil.java‎

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public final class LoggingUtil {
3434
private static final Logger publishBatchLogger = Logger.getLogger("publish-batch");
3535
private static final Logger subscriberStreamsLogger = Logger.getLogger("subscriber-streams");
3636

37-
public enum SubSytem {
37+
public enum SubSystem {
3838
SLOW_ACK(slowAckLogger),
3939
CALLBACK_DELIVERY(callbackDeliveryLogger),
4040
EXPIRY(expiryLogger),
@@ -47,7 +47,7 @@ public enum SubSytem {
4747

4848
private final Logger logger;
4949

50-
SubSytem(Logger logger) {
50+
SubSystem(Logger logger) {
5151
this.logger = logger;
5252
}
5353

@@ -100,7 +100,7 @@ private String getPublisherLogPrefix(PubsubMessageWrapper messageWrapper) {
100100
}
101101

102102
public void logSubscriber(
103-
SubSytem subSystem,
103+
SubSystem subSystem,
104104
Level level,
105105
String msg,
106106
PubsubMessageWrapper messageWrapper,
@@ -113,8 +113,8 @@ public void logSubscriber(
113113
}
114114
}
115115

116-
public void logSubscriber(
117-
SubSytem subSystem,
116+
public void logSubscriberWithThrowable(
117+
SubSystem subSystem,
118118
Level level,
119119
String msg,
120120
PubsubMessageWrapper messageWrapper,
@@ -129,29 +129,16 @@ public void logSubscriber(
129129
}
130130

131131
public void logPublisher(
132-
SubSytem subSystem, Level level, String msg, PubsubMessageWrapper messageWrapper) {
132+
SubSystem subSystem, Level level, String msg, PubsubMessageWrapper messageWrapper) {
133133
Logger logger = subSystem.getLogger();
134134
if (logger.isLoggable(level)) {
135135
String prefix = getPublisherLogPrefix(messageWrapper);
136136
logger.log(level, prefix + " - " + msg);
137137
}
138138
}
139139

140-
public void logPublisher(
141-
SubSytem subSystem,
142-
Level level,
143-
String msg,
144-
PubsubMessageWrapper messageWrapper,
145-
Throwable throwable) {
140+
public void logEvent(SubSystem subSystem, Level level, String msg, Object... params) {
146141
Logger logger = subSystem.getLogger();
147-
if (logger.isLoggable(level)) {
148-
String prefix = getPublisherLogPrefix(messageWrapper);
149-
logger.log(level, prefix + " - " + msg, throwable);
150-
}
151-
}
152-
153-
public void logEvent(SubSytem subSytem, Level level, String msg, Object... params) {
154-
Logger logger = subSytem.getLogger();
155142
if (logger.isLoggable(level)) {
156143
logger.log(level, msg, params);
157144
}

‎google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/MessageDispatcher.java‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -160,13 +160,14 @@ private void forget() {
160160

161161
@Override
162162
public void onFailure(Throwable t) {
163-
loggingUtil.logSubscriber(
164-
LoggingUtil.SubSytem.CALLBACK_EXCEPTIONS,
163+
loggingUtil.logSubscriberWithThrowable(
164+
LoggingUtil.SubSystem.CALLBACK_EXCEPTIONS,
165165
Level.WARNING,
166166
"MessageReceiver exception.",
167167
this.ackRequestData.getMessageWrapper(),
168168
this.ackRequestData.getAckId(),
169-
exactlyOnceDeliveryEnabled.get());
169+
exactlyOnceDeliveryEnabled.get(),
170+
t);
170171
this.ackRequestData.setResponse(AckResponse.OTHER, false);
171172
pendingNacks.add(this.ackRequestData);
172173
tracer.endSubscribeProcessSpan(this.ackRequestData.getMessageWrapper(), "nack");
@@ -179,7 +180,7 @@ public void onSuccess(AckReply reply) {
179180
Ints.saturatedCast((long) Math.ceil((clock.millisTime() - receivedTimeMillis) / 1000D));
180181
if (ackLatency >= ackLatencyDistribution.getPercentile(slowAckPercentile)) {
181182
loggingUtil.logSubscriber(
182-
LoggingUtil.SubSytem.SLOW_ACK,
183+
LoggingUtil.SubSystem.SLOW_ACK,
183184
Level.FINE,
184185
String.format(
185186
"Message ack duration of %d is higher than the p99 ack duration", ackLatency),
@@ -201,7 +202,7 @@ public void onSuccess(AckReply reply) {
201202
tracer.endSubscribeProcessSpan(this.ackRequestData.getMessageWrapper(), "ack");
202203
}
203204
loggingUtil.logSubscriber(
204-
LoggingUtil.SubSytem.ACK_NACK,
205+
LoggingUtil.SubSystem.ACK_NACK,
205206
Level.FINE,
206207
"Ack called on message.",
207208
this.ackRequestData.getMessageWrapper(),
@@ -212,7 +213,7 @@ public void onSuccess(AckReply reply) {
212213
pendingNacks.add(this.ackRequestData);
213214
tracer.endSubscribeProcessSpan(this.ackRequestData.getMessageWrapper(), "nack");
214215
loggingUtil.logSubscriber(
215-
LoggingUtil.SubSytem.ACK_NACK,
216+
LoggingUtil.SubSystem.ACK_NACK,
216217
Level.FINE,
217218
"Nack called on message.",
218219
this.ackRequestData.getMessageWrapper(),
@@ -598,15 +599,15 @@ private void processBatch(List<OutstandingMessage> batch) {
598599
tracer.startSubscribeConcurrencyControlSpan(message.messageWrapper());
599600
try {
600601
loggingUtil.logSubscriber(
601-
LoggingUtil.SubSytem.SUBSCRIBER_FLOW_CONTROL,
602+
LoggingUtil.SubSystem.SUBSCRIBER_FLOW_CONTROL,
602603
Level.FINE,
603604
"Flow controller is blocking.",
604605
message.messageWrapper(),
605606
message.messageWrapper().getAckId(),
606607
exactlyOnceDeliveryEnabled.get());
607608
flowController.reserve(1, message.messageWrapper().getPubsubMessage().getSerializedSize());
608609
loggingUtil.logSubscriber(
609-
LoggingUtil.SubSytem.SUBSCRIBER_FLOW_CONTROL,
610+
LoggingUtil.SubSystem.SUBSCRIBER_FLOW_CONTROL,
610611
Level.FINE,
611612
"Flow controller is done blocking.",
612613
message.messageWrapper(),
@@ -615,8 +616,8 @@ private void processBatch(List<OutstandingMessage> batch) {
615616
tracer.endSubscribeConcurrencyControlSpan(message.messageWrapper());
616617
} catch (FlowControlException unexpectedException) {
617618
// This should be a blocking flow controller and never throw an exception.
618-
loggingUtil.logSubscriber(
619-
LoggingUtil.SubSytem.SUBSCRIBER_FLOW_CONTROL,
619+
loggingUtil.logSubscriberWithThrowable(
620+
LoggingUtil.SubSystem.SUBSCRIBER_FLOW_CONTROL,
620621
Level.FINE,
621622
"Flow controller unexpected exception.",
622623
message.messageWrapper(),
@@ -671,7 +672,7 @@ public void run() {
671672
ackHandler.forget();
672673
tracer.setSubscriberSpanExpirationResult(messageWrapper);
673674
loggingUtil.logSubscriber(
674-
LoggingUtil.SubSytem.EXPIRY,
675+
LoggingUtil.SubSystem.EXPIRY,
675676
Level.FINE,
676677
"Message expired.",
677678
messageWrapper,
@@ -681,7 +682,7 @@ public void run() {
681682
}
682683
tracer.startSubscribeProcessSpan(messageWrapper);
683684
loggingUtil.logSubscriber(
684-
LoggingUtil.SubSytem.CALLBACK_DELIVERY,
685+
LoggingUtil.SubSystem.CALLBACK_DELIVERY,
685686
Level.FINE,
686687
"Message delivered.",
687688
messageWrapper,
@@ -805,7 +806,7 @@ void processOutstandingOperations() {
805806
List<AckRequestData> ackRequestDataList = new ArrayList<AckRequestData>();
806807
pendingAcks.drainTo(ackRequestDataList);
807808
loggingUtil.logEvent(
808-
LoggingUtil.SubSytem.ACK_BATCH,
809+
LoggingUtil.SubSystem.ACK_BATCH,
809810
Level.FINE,
810811
"Sending {0} ACKs, {1} NACKs, {2} receipts. Exactly Once Delivery: {3}",
811812
new Object[] {

‎google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/Publisher.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ private void publishOutstandingBatch(final OutstandingBatch outstandingBatch) {
512512
}
513513

514514
loggingUtil.logPublisher(
515-
LoggingUtil.SubSytem.PUBLISH_BATCH,
515+
LoggingUtil.SubSystem.PUBLISH_BATCH,
516516
Level.FINE,
517517
String.format("Attempting to batch publish %d messages", outstandingBatch.size()),
518518
outstandingBatch.getMessageWrappers().get(0));

‎google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/StreamingSubscriberConnection.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ public boolean getExactlyOnceDeliveryEnabled() {
224224
protected void doStart() {
225225
logger.config("Starting subscriber.");
226226
loggingUtil.logEvent(
227-
LoggingUtil.SubSytem.SUBSCRIBER_STREAMS, Level.FINE, "Opening stream.", "");
227+
LoggingUtil.SubSystem.SUBSCRIBER_STREAMS, Level.FINE, "Opening stream.", "");
228228
messageDispatcher.start();
229229
initialize();
230230
notifyStarted();
@@ -233,7 +233,7 @@ protected void doStart() {
233233
@Override
234234
protected void doStop() {
235235
loggingUtil.logEvent(
236-
LoggingUtil.SubSytem.SUBSCRIBER_STREAMS, Level.FINE, "Closing stream.", "");
236+
LoggingUtil.SubSystem.SUBSCRIBER_STREAMS, Level.FINE, "Closing stream.", "");
237237
lock.lock();
238238
try {
239239
clientStream.closeSendWithError(Status.CANCELLED.asException());

0 commit comments

Comments
 (0)