forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-20309][network] Add NetworkActionsLogger for easier debugging
- Loading branch information
Showing
5 changed files
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
68 changes: 68 additions & 0 deletions
68
...untime/src/main/java/org/apache/flink/runtime/io/network/logger/NetworkActionsLogger.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http:https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.flink.runtime.io.network.logger; | ||
|
|
||
| import org.apache.flink.runtime.io.network.buffer.Buffer; | ||
| import org.apache.flink.runtime.io.network.buffer.BufferConsumer; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.util.Arrays; | ||
|
|
||
| import static org.apache.flink.util.Preconditions.checkState; | ||
|
|
||
| /** Utility class for logging actions that happened in the network stack for debugging purposes. */ | ||
| public class NetworkActionsLogger { | ||
| private static final Logger LOG = LoggerFactory.getLogger(NetworkActionsLogger.class); | ||
|
|
||
| private static final boolean ENABLED = LOG.isTraceEnabled(); | ||
| private static final boolean INCLUDE_HASH = true; | ||
|
|
||
| public static void log(Class<?> clazz, String action, Buffer buffer) { | ||
| if (ENABLED) { | ||
| LOG.trace("{}#{} buffer = [{}]", clazz.getSimpleName(), action, toPrettyString(buffer)); | ||
| } | ||
| } | ||
|
|
||
| public static void log(Class<?> clazz, String action, BufferConsumer bufferConsumer) { | ||
| if (ENABLED) { | ||
| Buffer buffer = null; | ||
| try (BufferConsumer copiedBufferConsumer = bufferConsumer.copy()) { | ||
| buffer = copiedBufferConsumer.build(); | ||
| log(clazz, action, buffer); | ||
| checkState(copiedBufferConsumer.isFinished()); | ||
| } finally { | ||
| if (buffer != null) { | ||
| buffer.recycleBuffer(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static String toPrettyString(Buffer buffer) { | ||
| StringBuilder prettyString = new StringBuilder("size=").append(buffer.getSize()); | ||
| if (INCLUDE_HASH) { | ||
| byte[] bytes = new byte[buffer.getSize()]; | ||
| buffer.readOnlySlice().asByteBuf().readBytes(bytes); | ||
| prettyString.append(", hash=").append(Arrays.hashCode(bytes)); | ||
| } | ||
| return prettyString.toString(); | ||
| } | ||
| } |
This file contains 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
This file contains 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