다음의 내용은 에이콘출판사의 Mastering Spring 5 책을 읽고 실습해나가면서 몇몇 수정한 부분들에 대한 기록이다. 책이 출판될 당시의 Spring Boot 관련 버전과 내가 책을 구매한 시점에서 사용되는 Spring Boot 관련 버전이 다른 관계로 인해 실습 코드에서 변화되는 부분이 있어서 이에 대한 기록을 남겨두려 한다.
이 책에서 사용한 Spring Boot 버전은 2.0.0.M1 이고 2019년 5월 7일 현재 이 글을 쓰는 시점에서 내가 사용하고 있는 Spring Boot 버전은 2.1.4.RELEASE 이다(당근 Springframework 버전도 차이가 나게 되는데 책은 5.0.0.RC1을 사용하고 있으나 내가 사용하고 있는 Springframework의 버전은 5.1.6 이다)
순서는 책의 순서와는 맞지는 않으며 차후 수정이 계속 이루어질 것이며 수정과정에서 순서가 맞춰질수도 있다(현재 이 책의 9장을 공부하던 도중에 이 문서를 작성해두어야겠다 는 생각이 들어서..)
9장 전까지는 실습하는데 있어서 큰 문제가 없었는데 9장의 클라우드로 넘어가면서 책의 내용으로 실제 실습을 진행해보니 맞지 않는 부분이 발생하기 시작했다. Spring Cloud의 경우는 Spring Boot 2로 넘어가면서 라이브러리 관리의 변화가 발생한 부분이 있었다. 그러다보니 pom.xml 에서의 설정이나 사용방법이 바뀐 부분이 생기게 되었다.
● 스프링 클라우드 컨피그 서버와 클라이언트 dependency 설정
책의 399페이지에 스프링 클라우드 컨피그 서버의 maven dependency 설정과 404 페이지와 405 페이지에 걸쳐서 스프링 클라우드 컨피그 클라이언트의 maven dependency 설정이 있는데 스프링 클라우드 컨피그 서버의 경우 399 페이지에 있는 설정만으로는 관련 어노테이션이 있는 jar를 갖고 오지 못한다. 405 페이지에 있는 의존성 관리 내용을 추가해 줘야 jar를 갖고 올 수 있다. 그러나 405 페이지에 있는 Dalston 버전은 Spring Boot 1.5.X과 호환성이 이루어지기 때문에 Spring Boot 2.X 버전에는 맞지 않는 현상이 있다. 그래서 Spring Boot 2.X에서 사용할 때는 Greenwich 를 사용하면 된다. 다음과 같이 설정해주면 된다
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Greenwich.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>● management.security.enabled 에 대해서
책의 401 페이지에서 이 항목에 대해 설정하는 내용이 있는데 별도의 설명이 없어서 나름 알아보게 되었다. 이 항목은 Spring Actuator와 Spring Security 이 두가지와 연관이 되어 있는데 Spring Actuator와 Spring Security를 동시에 사용할 경우 Spring Actuator에서 제공하는 몇몇 URL(정확한 용어로는 Endpoint)은 로그인 아이디와 비밀번호를 입력해야만 해당 화면을 볼 수 있게 된다. 별다른 설정을 안하면 Spring Security가 만드는 default 계정(아이디가 USER 이고 패스워드는 Spring Boot App이 실행되는 시점에 만들어진다)으로 로그인 해야만 볼 수 있게 되는데 이러한 기능을 사용하지 않을 경우 management.security.enabled 속성을 false로 지정해주면 된다. 그러나 Spring Security를 사용하지 않으면 이 속성의 값이 true/false 여부와는 상관없이 이 기능이 동작하지 않는다(즉 Actiator에서 제공되는 모든 URL을 별도의 인증과정 없이 볼 수 있다)
그러나 문제는 Spring Boot 2.X에서는 이 설정이 없어졌다(실제 Spring Boot Document를 보면 목차중에 Customizing the management server port 항목에서 이 설정에 대한 설명이 있는데 1.X 버전에는 이 설정에 대한 설명이 있지만 2.X 버전에서는 Customizing the management server port 항목에서 이 설정에 대한 설명이 빠져 있다.)
이 부분은 Spring Security에서 /actuator/** 경로로 접근하는 것에는 특정 Role(ex : ACTUATOR)이 있는 사용자만 접근이 되도록 설정하고 application.properties 에서 management.endpoint.health.roles 항목에 방금 언급했던 특정 Role을 지정해주면 된다. 관련 자료는 여기와 여기를 클릭하면 알 수 있다(첫번째 링크에서 두번째 링크를 같이 걸어놓았다) 그러나 이러한 설정을 일절 해주지 않으면 로그인 관련 인증 기능은 동작하지 않는다.
그러나 로그인 여부와는 상관없이 해당 Endpoint에 대한 접근제어 설정도 가능하다. 무슨 뜻이냐면 내가 로그인을 하든 안하든 모든 사용자에게 모든 Endpoint에 대한 접근 허용/금지, 특정 Endpoint에 대한 접근 허용/금지 설정이 가능하다. Spring 2.X 버전에서는 JMX를 통한 Endpoint는 shutdown을 제외하고는 모두 접근이 허용되어 있으나 web을 통한 접근은 health와 info를 빼고는 접근이 금지되어 있다. 이러한 설정을 수정할려면 management.endpoints.web.exposure.include 항목과 management.endpoints.web.exposure.exclude 항목을 이용해서 설정하면 된다. 예를 들어 다음과 같이 설정하면
management.endpoints.web.exposure.include = httptrace,logfile
management.endpoints.web.exposure.exclude = healthhttptrace와 logfile은 각각 /actuator/httptrace 와 /actuator/logfile로 접근이 가능하며 health는 접근할 수 없게 된다.
전체를 의미하는 것으로 *을 사용할 수 있는데 만약 다음과 같이 사용하면
management.endpoints.web.exposure.include = *
management.endpoints.web.exposure.exclude = httptrace,logfilehttptrace와 logfile을 제외한 모든 Endpoint가 각각 /actuator/해당 Endpoint 이름 으로 web에서 접근이 가능해진다
(주의할 점이 있는데 properties 파일이 아닌 yml 파일로 환경설정을 할 경우 *를 설정할때는 "*" 이렇게 쌍따옴표로 감싸줘서 설정해줘야 한다)
Endpoint를 접근할때 앞에 /actuator란 경로가 붙는데 이것은 management.endpoints.web.base-path 항목이 default로 /actuator로 설정되어 있어서 그렇다(바꿔말하면 이 값을 바꿔주면 바꾼 경로로 접근이 가능하다)
● curl -X POST http://localhost:8080/refresh
책의 407 페이지를 보면 스프링 클라우드 버스에 대한 설명을 하면서 properties 파일의 항목 값을 변경했을 경우 이를 반영하기 위해 다음의 URL을 접근하도록 설명되어 있다. 그러나 막상 접근을 시도하면 404 Not Found로 나오게 되는데 그 이유는 위에서 설명한 Endpoint 경로가 앞에 /actuator가 붙게끔 기본적으로 설정이 되어 있기 때문이다. 그리고 위에서 설명했듯이 management.endpoints.web.exposure.include 항목에 refresh를 넣어주어서 Endpoint의 접근을 허용해주어야 한다. 그러나 이것만으로는 실제 동작이 이루어지지 않는다.
변경된 사항이 적용될려면 @RefreshScope 어노테이션이 붙어줘야한다. 책의 경우를 들자면 message 항목을 변경했기 때문에 message 항목을 출력하는 MessageController에 다음과 같이 붙어줘야 한다
@RestController
@RefreshScope
public class MessageController {
...
}이렇게 해준뒤에 curl 명령어를 통해 갱신해주면 정상동작되는것을 확인 할 수 있다.
management.endpoints.web.exposure.include 항목에 대한 설정은 bootstrap.properties 에 해도 되고, Spring Cloud Server가 git 저장소에서 불러오는 application.properties 파일에서 해도 된다.
● 스프링 클라우드 버스를 사용해 구성 변경 전파
책의 408 페이지를 보면 스프링 클라우드 버스를 사용해 구성 변경 전파를 설명하는 항목이 있다. 구성이 변경되었을 경우 위에서 설명한 /actuator/refresh Endpoint를 각각 스프링 클라우드 클라이언트에서 실행해서 구성이 변경된 것을 적용하는게 아니라 RabiitMQ를 이용해서 일괄적용 하는 방법을 설명하는 부분이다. 이 부분에 대한 설명을 읽어보면 409 페이지에 있는 spring-cloud-starter-bus-amqp dependency 만 추가하는 것으로 모든게 다 되는거 마냥 설명하고 있는데 그렇지가 않다.
이 지점에서 생각해보자. 클라우드 서버와 클라우드 클라이언트가 RabbitMQ를 매개체로 삼아서 구성 변경을 전파하려 한다면 당연 클라우드 서버도 RabbitMQ와 연동을 해야 한다. 그런데 여기서는 그러한 내용이 빠져 있다. 그리고 Spring Boot에서의 RabbitMQ의 설정 부분이 빠져있다(클라우드 서버든 클라우드 클라이언트든 RabbitMQ 를 연동하기위한 구체적인 설정 부분(RabbitMQ 서버의 ip 주소, 사용자명, 패스워드 등을 설정하는부분)이 있어야 한다) 이에 대한 부가설명은 쓰기엔 너무 길어서 일단 2개의 링크를 걸어두니 참조해서 설정하길 바란다. 이 설정 방법으로 구성 변경 사항이 모든 클라우드 클라이언트에 전달된 것을 테스트로 확인했다
Spring Cloud Config Server 및 Bus RabbitMQ 동기화
Spring Cloud Config Client 및 Bus RabbitMQ 동기화
지금부터는 위의 블로그에는 없는 내용을 설명하겠다.
책 410 페이지를 보면 구성변경을 전파하기 위해 스프링 클라우드 클라이언트 중 하나에다가 다음의 Endpoint를 요청하고 있다.
curl -X POST http://localhost:8080/bus/refresh
그러나 위에서 설명했다시피 Endpoint 경로 앞에 /actuator 가 붙어야 한다. 그리고 refresh가 아닌 bus-refresh를 실행해야 한다. 그러다보니 위에서 스프링 클라우드 클라이언트에 설정했던 management.endpoints.web.exposure.include 항목에 refresh를 설정했듯이 bus-refresh도 같이 설정해야 한다
management.endpoints.web.exposure.include = refresh,bus-refresh
그래서 최종 요청 명령은 다음과 같이 된다
curl -X POST http://localhost:8080/actuator/bus/bus-refresh
그리고 스프링 클라우드 서버의 application.properties 에 다음의 설정을 추가한다
spring.cloud.bus.enabled = true근데 이 설정은 default가 true 여서 설정을 하지 않아도 동작할거라 본다(Spring Boot Reference 문서에 보면 저 설정값이 default가 true이다. 그러나 테스트를 해보질 않아서 확인해보진 않았다)
나는 이부분에 대한 실습을 할때 docker에 rabbitmq:management-alpine 이미지를 컨테이너로 올려서 실습을 진행했다. 이 이미지를 사용하면 rabbitmq 서버의 관리자 화면을 브라우저를 통해 볼 수 있게 되는데 관리자 화면을 통해 connection을 보게 되면 하나의 인스턴스당 2개의 connection이 생성되는 것이 확인이 됐다(책의 예를 들어 설명하자면 spring cloud server 인스턴스 1개, microservice-a 인스턴스가 2개가 실행되기 때문에 RabbitMQ에서 connection은 총 6개가 생기는 것을 확인했다) 근데 이게 맞는건지 모르겠다. 근데 또 다시 rabbitmq 서버를 다시 재부팅해서 확인해보면 connection이 1개만 생기는 것으로 확인이 되어서 rabbitmq를 모르는 상태에서 보다보니 이 부분은 더 알기가 어려웠다
● Feign 라이브러리의 dependency 설정
책의 412 페이지를 보면 페인(Feign)을 사용하기 위해 pom.xml에 artifactId를 spring-cloud-starter-feign을 사용하도록 되어 있으나 현재는 spring-cloud-starter-openfeign 으로 바뀌었다.
● Ribbon 사용의 변경
책의 416 페이지를 보면 pom.xml에 립본(Ribbon) 라이브러리의 의존성을 추가하는 부분이 있다. artifactId를 spring-cloud-starter-ribbon을 사용하고 있으나 이 부분은 spring-cloud-starter-netflix-ribbon 으로 바뀌었다.
책의 416 페이지를 보면 application.properties에 다음의 설정을 하는 부분이 있다.
random-proxy.ribbon.listOfServers=http://localhost:8080,http://localhost:8081이 설정에 대한 구체적인 설명이 없어서 이 설정을 그대로 이용했을때 애로사항이 있었다. 처음 겪었던 애로사항은 random-proxy가 무엇인가였다. spring-cloud-starter-netflix-ribbon 을 추가했는데도 저 random-proxy를 application.properties에서 예약어로 잡히질 않았다. ribbon 이하의 설정 항목은 예약어로 잡히고 있으나 저 random-proxy는 잡히질 않았다. 그래서 알아보니 저 부분은 예약어가 아니었다. 책의 416 페이지를 보면 다음의 내용이 있다.
@FeignClient(name="microservice-a")
@RibbonClient(name="microservice-a")
public interface RandomServiceProxy여기 설정을 보면 @RibbonClient 어노테이션에 name을 microservice-a로 주는게 있는데 바로 이 microservice-a를 random-proxy 대신 작성해야 한다. 그래서 다음과 같이 작성해야 한다.
microservice-a.ribbon.listOfServers=http://localhost:8080,http://localhost:8081또 하나의 애로사항은 listOfServers 에 설정하는 값이다. 나는 이 설정값을 봤을때 properties 파일에서 해당 property에 ,(콤마)로 연결하며 서버 ip와 port 번호를 설정하길래 이것이 배열인줄 알았다. 그래서 application.yml 파일로 이 값을 설정할때 다음과 같이 했었다.
microservice-a:
ribbon:
listOfServers:
- http://localhost:8080
- http://localhost:8081yml 문법에서는 배열을 표기할때 -(하이픈)을 앞에 주어서 배열을 선언하게끔 되어 있다. 그러나 이렇게 설정을 하니 Spring Boot 어플리케이션에서 여기에 설정한 값을 찾지를 못하였다. 그래서 이에 대한 검색을 해보니 이게 배열이 아니었다. 즉 ,로 연결된 단일 문자열로 이 프로퍼티 항목이 값을 받아들이고 있었던 것이다. 그래서 이 부분을 yml로 설정할때는 다음과 같이 해야 된다.
microservice-a:
ribbon:
listOfServers: http://localhost:8080, http://localhost:8081
● Eureka 설정 변경
책의 423 페이지를 보면 유레카(Eureka) 라이브러리를 pom.xml에 설정하는 부분이 있다. 책에서는 artifactId를 spring-cloud-starter-eureka 로 하고 있지만 이걸로 하는게 아니라 립본과 마찬가지로 spring-cloud-starter-netflix-eureka-client로 설정해야 한다(netflix가 언급이 되는 식의..)
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>마찬가지로 책의 421 페이지와 같이 유레카 서버를 만들면 라이브러리가 다음과 같이 추가된다
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>책의 425 페이지에서 설명하는 유레카와 서비스 소비자 마이크로서비스 연결 항목에서도 위에서 설정한것과 같이 spring-cloud-starter-netflix-eureka-client를 사용해야 한다
● Eureka 사용하면서 알아낸 내용
책에 나와있는대로 Eureka 서버를 구성하면 브라우저에서 http://localhost:8761로 Spring이 제공하는 유레카 메인 화면을 볼 수 있다. 이 화면에서 보면 Instances currently registered with Eureka 항목에 Application 항목으로 MICROSERVICE-A가 2개(책에 나와 있는대로 설정해서 실행하면 microservice-a가 8080 포트와 8081 포트에 바인딩 된 상태로 2개)가 올라와 있고 SERVICE-CONSUMER가 1개 올라와 있다. 그리고 MICROSERVICE-A에 보면 STATUS 항목에 UP(2)로 표시되면서 localhost:microservice-a:8080과 localhost:microservice-a:8081에 링크가 걸려있다. 이 링크를 각각 클릭해보면 localhost:8080/actuator/info와 localhost:8081/actuator/info 로 이동하게 되는데 이 URL로의 접근이 되질 않는다. 이유는 스프링 클라우드 버스 실습을 위해 위에서 언급했던 management.endpoints.web.exposure.include 항목을 refresh와 bus-refresh로 설정해서 그런거였다. 그러나 원래 이 설정을 안하면 기본적으로 이 항목은 info와 health는 기본값으로 들어가게 되어 있다. 그래서 info와 health를 수동으로 추가해줘야 한다.
그러나 이 항목의 변경은 RabbitMQ를 이용한 refresh 대상이 되질 않는다. 이유는 위에서 얘기했다시피 변경사항을 적용시킬려면 @RefreshScope 어노테이션을 붙여줘야 하는데 application.yml 파일을 수정하는 것은 @RefreshScope 어노테이션의 감시대상에는 들어가고 있지 않기 때문이다(이 부분도 개념적으로 좀 1차적으로 정리해보자면 프로그래머가 만든 비즈니스 로직일 경우 그 로직을 직접 구현하는 쪽에다가 @RefreshScope 어노테이션을 붙이면 변경사항 적용이 가능하겠지만 application.yml 과 같은 스프링 설정과 관련된 변경사항일 경우엔 @RefreshScope 어노테이션을 붙일 마땅한 장소가 없다. 그렇기 때문에 변경사항 적용에 대한 부분은 어디까지나 비즈니스 로직쪽에 한정을 두는 것이 어떨까 하는게 나의 1차적인 결론이다)
● Spring Cloud Sleuth AlwaysSampler Bean 선언
책의 437 페이지를 보면 스프링 클라우드 슬루스 설정과 이에 대한 Bean 생성에 대한 코드가 있다. pom.xml에 의존성 설정하는 부분은 맞지만 페이지의 하단에 있는 @Bean 어노테이션을 통한 AlwaysSampler Bean을 생성하는 코드는 Spring Cloud 2.0 으로 넘어가면서 Spring에서 제공하는 AlwaysSampler를 사용하는 것이 아니라 Brave에서 제공하는 Tracing Library를 사용하는 것으로 바뀌었다.
(관련내용)그래서 이에 대한 코드 변화가 발생하였다. microservice-a, service-comsumer, zuul-api-gateway-server의 Spring Boot Application 클래스(main 메소드가 있는 클래스)에 다음과 같이 코딩해준다
@Bean
public Sampler sampler() {
return Sampler.ALWAYS_SAMPLE;
}이렇게 코딩해주면 책의 로그 관련 설명에 대한 부분을 볼 수 있다. 이 부분도 부가 설명을 하자면 로그 내용이 동일하지는 않다. 다만 이 책에서 설명하는 핵심 내용인 요청을 추적하는데 사용되는 값에 대한 확인은 가능하다.
● Zipkin 서버 구축 및 이에 대한 설정과 연동
책의 441 페이지를 보면 Spring Boot 기반하에서 Zipkin 서버를 독자적으로 구동하는 방법이 나오는데, 이 부분이 개인적으로 파악하고 정리하는데 시간이 오래걸렸다. 맨 먼저 발생한 지점은 441 페이지를 보면 Spring Boot 프로젝트를 start.spring.io에서 만들때 Zipkin UI, Zipkin Stream, Stream Rabbit 이렇게 Dependency를 선택하는 그림이 있는데 문제는 현재 이 dependency 들이 존재하지 않았다는 점이다. 그래서 그림에서와 같이 Spring Boot의 버전을 1.5.2로 낮춰서 해보면 나올수 있을까 싶어서 이렇게 해보았지만서도 나오지를 않았다. 그래서 프로젝트를 만들때 lombok, devtools, actuator 만 추가해 놓고 수동으로 추가로 넣을수 있게끔 일단 만든 상태에서 조시해보았다. 구글에서 검색한 내용도 책과는 별 차이는 없었다. 대신 책과는 달리 검색을 해보면 pom.xml에 dependency를 넣는 부분이 text로 되어 있기 때문에 어떤 groupId와 artifactId를 사용해야 하는지는 확인할 수 있었다. 내가 참조한 게시물은 Spring Cloud and Spring Boot, Part 2: Implementing Zipkin Server For Distributed Tracing 글을 참조해서 만들어갔다. 이 글은 Spring Boot 2.1은 아니었지만 그래도 2.0.X를 사용하고 있었기 때문에 현재 Spring Cloud를 GreenWich로 사용하고 있는 나로서는 적합한 내용일것 같았다. 그러나 이렇게 했는데도 문제는 존재한게 있었다. 위의 글에서와 같이 pom.xml에 zipkin 관련 설정을 해두고 442 페이지에 있는 @EnableZipkinServer 어노테이션을 붙이면 이 어노테이션이 deprecated 된 것으로 나온다. 그리고 @EnableZipkinServer 어노테이션이 2개가 존재하는 것을 알 수 있다.(이 글을 쓰는 시점에서는 Zipkin 서버를 Spring Boot 를 통해 구현하지는 않았기 때문에 관련 소스를 지워서 패키지를 알 수는 없지만 위의 링크된 글대로 zipkin 관련 라이브러리를 pom.xml을 설정한 뒤에 IDE에서 @EnableZipkinServer를 타이핑 해보면 deprecated 된 것과 그렇지 않은거 이렇게 2개가 나타난다) 첨엔 deprecated 되지 않은 어노테이션을 붙여봤는데 Spring Boot로는 9411 포트는 열려져 있지만 콘솔 로그를 면 이 Zipkin Server가 8080 포트로 열리고 있었다. 그래서 http://localhost:9411 로는 브라우저에서 접근이 안되었고 http://localhost:8080 으로는 브라우저에서 접근이 되어서 책의 442 페이지와 같은 화면을 볼 수 있었다. 이것을 어떻게든 고쳐볼려고 여러모로 검색해보고 시도해봤지만 실패하고 말았는데 결국 이러한 작업을 접게끔 만들어준것은 deprecated 된 @EnableZipkinServer 어노테이션의 소스에 있는 javadoc 설명이었다. 여기 설명을 보면 다음의 내용이 있다.
Custom servers are possible, but not supported by the community. Please use our
https://github.com/apache/incubator-zipkin#quick-start default server build first.
Zipkin Custom Server는 지원하지만 커뮤니티에서는 지원하지 않는다는 뜻이었다. 즉 기술적으로는 Zipkin Custom Server를 구축하는 것에는 문제는 없지만 이에 대한 기술적인 지원은 커뮤니티에서 하지 않는다는 것이다. 아마 Zipkin Custom Server 구축에 대한 기술적인 통로를 열어주면서 이에 대한 여러가지 형태의 Zipkin Server 구현체가 나오다보니 이에 대한 기술지원이 한계에 이르러서 그런듯 하다. 그래서 Custom Server를 만들때 이에 대한 문제점이 발생할 경우 그것은 전적으로 개발자 책임이란 식의 얘기를 덧붙이고 있다. 그러면서 마지막으로 Custom Server는 가능하지만 지원해주지는 않는다(custom servers are possible, but not supported)란 말로 마무리 짓고 있다. 그리고 stackoverflow 에서도 이에 대한 언급을 찾은것도 있었다.(여기 글에 대한 MyTwoCents의 답글에 Brian Devins 의 댓글을 보면 위의 설명과 같은 맥락으로 해설할 수 있다. 커뮤니티에서 이 Custom Server 제작과 관련된 기술을 열어둔 뒤 얼마나 이것에 대한 기술질문 들에 대해 시달렸으면 @EnableZipkinServer 사용을 권장하지 말라. 커뮤니티에 부담이 된다 라고 언급했을까..) 그래서 @EnableZipkinServer 어노테이션을 통한 Zipkin Server 구현은 접고서 Zipkin을 만들어서 배포하는 zipkin.io 의 가이드라인에 따라 Zipkin Server를 열었다. Docker Image로도 Zipkin Server를 제공해주기 때문에 나는 Docker로 Zipkin Server를 열었다. 다음은 내가 이 실습을 위해 열은 Zipkin Server를 구동시키는 docker-compose.yml 파일 소스이다.
version: '2.1'
services:
zipkin:
image: openzipkin/zipkin
container_name: zipkin
# volumes:
# - /vagrant_hosts/docker/alpine_nginx_docroot:/docroot:rw
environment:
- RABBIT_ADDRESSES=10.10.20.6:5672
- RABBIT_USER=admin
- RABBIT_PASSWORD=admin
restart: always
ports:
- "9411:9411"
networks:
dockernet:
ipv4_address: 10.10.20.7
networks:
dockernet:
external: true여기서 보면 openzipkin/zipkin 이란 이미지를 사용하고 있고 이 이미지로 열었을 경우 zipkin 이란 이름으로 container가 만들어지도록 했다. 그리고 환경변수로 RABBIT_ADDRESSES, RABBIT_USER, RABBIT_PASSWORD 이렇게 3개가 있는데 이 3개의 항목은 RABBITMQ 서버와 관련된 항목이다. 책의 443 페이지를 보면 spring-cloud-sleuth-zipkin 라이브러리와 함께 spring-cloud-starter-bus-amqp 를 같이 추가해주고 있다. spring-cloud-starter-bus-amqp 의 경우는 스프링 클라우드 버스와 관련된 실습을 할때 microservice-a 어플리케이션에 이미 의존성을 추가해둔 상태이지만 443 페이지에서는 service comsumer 와 zuul-api-gateway-server 에도 추가해주도록 되어 있다. 이것은 sleuth를 통해 만들어진 추적 로그를 RabbitMQ를 통해서 Zipkin Server에 전달하기 위해 그런것이다. 책에서 보면 442 페이지에 스트림 레빗이 이와 같은 역할을 하는 것이었지만 현재 스프링은 더이상 이에 대한 지원은 하지 않기 때문에 Zipkin Server 에서 RabbitMQ로 연결하는 설정을 해주어야 하는 것이다. 그래서 이 3개의 환경변수 설정이 추가로 필요하게 되었다.
그리고 책에는 언급이 안되어 있는데 우리가 만든 microservice-a, service-comsumer, zuul-api-gateway-server가 zipkin과 연동이 되어야 하는데 이 부분에 대한 언급이 없다. 즉 어떤 zipkin server와 연동해야 할 것인지, 보내는 방법은 무엇을 사용할 것인지 등에 대한 설정을 해야 하는데 그에 대해서는 application.yml에 다음의 설정을 해주도록 하자
spring:
zipkin:
base-url: http://localhost:9411/
sender:
type: rabbit
enabled: true
rabbitmq:
host: localhost
username: admin
password: admin
sleuth:
sampler:
probability: 1spring.zipkin.base-url에는 zipkin 서버 url을 설정해준다. spring.zipkin.sender.type 에는 rabbit을 설정함으로서 rabbitmq 서버를 통해 sleuth 를 통해 만들어진 추적 정보를 보내주게 된다. 그리고 해당 RabbitMQ 서버는 spring.rabbitmq에 관련 정보를 언급해두도록 하며 마지막의 spring.sleuth.sample.probability는 추적 로그를 샘플링 하는 비율이다. 예를 들어 이 값을 1로 설정하면 요청된 모든 사항에 대한 전체 샘플링을 하겠다는 뜻이다. 그러나 이것을 0.1로 할 경우 전체 요청의 10%만을 샘플링하겠다는 뜻이다. 이 샘플링 된 것들만이 Zipkin을 통해 추적이 가능하기 때문에 전체 사항을 추적해볼려면 1로 설정하는 것이 좋을듯 하나 실제로는 매번 요청할때마다 샘플링해서 zipkin 서버로 보내주어야 하기 때문에 이에 대한 부하도 분명 있을수 있다. 이것은 운영하면서 결정지어야 할 듯 하다. 지금은 테스트 용도니까 1로 주는 것으로 했다. 이러한 설정들을 마친뒤 docker-compose를 통해 Zipkin Server를 구동하고 각각의 Spring Boot 어플리케이션을 실행해보면 책에서 보여주고 있는 Zipkin UI 를 통해 이를 확인할 수 있다.
※ RabbitMQ Server 설정과 관련하여 이상하게 생각할 사람이 있을것 같아 추가로 더 언급해두고자 한다. 일단 나는 RabbitMQ Server와 Zipkin Server를 Docker 기반에서 실행되도록 하였다. 이 Docker의 경우는 Windows 10에 VirtualBox와 Vagrant를 설치한 후 이를 통해 centos 7 vagrant 컨테이너가 실행이 되는 기반에서 여기에 Docker를 설치하여 운영했다. RabbitMQ 서버에는 ip를 10.10.20.6
으로 주고, Zipkin Server에는 10.10.20.7로 주었다. 그래서 Zipkin에서 RabbitMQ Server를 연동할때는 RABBIT_ADDRESSES 환경변수에 해당 ip를 직접 설정해주었다. 그러나 Spring Boot Application의 경우 Windows 10에서 실행되다보니 각 Server의 ip를 통해 접근하지는 않았고 대신 해당 Server가 사용하는 기본 port를 port forwarding 설정을 해줌으로써 localhost로 설정
하더라도 port forwarding 을 통해 기본 포트가 해당 Server로 통신이 이루어지도록 했다. 그래서 application.yml에서는 RabbitMQ Server를 언급할때 10.10.20.6이 아닌 localhost로 지정할 수 있었다.
● @EnableHystrix 에 대하여
책의 446 페이지를 보면 Hystrix를 통한 마이크로서비스의 내결함성 구현에 대해 설명하고 있는데 이걸 할려면 의존성 정보를 다음과 같이 주는 식으로 수정해주어야 한다
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>그리고 책에서 보면 hystrix 자동설정을 @EnableHystrix 어노테이션을 사용하도록 되어 있다. 그러나 Spring Cloud 문서를 보면 @EnableHystrix가 아닌 @EnableCircuitBreaker 어노테이션을 사용하도록 되어 있다.
그러면 @EnableHystrix와 @EnableCircuitBreaker의 차이점을 언급해야 할 듯하다. 마이크로서비스의 내결함성을 위해 이른바 Circuit Breaker 패턴을 사용하게 되는데 @EnableHystrix는 Hystrix를 통해 Circuit Breaker 패턴을 구현하는 것이고, @EnableCircuitBreaker는 Circuit Breaker 패턴 구현을 Hystrix로 구현한 것이다.(이게 말이야 방구야..?)
이 두 문장의 의미는 현 시점에서는 동일하게 비쳐지지만 엄밀하게 따지면 다른 점이 있다. @EnableHystrix는 Hystrix에 우선을 둔다. 즉 Hystrix를 통해 Curcuit Breaker 패턴을 구현하기 때문에 ClassPath에 Hystrix 라이브러리가 없으면 동작하지 않는다. 그러나 @EnableCircuitBreaker 는 Circuit Breaker 패턴에 우선을 둔다. 즉 Circuit Breaker 패턴을 구현할 수 있는 라이브러리만 있다면 동작이 가능한 것이다. 즉 Circuit Breaker를 구현하기 위해 Hystrix를 사용한다면 이 두 어노테이션은 동일한 동작을 한다. 그러나 Circuit Breaker를 구현하기 위해 Hystrix가 아닌 다른 라이브러리(예를 들어 finagle이나 javaslang-circuitbreaker 등)을 사용한다면 @EnableCircuitBreraker는 사용 가능하지만 @EnableHystrix는 사용할 수 없게 된다.(관련 내용은 여기에서 참조했다) 그리고 여기를 보면 Spring Cloud 에서 조차도 @EnableHystrix을 삭제(deprecated가 아닌)하려는 움직임이 있어 보인다.
약간 추가적인 설명을 더 하자면 이 책에서 실습으로 사용되는 라이브러리는 Netflix가 사용하는 마이크로서비스 라이브러리가 그 중심이다. 그렇기 때문에 @EnableHystrix 대신에 @EnableCircuitBreaker 로 더 범용적인 설정을 사용하게끔은 하겠지만 그 이후에 사용하는 어노테이션인 @HystrixCommand 는 그대로 갈 것이다(@EnableHystrix가 없어진다고 해서 @HystrixCommand 도 없어지지는 않는다는 의미임) 왜냐면 @HystrixCommand는 Circuit Breaker 패턴을 Hystrix로 구현하겠다고 결정되어진 이후에 동작하는 어노테이션이기 때문이다. 만약 위에서 잠깐 언급한 finagle 이나 javaslang-circuitbreaker를 Spring Cloud가 지원하게 된다면 @HysrixCommand도 @EnableCircuitBreaker와 같이 좀더 범용적인 어노테이션으로 바뀔것이라 생각한다.
● Hystrix 모니터링
책에서는 다루지 않는 내용인데 Spring Cloud Greenwich Reference 문서를 보면 Hystrix를 모니터링 할 수 있는 Hystrix DashBoard를 설명한 부분이 있어서 이를 한번 구현해 보았다. 관련 내용은 여기를 보고 만들어봤다. 다만 이걸 만든뒤 실습을 할려면 책을 보고 만들었던 프로젝트에서 수정해야 할 것이 생겨서 이에 대한 설명을 하고자 한다.
우리가 Hystrix를 테스트 할 때는 microservice-a 인스턴스를 띄우지 않은 상태에서 service-consumer 인스턴스를 띄운뒤에 http://localhost:8100/add 메소드를 실행시켜 service-consumer 인스턴스가 microservice-a 인스턴스의 random 메소드를 실행시킬수 없게끔 동작 실패를 유도하는 식으로 Hystrix를 테스트했다. 여기서 우리는 hystrix를 모니터링 해야 하는 대상을 잡아야 하는데 hystrix를 모니터링 해야 하는 대상은 service-consumer 인스턴스이다(hystrix 관련 설정을 service-consumer에다가 했으니까..) 그래서 hystrix 모니터링 인스턴스가 service-consumer 인스턴스를 모니터링을 해야 하기 때문에 이를 모니터링 하기 위해 service-consumer 프로젝트에 몇몇 수정을 가해야 할 부분이 있다.
- Hystrix 모니터링은 Actuator 기반으로 움직이기 때문에 service-consumer의 pom.xml 에 Spring Actuator를 추가 해야 한다(책에서 스프링 클라우드 버스를 설명할때 이 Actuator를 microservice-a 의 pom.xml에만 추가했기 때문에 Spring Actuator에 대한 dependency 태그를 service-consumer의 pom.xml에 추가해야 한다)
- Spring Actuator를 이용해서 하는 것이기 때문에 Hystrix 모니터링에서 service-consumer로 접근할 Endpoint를 지정해야 한다. Hystrix 모니터링에서 사용할 Endpoint는 hystrix.stream 이다. 그래서 service-consumer의 application.yml에 다음의 내용을 추가해준다.
management: endpoints: web: exposure: include: info, health, refresh, bus-refresh, hystrix.stream
info와 health는 default로 include 되는 항목이고 refresh와 bus-refresh는 위에서 스프링 클라우드 버스때 설명했단 Endpoint이다. 마지막으로 hystrix.stream 이 바로 Hystrix 모니터링을 하기 위해 추가된 Endpoint이다
이렇게 한 뒤에 microservice-a 인스턴스는 일절 띄우지 말고 service-comsumer 인스턴스와 hystrix 모니터링 인스턴스를 띄운 상태에서 hystrix 모니터링 화면을 띄우고 http://localhost:8100/add 메소드를 반복적으로 호출해보자. 그러면 모니터링 화면에서 실패한 횟수가 점점 올라가는데 단지 몇번 실패한 걸로는 circuit이 close 된 상태를 유지하지만 한 20여번 실패하게 되면 circuit이 open 된 상태로 바뀌면서 아예 호출 자체를 막아버린다. 그런 뒤에 다시 microservice-a 인스턴스를 띄운 후 http://localhost:8100/add 메소드를 호출해서 정상 동작을 하게끔 해주면 다시 circuit이 close 되는 것을 확인할 수 있다.
'프로그래밍 > 컴퓨터 서적 리뷰 & After Service' 카테고리의 다른 글
| JAVA 언어로 배우는 디자인 패턴 입문(3판) 리뷰 (8) | 2022.12.20 |
|---|---|
| 가상머신 Kubernetes 환경에서 NFS를 이용한 PV, PVC 관리(feat. 시작하세요 도커/쿠버네티스) (0) | 2020.05.25 |
| 가상머신 Kubernetes 환경에서 NodePort로 Ingress 구축하기(feat. 시작하세요 도커/쿠버네티스) (3) | 2020.05.22 |
| 스프링 부트 2.0 2/e 마이크로서비스와 리액티브 프로그래밍 (0) | 2019.06.07 |