관련링크

와탭의 기술 문서 와탭 독스

혹시 와탭의 기술 문서 ‘WhaTap Docs’에 대해 들어보신 적이 있나요? 다름이 아니라 이번에 와탭 독스를 소개해 드릴 예정이거든요.

기술 문서란 기술 정보의 효율적인 전달에 목적을 둔 문서를 말합니다.정보를 명확하고 간결하게 제시해 서비스 활용과 이해를 돕기 위한 문서로, 크게 사용자 문서와 프로세스 문서로 나눌 수 있어요.

• 사용자 문서는 제품을 올바르게 사용하기 위한 정보를 제공합니다.
• 프로세스 문서는 제품의 개발, 테스트, 유지 보수 및 개선과 같은 프로세스에 관한 안내를 제공합니다.

또한 기술 문서는 독자를 특정하고 있어요. 개발자, 엔지니어 그리고 기술 정보 해당 서비스 사용자, 즉 와탭의 사용자 여러분이 그 독자입니다. 와탭이 제공하는 기술 문서 ‘WhaTap Docs’가 바로 여러분을 위한 사용자 문서, 흔히 말하는 유저 가이드입니다.

WhaTap Docs 구조 알아보기

먼저 와탭 독스의 구조를 확인해 보겠습니다. 와탭 독스 메인 화면은 각 메뉴에 대한 간략한 안내와 함께 상품별 문서 바로가기를 제공합니다. 메뉴는 시작하기, 상품별 문서 바로가기, 관리, 라이선스, 참조 문서, 릴리스 노트 6가지의 섹션으로 구성되어 있습니다. 메인 화면 좌측의 사이드 메뉴 또는 상단의 고정 메뉴를 통해 각 콘텐츠에 접근할 수 있으며, 상단의 고정 메뉴에서는 다국어 옵션과 검색 옵션을 제공하고 있습니다.

와탭 모니터링 서비스 또는 와탭 독스를 처음 접한 경우라면 가장 먼저 시작하기 섹션을 확인하는 것을 권장하고 싶어요. 서비스 이용 흐름과 공통 안내 개요, 특히 서비스 이용 초기에 자주 묻는 질문과 관련된 정보를 포함해 와탭 서비스의 전반적인 내용을 손쉽게 살펴볼 수 있거든요.

시작하기 섹션의 학습하기 메뉴에서는 활용 안내 콘텐츠를 제공합니다. 상품별 대시보드 분석 방법, 성능 장애 유형, 거기에 더해 모니터링의 꽃인 알림 기능 중 메트릭스 경고 알림 설정 방법 등을 안내하고 있어요. 예를 들어 Java 상품의 애플리케이션 대시보드 문서가 해당 대시보드 위젯 구성과 각 위젯의 기능 정의를 설명하는 반면, 학습하기 내 애플리케이션 대시보드 분석 문서에서는 기본적인 기능 정의 대신 기초 활용 방법을 다루고 있어요.

• Java 상품 애플리케이션 대시보드 문서: 아크 이퀄라이저 차트 위젯으로 표현된 액티브 트랜잭션의 정의 및 위험 단계와 같은 기본적인 요소를 설명합니다.
• 학습하기 내 애플리케이션 대시보드 분석 문서: 액티브 트랜잭션 위젯을 통해 지연 발생 현황을 에이전트별로 확인하는 방법, 메소드와 HTTPC 등 외부 요소 분석 방법 등을 안내합니다.

아직은 일부 상품의 안내를 제공하고 있지만 앞으로도 지속적으로 업데이트할 예정이니 꼭 확인해 주세요.

다음으로 상품별 문서 바로가기 섹션의 경우 제품별로 와탭 에이전트 설치부터 각 서비스 메뉴에 대한 안내를 다루고 있습니다. 예를 들어 애플리케이션 대시보드에서 확인할 수 있는 메트릭스 및 세부 옵션, 히트맵 드래그 후 확인할 수 있는 트랜잭션 정보창, 메트릭스와 메트릭스 조회, 보고서와 통계, 알림 설정 요건 등 각 메뉴의 기본 기능을 정의하고 설명합니다. 제품별로 구성에 차이가 있을 수 있어요.

관리 섹션에서는 와탭 모니터링 서비스의 공통적인 관리 기능과 계정에 대한 안내를 제공합니다. 예를 들어 멀티 팩터 인증 방식, 결제 정보, 그리고 와탭의 기본적인 모니터링 단위인 프로젝트의 정의와 구조 등에 대한 정보가 포함되어 있습니다.

라이선스 섹션에서는 와탭이 사용하는 오픈 소스 라이선스와 라이브러리를 안내합니다.

참조 문서 섹션은 와탭 독스에서 사용하는 주요 개념과 용어에 대한 자료집을 제공합니다. 성능 데이터 수집 방법과 구성 요소, 그리고 여러 에이전트에서 수집한 메트릭스를 종합적으로 활용하기 위한 쿼리 언어인 MXQL, 오픈 API 활용 예시, 자주 묻는 질문 등을 제공합니다. FAQ의 경우 현재 데이터베이스와 로그 모니터링 관련 안내를 제공하며, FAQ 역시 지속해서 업데이트될 예정이에요. 또 간략한 용어 사전과 매달 초 최신화한 기술문서를 PDF 형식으로 제공합니다.

릴리스 노트 섹션에서는 와탭 모니터링 서비스의 최신 기능, 개선 사항, 중요한 보안 패치에 대한 정보를 확인할 수 있습니다.

💡와탭 모니터링 서비스는 매달 마지막 주 수요일에 배포가 이루어집니다.

WhaTap Docs 문서 구성 살펴보기

이번에는 와탭 독스의 상품별 문서 구성을 살펴보겠습니다. 우선 서비스 화면에서 확인할 수 있는 UI 텍스트의 경우 파란색으로 강조되고, 파일 및 경로 텍스트는 녹색으로 표시됩니다. 또한 와탭 독스 내에서 관련성이 높거나 상세한 기술이 있는 경우 참조 링크를 제공합니다.

예시로 Java 모니터링 상품의 기술 문서로 이동해 해당 메뉴를 확인해 볼게요. 상품별 바로가기 링크는 기본적으로 해당 상품의 소개 페이지로 이동합니다. 상품 문서는 크게 두 가지 목차 구성을 갖추고 있어요. 첫 번째는 에이전트 설치와 관리 그리고 두 번째는 주요 메뉴 알아보기 아래 해당 서비스 기능에 대한 안내입니다. 상품별로 세부적인 서비스 기능 안내 목차에 차이가 있을 수 있지만 기본적으로 이 두 가지 구성이 동일하게 유지됩니다.

에이전트 설치와 관리 편을 통해 먼저 에이전트 설치 전 확인해야 할 지원 환경과 에이전트 설치 과정을 안내합니다. Java의 경우 애플리케이션 서버 환경에 따른 설정 문서를 추가로 제공하고 있어요. 에이전트 설치 후 점검 사항, 설치 중 문제가 발생한 경우 대응 예시를 안내하는 설치 문제 해결 방법도 포함합니다. 또한 서비스 화면의 에이전트 설정 메뉴에서 확인할 수 있는 에이전트 설정 옵션 그리고 에이전트 업데이트나 삭제, 이전 버전으로 롤백하는 방법에 관한 문서도 제공하고 있습니다.

주요 메뉴 알아보기는 서비스의 프로젝트 메뉴 및 사이트맵에서 접근할 수 있는 각 메뉴와 기능에 대한 안내를 제공합니다. 에이전트를 설치하고 설치 점검까지 마쳤다면 데이터가 어떻게 수집되고 있는지 알아봐야 하지 않을까요? 따라서 서비스 대시보드 메뉴에서 실시간으로 수집되는 정보를 애플리케이션 대시보드를 통해 조회하고, 히트맵을 사용해 종료된 트랜잭션 트레이스를 확인하는 방법을 안내합니다. 또한 진행 중인 트랜잭션이 정기적으로 덤프한 스택을 수집하는 액티브 스택과 와탭 프로젝트에 등록된 애플리케이션 서비스 간의 호출을 추적하는 멀티 트랜잭션 추적에 대한 안내를 제공합니다. 와탭이 수집하는 기본적인 애플리케이션 메트릭스와 다양한 분석 관점으로 메트릭스를 조회하는 서비스 분석 하위 메뉴의 기능에 대해 설명합니다. 그리고 서비스 경고 알림 설정 메뉴에서 애플리케이션 이벤트, 메트릭스 이벤트, 로그 이벤트, 히트맵 패턴 등의 알림 설정에 관한 기본적인 설명을 제공합니다.

이렇게 상품별 문서는 와탭 에이전트 설치 준비부터 에이전트 설치 후 와탭 에이전트가 수집한 메트릭스를 다양한 관점으로 조회하고 또 알림을 설정하는 방법을 서비스 메뉴 기준으로 안내하고 있습니다.

WhaTap Docs 검색하기

그렇다면 와탭 독스를 어떻게 ‘잘’ 활용할 수 있을까요? 기술 문서의 첫 페이지부터 끝까지 모두 완독하는 것? 정독과 완독, 물론 좋습니다. 좋긴 한데, 애플리케이션 제품군의 경우 총 분량이 PDF로 대략 3천여 페이지입니다. Java 제품만 해도 500 페이지가 넘습니다. 앞서 안내한 각 섹션별 메뉴 구조를 살펴보는 것도 하나의 방법이지만, 효율적인 검색 방법을 사용해 필요한 정보를 빠르게 찾아내는 것이 중요하지 않을까요?

와탭 독스 주소 (docs.whatap.io) 를 방문해 메인 화면으로 바로 이동하거나, 와탭 서비스 화면에서 가이드 아이콘을 선택해 와탭 독스 메인 화면으로 이동할 수 있습니다. 원하는 ‘키워드’와 ‘와탭’을 조합해 검색 엔진을 활용해 이동할 수도 있습니다. ‘키워드’과 함께 사이트 지정 조건 ‘site: docs.whatap.io’ 을 사용할 수도 있습니다. 예를 들어 ‘트랜잭션 트레이싱’과 ‘와탭’을 함께 입력하면, 와탭 히트맵을 통해 트레이스 정보를 확인하고 분석하는 즉 ‘트랜잭션 트레이싱’ 안내 문서를 쉽게 찾을 수 있습니다.

• 키워드 + 와탭
• 키워드 + site: docs.whatap.io

와탭 독스 내 검색 기능을 활용할 수도 있어요. 상단 고정 메뉴의 검색 아이콘을 선택하면 키워드 입력과 최근 검색 기록 조회가 가능한 검색 창이 나타납니다. 최근 검색 기록 조회 구간에서 즐겨찾기를 추가(별 아이콘)하거나 제거(X 아이콘)할 수 있어요. 즐겨찾기 된 문서는 검색 창 하단의 즐겨찾기 구간에서 쉽게 식별할 수 있습니다. 메트릭스 안내 또는 에이전트 설정 옵션과 같이 자주 확인이 필요한 문서라면 와탭 독스 내 즐겨찾기 기능을 써 보시는 건 어떨까요?

검색 결과는 상품명(구획별 상단), 목차(문서 아이콘), 소제목(샵 아이콘) 및 키워드(바 세 개 콘텐츠 아이콘)로 구분해 표시합니다. 검색 결과 창에서 키보드 방향키나 마우스 휠을 사용해 이동할 수 있어요. 검색 결과가 많을 경우 하단의 ‘모든 결과 보기’를 선택하면 더 많은 결과를 살펴볼 수 있습니다.

💡와탭 독스 내 검색은 상품명과 검색을 원하는 기능 키워드 조합 시 가장 정확한 결과를 확인할 수 있습니다.

와탭 독스와 와탭 독스 활용 방법

와탭 독스는 와탭 모니터링 서비스 관련 기술 정보를 제공하고 있습니다. 학습용 사례와 자주 묻는 질문(FAQ) 등은 꾸준히 업데이트할 예정이에요. 이번 기회를 통해 와탭 독스를 소개해 보았는데, 와탭 독스와 와탭 독스 활용 방법을 이해하는 데에 조금은 도움이 되었을까요? 앞으로 보다 많은 분들이 와탭 독스를 활용해 주시길 바라며 여기에서 마치겠습니다.