-
Notifications
You must be signed in to change notification settings - Fork 342
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce error details provider to get more information about except…
…ons from plugins
- Loading branch information
1 parent
61105ff
commit 91d3ba5
Showing
14 changed files
with
379 additions
and
41 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
36 changes: 36 additions & 0 deletions
36
...ates/cdap-etl/cdap-etl-api/src/main/java/io/cdap/cdap/etl/api/exception/ErrorContext.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,36 @@ | ||
| /* | ||
| * Copyright © 2024 Cask Data, Inc. | ||
| * | ||
| * Licensed 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://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 io.cdap.cdap.etl.api.exception; | ||
|
|
||
| /** | ||
| * Context for error details provider. | ||
| * | ||
| * <p> | ||
| * This class provides the context for the error details provider. | ||
| * </p> | ||
| */ | ||
| public class ErrorContext { | ||
| private final ErrorPhase phase; | ||
|
|
||
| public ErrorContext(ErrorPhase phase) { | ||
| this.phase = phase; | ||
| } | ||
|
|
||
| public ErrorPhase getPhase() { | ||
| return phase; | ||
| } | ||
| } |
43 changes: 43 additions & 0 deletions
43
...p-etl/cdap-etl-api/src/main/java/io/cdap/cdap/etl/api/exception/ErrorDetailsProvider.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,43 @@ | ||
| /* | ||
| * Copyright © 2024 Cask Data, Inc. | ||
| * | ||
| * Licensed 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://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 io.cdap.cdap.etl.api.exception; | ||
|
|
||
| import io.cdap.cdap.api.exception.ProgramFailureException; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * Interface for providing error details. | ||
| * | ||
| * <p> | ||
| * Implementations of this interface can be used to provide more detailed error information | ||
| * for exceptions that occur within the code using {@link ProgramFailureException}. | ||
| * </p> | ||
| */ | ||
| public interface ErrorDetailsProvider { | ||
|
|
||
| /** | ||
| * Returns a {@link ProgramFailureException} that wraps the given exception | ||
| * with more detailed information. | ||
| * | ||
| * @param e the exception to wrap. | ||
| * @param context the context of the error. | ||
| * @return {@link ProgramFailureException} that wraps the given exception | ||
| * with more detailed information. | ||
| */ | ||
| @Nullable | ||
| ProgramFailureException getExceptionDetails(Exception e, ErrorContext context); | ||
| } |
29 changes: 29 additions & 0 deletions
29
...l/cdap-etl-api/src/main/java/io/cdap/cdap/etl/api/exception/ErrorDetailsProviderSpec.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,29 @@ | ||
| /* | ||
| * Copyright © 2024 Cask Data, Inc. | ||
| * | ||
| * Licensed 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://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 io.cdap.cdap.etl.api.exception; | ||
|
|
||
| public class ErrorDetailsProviderSpec { | ||
| private final String className; | ||
|
|
||
| public ErrorDetailsProviderSpec(String className) { | ||
| this.className = className; | ||
| } | ||
|
|
||
| public String getClassName() { | ||
| return className; | ||
| } | ||
| } |
42 changes: 42 additions & 0 deletions
42
...plates/cdap-etl/cdap-etl-api/src/main/java/io/cdap/cdap/etl/api/exception/ErrorPhase.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,42 @@ | ||
| /* | ||
| * Copyright © 2024 Cask Data, Inc. | ||
| * | ||
| * Licensed 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://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 io.cdap.cdap.etl.api.exception; | ||
|
|
||
| /** | ||
| * Enum representing the different phases of a stage where error can occur. | ||
| */ | ||
| public enum ErrorPhase { | ||
| SPLITTING("Splitting"), | ||
| READING("Reading"), | ||
| VALIDATING_OUTPUT_SPECS("Validating Output Specs"), | ||
| WRITING("Writing"), | ||
| COMMITTING("Committing"); | ||
|
|
||
| private final String displayName; | ||
|
|
||
| ErrorPhase(String displayName) { | ||
| this.displayName = displayName; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a string representation of the error phase enum. | ||
| */ | ||
| @Override | ||
| public String toString() { | ||
| return displayName; | ||
| } | ||
| } |
32 changes: 32 additions & 0 deletions
32
...l/cdap-etl-api/src/main/java/io/cdap/cdap/etl/api/exception/NoopErrorDetailsProvider.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,32 @@ | ||
| /* | ||
| * Copyright © 2024 Cask Data, Inc. | ||
| * | ||
| * Licensed 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://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 io.cdap.cdap.etl.api.exception; | ||
|
|
||
| import io.cdap.cdap.api.exception.ProgramFailureException; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * Noop implementation of {@link ErrorDetailsProvider}. | ||
| */ | ||
| public class NoopErrorDetailsProvider implements ErrorDetailsProvider { | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public ProgramFailureException getExceptionDetails(Exception e, ErrorContext context) { | ||
| return null; | ||
| } | ||
| } |
79 changes: 79 additions & 0 deletions
79
...-templates/cdap-etl/cdap-etl-core/src/main/java/io/cdap/cdap/etl/common/ErrorDetails.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,79 @@ | ||
| /* | ||
| * Copyright © 2024 Cask Data, Inc. | ||
| * | ||
| * Licensed 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://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 io.cdap.cdap.etl.common; | ||
|
|
||
| import io.cdap.cdap.api.exception.ProgramFailureException; | ||
| import io.cdap.cdap.api.exception.WrappedStageException; | ||
| import io.cdap.cdap.etl.api.exception.ErrorContext; | ||
| import io.cdap.cdap.etl.api.exception.ErrorDetailsProvider; | ||
| import io.cdap.cdap.etl.api.exception.ErrorPhase; | ||
| import io.cdap.cdap.etl.api.exception.NoopErrorDetailsProvider; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * Utility class for handling exceptions. | ||
| */ | ||
| public class ErrorDetails { | ||
| private static final Logger LOG = LoggerFactory.getLogger(ErrorDetails.class); | ||
| public static final String ERROR_DETAILS_PROVIDER_CLASS_NAME_KEY = | ||
| "io.cdap.pipeline.error.details.provider.classname"; | ||
|
|
||
| /** | ||
| * Gets the {@link ErrorDetailsProvider} from the given {@link Configuration}. | ||
| * | ||
| * @param conf the configuration to get the error details provider from. | ||
| * @return the error details provider. | ||
| */ | ||
| public static ErrorDetailsProvider getErrorDetailsProvider(Configuration conf) { | ||
| String errorDetailsProviderClassName = | ||
| conf.get(ERROR_DETAILS_PROVIDER_CLASS_NAME_KEY); | ||
| if (errorDetailsProviderClassName == null) { | ||
| return new NoopErrorDetailsProvider(); | ||
| } | ||
| try { | ||
| return (ErrorDetailsProvider) conf.getClassLoader() | ||
| .loadClass(errorDetailsProviderClassName) | ||
| .newInstance(); | ||
| } catch (Exception e) { | ||
| LOG.warn(String.format("Unable to instantiate errorDetailsProvider class '%s'.", | ||
| errorDetailsProviderClassName), e); | ||
| return new NoopErrorDetailsProvider(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Handles the given exception, wrapping it in a {@link WrappedStageException}. | ||
| * | ||
| * @param e the exception to handle. | ||
| * @param stageName the name of the stage where the exception occurred. | ||
| * @param errorDetailsProvider the error details provider. | ||
| * @param phase the phase of the stage where the exception occurred. | ||
| * @return the wrapped stage exception. | ||
| */ | ||
| public static WrappedStageException handleException(Exception e, String stageName, | ||
| ErrorDetailsProvider errorDetailsProvider, ErrorPhase phase) { | ||
| ProgramFailureException exception = null; | ||
|
|
||
| if (!(e instanceof ProgramFailureException)) { | ||
| exception = errorDetailsProvider == null ? null : | ||
| errorDetailsProvider.getExceptionDetails(e, new ErrorContext(phase)); | ||
| } | ||
| return new WrappedStageException(exception == null ? e : exception, stageName); | ||
| } | ||
| } |
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
Oops, something went wrong.