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-16303][rest] Enable retrieval of custom JobManager log files
This closes apache#11542.
- Loading branch information
Showing
35 changed files
with
910 additions
and
226 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
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
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
83 changes: 83 additions & 0 deletions
83
...ain/java/org/apache/flink/runtime/rest/handler/cluster/AbstractJobManagerFileHandler.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,83 @@ | ||
| /* | ||
| * 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.rest.handler.cluster; | ||
|
|
||
| import org.apache.flink.api.common.time.Time; | ||
| import org.apache.flink.runtime.rest.handler.AbstractHandler; | ||
| import org.apache.flink.runtime.rest.handler.HandlerRequest; | ||
| import org.apache.flink.runtime.rest.handler.util.HandlerUtils; | ||
| import org.apache.flink.runtime.rest.messages.EmptyRequestBody; | ||
| import org.apache.flink.runtime.rest.messages.ErrorResponseBody; | ||
| import org.apache.flink.runtime.rest.messages.MessageParameters; | ||
| import org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders; | ||
| import org.apache.flink.runtime.webmonitor.RestfulGateway; | ||
| import org.apache.flink.runtime.webmonitor.retriever.GatewayRetriever; | ||
| import org.apache.flink.util.FlinkException; | ||
|
|
||
| import org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext; | ||
| import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest; | ||
| import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| import java.io.File; | ||
| import java.util.Collections; | ||
| import java.util.Map; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.CompletionException; | ||
|
|
||
| /** | ||
| * Base class for serving files from the JobManager. | ||
| */ | ||
| public abstract class AbstractJobManagerFileHandler<M extends MessageParameters> extends AbstractHandler<RestfulGateway, EmptyRequestBody, M> { | ||
|
|
||
| protected AbstractJobManagerFileHandler( | ||
| GatewayRetriever<? extends RestfulGateway> leaderRetriever, | ||
| Time timeout, | ||
| Map<String, String> responseHeaders, | ||
| UntypedResponseMessageHeaders<EmptyRequestBody, M> messageHeaders) { | ||
| super(leaderRetriever, timeout, responseHeaders, messageHeaders); | ||
| } | ||
|
|
||
| @Override | ||
| protected CompletableFuture<Void> respondToRequest(ChannelHandlerContext ctx, HttpRequest httpRequest, HandlerRequest<EmptyRequestBody, M> handlerRequest, RestfulGateway gateway) { | ||
| File file = getFile(handlerRequest); | ||
| if (file != null && file.exists()) { | ||
| try { | ||
| HandlerUtils.transferFile( | ||
| ctx, | ||
| file, | ||
| httpRequest); | ||
| } catch (FlinkException e) { | ||
| throw new CompletionException(new FlinkException("Could not transfer file to client.", e)); | ||
| } | ||
| return CompletableFuture.completedFuture(null); | ||
| } else { | ||
| return HandlerUtils.sendErrorResponse( | ||
| ctx, | ||
| httpRequest, | ||
| new ErrorResponseBody("This file does not exist in JobManager log dir."), | ||
| HttpResponseStatus.NOT_FOUND, | ||
| Collections.emptyMap()); | ||
| } | ||
| } | ||
|
|
||
| @Nullable | ||
| protected abstract File getFile(HandlerRequest<EmptyRequestBody, M> handlerRequest); | ||
| } |
60 changes: 60 additions & 0 deletions
60
...c/main/java/org/apache/flink/runtime/rest/handler/cluster/JobManagerCustomLogHandler.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,60 @@ | ||
| /* | ||
| * 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.rest.handler.cluster; | ||
|
|
||
| import org.apache.flink.api.common.time.Time; | ||
| import org.apache.flink.runtime.rest.handler.HandlerRequest; | ||
| import org.apache.flink.runtime.rest.messages.EmptyRequestBody; | ||
| import org.apache.flink.runtime.rest.messages.LogFileNamePathParameter; | ||
| import org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders; | ||
| import org.apache.flink.runtime.rest.messages.cluster.FileMessageParameters; | ||
| import org.apache.flink.runtime.webmonitor.RestfulGateway; | ||
| import org.apache.flink.runtime.webmonitor.retriever.GatewayRetriever; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| import java.io.File; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Rest handler which serves the custom log file from JobManager. | ||
| */ | ||
| public class JobManagerCustomLogHandler extends AbstractJobManagerFileHandler<FileMessageParameters> { | ||
|
|
||
| private File logDir; | ||
|
|
||
| public JobManagerCustomLogHandler( | ||
| GatewayRetriever<? extends RestfulGateway> leaderRetriever, | ||
| Time timeout, Map<String, String> responseHeaders, | ||
| UntypedResponseMessageHeaders<EmptyRequestBody, FileMessageParameters> messageHeaders, | ||
| @Nullable File logDir) { | ||
| super(leaderRetriever, timeout, responseHeaders, messageHeaders); | ||
|
|
||
| this.logDir = logDir; | ||
| } | ||
|
|
||
| @Override | ||
| protected File getFile(HandlerRequest<EmptyRequestBody, FileMessageParameters> handlerRequest) { | ||
| if (logDir == null) { | ||
| return null; | ||
| } | ||
| String filename = handlerRequest.getPathParameter(LogFileNamePathParameter.class); | ||
| return new File(logDir, filename); | ||
| } | ||
| } |
55 changes: 55 additions & 0 deletions
55
...src/main/java/org/apache/flink/runtime/rest/handler/cluster/JobManagerLogFileHandler.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,55 @@ | ||
| /* | ||
| * 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.rest.handler.cluster; | ||
|
|
||
| import org.apache.flink.api.common.time.Time; | ||
| import org.apache.flink.runtime.rest.handler.HandlerRequest; | ||
| import org.apache.flink.runtime.rest.messages.EmptyMessageParameters; | ||
| import org.apache.flink.runtime.rest.messages.EmptyRequestBody; | ||
| import org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders; | ||
| import org.apache.flink.runtime.webmonitor.RestfulGateway; | ||
| import org.apache.flink.runtime.webmonitor.retriever.GatewayRetriever; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| import java.io.File; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Rest handler which serves the log files from JobManager. | ||
| */ | ||
| public class JobManagerLogFileHandler extends AbstractJobManagerFileHandler<EmptyMessageParameters> { | ||
|
|
||
| private final File file; | ||
|
|
||
| public JobManagerLogFileHandler( | ||
| GatewayRetriever<? extends RestfulGateway> leaderRetriever, | ||
| Time timeout, Map<String, String> responseHeaders, | ||
| UntypedResponseMessageHeaders<EmptyRequestBody, EmptyMessageParameters> messageHeaders, | ||
| @Nullable File file) { | ||
| super(leaderRetriever, timeout, responseHeaders, messageHeaders); | ||
|
|
||
| this.file = file; | ||
| } | ||
|
|
||
| @Override | ||
| protected File getFile(HandlerRequest<EmptyRequestBody, EmptyMessageParameters> handlerRequest) { | ||
| return file; | ||
| } | ||
| } |
Oops, something went wrong.