[원문출처] http://camel.apache.org/error-handler.html
해당 문서의 경우 Apache 재단의 Camel Document 문서 일부를 번역 한 것입니다.
번역본인 해당 문서의 경우 역자에게 있음을 알리며 상업적 이용을 불허합니다.
www.sogomsoft.co.kr (주) 소곰소프트
에러 핸들러(Error Handler)
Camel은 이벤트 기반 Consumer가 에러 처리하는 것을 다루기 위해 플러그인 가능한 ErrorHandler 전략들을 제공한다. 예외 절(Exception Clause)를 사용하여 DSL에서 직접 에러 핸들링을 지정하는 것은 선택적이다.
소개와 배경 지식를 위해 Error handling in Camel 을 보라.
예외 절(Exception Clause)
Error Handler 가 Exception Clause을 결합하여 사용하는 것은 매우 파워풀한 결합이다. 최종사용자(end-users)들이 에러를 핸들링하는 전략에서 이것을 조합하는 것을 권장한다. 샘플과 Exception Clause를 보라.
try ... catch ... finally 사용하기
라우터에서 직접 사용할 수 있는 DSL 처럼 에러 핸들링과 관련된 것이 Try Catch Finally 이다. 기본적으로 자바에서 try catch finally 를 모방이지만 더 파워풀하다.
현재 Camle 구현체들이 다음 특별한 기능을 제공한다. :
비 트랜잭션 (Non transacted : 트랜잭션을 지원하지 않는)
- DefaultErrorHandler 는 Camel 에서 기본 에러 핸들러이다. 이 에러 핸들러는 데드 레터 큐(dead letter queue)를 지원하지 않고 호출한 곳에 exception을 전달하게 될 것이다. 만약 전혀 에러 핸들러가 없다면 Features의 설정에 제한을 가진다.
- Dead Letter Channel 는 데드 레터 엔드포인트에 보내기 전에 메시지 교환의 횟수를 재 전송하기 위해 시도하는 것을 지원한다.
- LoggingErrorHandler는 단지 Exception을 잡아내고 로깅하기 위한 것이다.
- NoErrorHandler 는 어떠한 에러 핸들링도 없는 것이다.
트랜잭션 (Transacted : 트랜잭션을 지원하는)
- TransactionErrorHandler는 트랜잭션을 지원하는 라우터를 위한 Camel에서 기본 에러 헨들러이다. Transactional Client EIP 패턴을 보라.
에러 핸들러들은 다음 예에서 보여주는 것처럼 DSL에서 룰 전체 또는 특정 라우팅 룰에 지원 될 수 있다. 에러 핸들러 룰들은 단일 RouteBuilder 안에서 각각 라우팅하는 룰 위에 상속 된다.
제공되는 에러 핸들러의 간단한 요약
DefaultErrorHandler
DefaultErrorHandler 는 Camel 에서 기본에러 핸들러이다. Dead Letter Channel 와 다르게 어떠한 데드 레터 큐(dead letter queue)를 가지고 있지 않다. 그리고 기본적으로 Exception들을 핸들링 하지 않는다.
Dead Letter Channel
Dead Letter Channel은 1초 딜레이를 사용하여 최대 6번의 재 전송을 할 것이다. 만약 exchange가 실패 하면 ERROR 레벨에 로깅 될 것이다.
사용하기 위해 기본 데드 레터 엔드포인트를 환경 설정 할 수 있다. :
RouteBuilder builder = new RouteBuilder() { public void configure() { // using dead letter channel with a seda queue for errors errorHandler(deadLetterChannel("seda:errors")); // here is our route from("seda:a").to("seda:b"); } };
|
또는 in Spring DSL 에서
< bean id="deadLetterErrorHandler" class="org.apache.camel.builder.DeadLetterChannelBuilder"> < property name="deadLetterUri" value="log:dead"/> </ bean > < camelContext errorHandlerRef="deadLetterErrorHandler" xmlns="http://camel.apache.org/schema/spring"> ... </ camelContext >
|
또는 Camel 2.3.0 이후 부터 또한
< camel:errorHandler id="deadLetterErrorHandler" type="DeadLetterChannel" deadLetterUri="log:dead"> < camel:camelContext errorHandlerRef="deadLetterErrorHandler"> ... </ camel:camelContext >
|
Logging Error Handler
로깅 에러 핸들러는 캐치되지 않은 Exception이 던져 질 때 마다 기본적으로 ERROR 레벨에 로깅 될 것이다. 로깅 카테고리, 로거, 레벨은 빌더에서 모두 정의 될 수 있다.
errorHandler(loggingErrorHandler("mylogger.name").level(LoggingLevel.INFO));
|
또는 Spring DSL 에서
< bean id="loggingErrorHandler" class="org.apache.camel.builder.LoggingErrorHandler"> < property name="logName" value="mylogger.name"/> < property name="level" value="DEBUG"/> </ bean > ... </ camelContext >
|
또는 Camel 2.3.0 이후 부터 또한
< camel:errorHandler id="loggingErrorHandler" type="LoggingErrorHandler" logName="mylogger.name" level="DEBUG"/> < camel:camelContext errorHandlerRef="loggingErrorHandler"> ... </ camel:camelContext >
|
이것은 카테고리는 mylogger.name 을 사용하여 에러 핸들러를 생성하게 되고 그리고 모든 로그 메시지를 생성하기 위해 INFO 레벨을 사용한다.
from("seda:a").errorHandler(loggingErrorHandler("mylogger.name").level(LoggingLevel.DEBUG)).to("seda:b");
|
또 로거는 특정 라우터를 위해서 정의 될 수 있다. may also be defined for specific routes.
No Error Handler
no error handler는 에러 핸들링을 비활성화 하기 위해 사용된다.
errorHandler(noErrorHandler());
|
또는 Spring DSL에서
< bean id="noErrorHandler" class="org.apache.camel.builder.NoErrorHandlerBuilder"/> ... </ camelContext >
|
또는 Camel 2.3.0 이후 부터 또한
< camel:errorHandler id="noErrorHandler" type="NoErrorHandler"/> < camel:camelContext errorHandlerRef="noErrorHandler"> ... </ camel:camelContext >
|
TransactionErrorHandler
TransactionErrorHandler는 Camel에서 트랜잭션이 적용된 라우터를 위한 기본 에러 헨들러이다.
만약 트랜잭션을 지원하는 DSL을 사용하여 트랜잭션으로 라우터를 만들면 Camel은 자동적으로 TransactionErrorHandler를 사용하게 될 것이다. 글로벌 또는 라우터당 환경 구성된 에러 핸들러를 찾으려고 시도하게 될 것이고 만약 TransactionErrorHandlerBuilder
인스턴스이면 그걸 사용하게 될 것이다. 만약 Camel에서 찾지 못하면 기본 에러 핸들러를 우선하는 임시 TransactionErrorHandler가 자동으로 생성되게 될 것이다. 환경 구성을 통한 규칙이다.
다양한 Error Handlers의 기능들을 지원한다.
Error Handler(들)에 의해 지원되는 기능이 여기 있다. :
위 기능들의 일부의 문서는 Exception 절(Exception Clause) 문서를 보라.
Scopes
에러 핸들러의 스코프는 다음 중 하나 이다.
- global
- route 당
다음 예는 어떻게 글로벌 에러 핸들러를 등록하는지를 보여준다. (이 경우에서는 logging handler를 사용한다.)
RouteBuilder builder = new RouteBuilder() { public void configure() { // logging error handler를 사용 errorHandler(loggingErrorHandler("com.mycompany.foo")); // 여기서 표준 라우터이다. from("seda:a").to("seda:b"); } };
|
다음 예는 어떻게 라우터에 특정 에러 핸들러를 등록할 수 있는지를 보여 준다. 커스터마이징 된 로그 핸들러는 단지 Endpoint seda:a로 부터 라우터를 위해서 등록된다.
RouteBuilder builder = new RouteBuilder() { public void configure() { // 이 라우터는 중첩된 로깅 에러 핸들러를 사용하고 있다. from("seda:a") // 여기에 logging error handler를 환경 구성한다.. .errorHandler(loggingErrorHandler("com.mycompany.foo")) // 그리고 여기로 라우팅을 계속 한다. .to("seda:b"); // 이 라우터는 기본 에러 핸들러 (DeadLetterChannel)을 사용하게 될 것이다. from("seda:b").to("seda:c"); } };
|
Spring 기반의 환경 구성
Java DSL 대 Spring DSL
에러 핸들러는 Java DSL과 Spring DSL 에서 크게 다르게 환경 설정 된다. Jaba DSL은 능숙한 빌더를 사용하는 반면에 Spring DSL은 표준 Spring Bean 환경에 더 의존한다.
에러 핸들러는 스프링 빈과 다음 스코프 에서 처럼 환경 구성 될 수 있다. :
- global (camelContext 테그)
- route 당 (route 테그)
- policy 당 (policy/transacted 테그)
에러 핸들러는 errorHandlerRef
속성으로 환경 구성 될 수 있다.
에러 핸들러 계층(Error Handler Hierarchy)
에러 핸들러는 상속 된다. 그래서 만약 당신이 글로벌 에러 핸들러를 설정하면 어디서든지 사용 가능하다. 그러나 라우터에서 또는 다른 에러 핸들러를 사용하여 오버라이딩 할 수 있다.
Spring 기반 환경 구성 예제
이 예에서 라우터에서 최종 3번과 재시도 전에 약간의 딜레이로 재전송하는 라우터에서 Dead Letter Channel 을 환경 구성한다.
먼저 route
테그에서 errorHandlerRef
속성을 사용하여 myDeadLetterErrorHandler 에 참조를 환경 설정한다..
< template id="myTemplate"/> <!-- DeadLetterChannel에 errorHandlerRef 를 설정, 단지 이 라우터를 위해서만 적용된다. --> < route errorHandlerRef="myDeadLetterErrorHandler"> < from uri="direct:in"/> < process ref="myFailureProcessor"/> < to uri="mock:result"/> </ route > </ camelContext >
|
그리고 Dead Letter Channel인 스프링 bean 엘리먼트를 사용하여 표준 스프링으로 myDeadLetterErrorHandler를 환경 구성한다.
그리고 마지막으로 얼마나 많이 재전송할 것인지 지연시킬 것인지 등을 위한 옵션을 환경 구성할 재전송 정책을 위한 다른 Spring 빈을 가진다.
< !-- 여기 DeadLetterChannel을 환경 구성한다. --> < bean id="myDeadLetterErrorHandler" class="org.apache.camel.builder.DeadLetterChannelBuilder"> <!-- 재 전송 실패 시 exchange가 mock:dead 에 라우팅 된다. --> < property name="deadLetterUri" value="mock:dead"/> <!-- 사용할 재전송 정책을 참조한다. --> < property name="redeliveryPolicy" ref="myRedeliveryPolicyConfig"/> </ bean > <!-- 여기 재 전송 설정을 설정한다. --> < bean id="myRedeliveryPolicyConfig" class="org.apache.camel.processor.RedeliveryPolicy"> <!-- 최대 3번 재전송 시도하고 전송 실패 시 mock:dead endpoint에 라우팅 된다. --> < property name="maximumRedeliveries" value="3"/> <!-- 재전송 전에 delay 250ms초 지연 --> < property name="redeliveryDelay" value="250"/> </ bean >
|
Camel 2.3.0 부터, Camel은 에러 핸들러를 위하여 customer 빈 환경 구성을 제공한다. 여기 예제가 있다.
< errorHandler id="loggingErrorHandler" type="LoggingErrorHandler" logName="foo" level="INFO" <!-- 만약 유형 속성이 지정되지 않으면 유형 값은 DefaultErrorHandler가 설정되게 될 것이다. --> <!-- 에러 핸들러 안쪽에 재전송 정책( redeliveryPolicy )을 정의 할 수 있다. -->< camel:errorHandler id="defaultErrorHandler" type="DefaultErrorHandler"> < camel:redeliveryPolicy maximumRedeliveries="2" redeliveryDelay="0" logStackTrace="false"/> </ camel:errorHandler > < camel:errorHandler id="deadLetterErrorHandler" type="DeadLetterChannel" deadLetterUri="log:dead"> < camel:redeliveryPolicy maximumRedeliveries="2" redeliveryDelay="1000" logHandled="true" asyncDelayedRedelivery="true"/> </ camel:errorHandler > < bean id="myErrorProcessor" class="org.apache.camel.spring.handler.MyErrorProcessor"/> <!-- TX 에러 핸들러는 템플릿을 사용하여 환경 구성 될 수 있다. --> < camel:errorHandler id="transactionErrorHandler" type="TransactionErrorHandler" transactionTemplateRef="PROPAGATION_REQUIRED" onRedeliveryRef="myErrorProcessor"/> <!-- 또는 트랜잭션 관리 를 사용한다. --> < camel:errorHandler id="txEH" type="TransactionErrorHandler" transactionManagerRef="txManager"/> <!-- camelContext 안쪽에 에러 핸들러를 정의 할 수 있다. --> < errorHandler id="noErrorHandler" type="NoErrorHandler"/> </ camelContext >
|
트랜잭션을 지원하는(transactional) 에러 핸들러 사용
트랜잭션 에러 핸들러는 스프링 트랜잭션을 기반으로 되어 있고 camel-spring component의 사용을 필요로 한다..
사용하는 방법과 에러 핸들러로 환경 구성하는 트랜잭션 행위와 환경 구성을 위한 많은 예가 있는 Transactional Client를 보라.
See also
- Error handling in Camel (Camel에서 에러 핸들링에 소개 또는 배경 지식 자료를 위한)
- Dead Letter Channel (데드 레터 에러 핸들링을 위한)
- DefaultErrorHandler (Camel에서 기본 에러 핸들러를 위한)
- TransactionErrorHandler (트랜잭션이 적용되는 라우터의 기본 에러 핸들러를 위한 )
- Transactional Client (트랜적션 행위를 위한)
- Exception Clause (던져진 exception을 핸들링 하는 것을 지원을 위한)
- Try Catch Finally (라우팅에 사용될 DSL로 try ... catch ... finally 를 위한)