ElasticSearch ‐ cat API - dnwls16071/Backend_Study_TIL GitHub Wiki

📚 cat API

  • cat API(Compact and Aligned Text APIs)의 약자로 클러스터 정보를 사람이 읽기 편한 형태로 출력하기 위한 용도로 만들어진 API
  • UI 기반의 모니터링 시스템이 원인 파악에 더 편하지만 cat API는 상황을 빠르게 판단하는데 도움이 되므로 이해가 필수이다.

📚 cat health

  • ElasticSearch 클러스터의 전반적인 상태를 확인할 수 있다.
  • http://localhost:9200/_cat/health?v

스크린샷 2025-04-14 오후 5 49 47

상태 의미
green 프라이머리 샤드, 레플리카 샤드 모두 정상적으로 각 노드에 배치되어 동작하고 있는 상태
yellow 프라이머리 샤드는 정상, 일부 레플리카 샤드가 정상적으로 배치되지 않은 상태, 색인 성능에는 이상 없으나 검색 성능에는 영향을 줄 수 있다.
red 일부 프라이머리 샤드와 레플리카 샤드가 정상적으로 배치되지 않은 상태, 색인 성능, 검색 성능 모두에 영향을 주며 문서 유실이 발생한다.

📚 cat nodes

  • http://localhost:9200/_cat/nodes?v
  • http://localhost:9200/_cat/nodes?help
  • 노드들의 전반적인 상태 체크를 확인할 때 사용한다.
    • 노드들의 디스크 사용량 확인
    • 노드들이 명확한 역할을 수행하고 있는지 확인
    • 어떤 노드가 마스터 노드인지 확인
    • 노드들의 메모리 사용량 확인

스크린샷 2025-04-14 오후 5 53 03

스크린샷 2025-04-14 오후 5 54 57

📚 cat indices

  • 인덱스 상태를 확인할 수 있다.
  • http://localhost:9200/_cat/indices?v

스크린샷 2025-04-14 오후 5 57 41

📚 cat shards

  • 샤드 상태를 확인할 수 있다.
  • http://localhost:9200/_cat/shards?v

스크린샷 2025-04-14 오후 5 58 32