[cs-manager] 토픽 네이밍 컨벤션

[tonykang22]

토픽 네이밍 컨벤션

개요

• CS에서는 카프카를 사용하고 있다.
• 카프카의 토픽에 적절한 이름을 부여하기 위해 카프카 토픽 네이밍 컨벤션을 찾아보기로 한다.

컨벤션

• 카프카에서 토픽 생성 시에 사용하는 문자는 다음과 같다.
  • 영문, 숫자, ., _, -
• 널리 사용되는 케이스들은 아래와 같다.
  • namespace.product.event-type
  • application-data-type-event-type
  • organization.application-name.event-type.event
  • message type.dataset name.data name
  • root name space.product.product specific hierarchy
  • app type.app name.dataset name.stage of processing
  • app type.dataset name.data
• 카프카 네이밍 시 유의사항
  • 변경될 여지가 있는 네이밍을 사용하지 않는다.
  • 메타데이터, 스키마 정보를 네이밍에 사용하지 않는다.
  • 파티션, 보안 정보를 네이밍에 사용하지 않는다.
  • 토픽 이름에 consumers, producers 등의 정보를 담지 않는다.
• 해당 글에서는 <message type>.<dataset name>.<data name>를 추천한다고 한다.
  • message type
    • logging, queuing, tracking, streaming, push, user, ...
  • dataset name
    • 해당 데이터 셋의 이름 [데이터베이스로 치면 데이터베이스 이름]
  • data name
    • 해당 데이터의 이름 [데이터베이스로 치면 테이블 이름: 계층을 나타내기에 좋다고 한다.]
• 레퍼런스 : 참고

적용

• CS에서 카프카를 통해 전송할 데이터
  • 고객의 주문이 들어왔을 때
    • 고객 성함
    • 고객 휴대폰 번호
    • 주문 번호
    • 주문 상품 이름
    • 메세지 전송 플랫폼
  • 고객의 주문이 발송 되었을 때
    • 고객 성함
    • 고객 휴대폰 번호
    • 주문 번호
    • 주문 상품 이름
    • 메세지 전송 플랫폼
    • 송장 번호
• 현재로서는 CS에서 카프카의 사용이 한정적이기 때문에 가급적 간결한 네이밍이면 좋을 것으로 판단된다.
  • 3개 정도의 정보를 담는게 좋을 것으로 판단된다.

두 가지 후보

• <application>-<data-type>-<event-type>를 적용한다면,
  • application
    • cs
  • data-type
    • welcome
    • shipping
  • event-type
    • message
    • test
• <message type>.<dataset name>.<data name>를 적용한다면,
  • message type
    • message : 고객에게 메세지 전송을 위함
    • test : 테스트 용도 (가령 local 실행을 위함)
  • dataset name
    • cs
  • data name
    • welcome
    • shipping
• 두 가지를 다시 써본다면,
  • cs-welcome-message: CS의 welcome 데이터를 메세지로 전송하기 위한 토픽
  • message.cs.welcome: 메세지를 전송에 필요한 cs.welcome 데이터를 위한 토픽
• 사실 cs등의 네이밍은 중복될 네이밍으로, 이 정보가 먼저 나오는 것보다는 메세지가 어떤 것을 위한 것인지에 대한 정보를 먼저 두는게 낫다고 판단된다.
• <message type>.<dataset name>.<data name>가 낫다고 판단.
  • message.cs.welcome
  • message.cs.shipping
  • test.cs.welcome
  • test.cs.shipping

[tonykang22]

코멘트 작성자: kingwaggs

``` {service_name}.{module_name}.{event_type}.{event_name} hwas.cs.pushalarm.welcome hwas.cs.pushalarm.shipping test.hwas.cs.pushalarm.welcome test.hwas.cs.pushalarm.shipping

[tonykang22]

위에 윤성님께서 코멘트 주신 방식을 차용하기로 결정함.