관리 API

관리 API (Management API)

프로메테우스 서버에는 관리 작업을 위한 HTTP 엔드포인트 집합이 있어요. 이것들은 예전에 "admin API"로 불렸으며, 이제 /api/*/admin/ 경로 아래에 있어요. 이 문서는 관리 API의 개요와 각 엔드포인트를 설명해 드려요.

보안상의 이유로 이 API는 기본적으로 비활성화돼 있고, --web.enable-admin-api 플래그로 활성화할 수 있어요. 트러블슈팅/관리에는 유용하지만, 자동화에서 일반적으로 사용할 만한 것은 아니에요. 읽기/쓰기 작업에는 일반 Prometheus HTTP API를 권장해요.

출처: 문서

본문

개요 (Overview)

관리 HTTP API는 관리 작업을 위해 설계된 Prometheus 서버에서 사용할 수 있는 HTTP 엔드포인트 집합이에요. 이 엔드포인트들은 예전에 "admin API"로 알려졌으며, 이제 /api/*/admin/ 경로 아래에 있어요.

보안상의 이유로 API는 기본적으로 비활성화돼 있고 --web.enable-admin-api 플래그로 활성화할 수 있어요. 이 API를 트러블슈팅/관리에 유용한 것으로 보되, 자동화에서 일반적으로 사용할 만한 것은 아니라고 생각하세요.

읽기/쓰기 작업에는 Prometheus HTTP API를 사용하는 것을 권장해요.

엔드포인트 (Endpoints)

/api/*/admin/tsdb/delete_series

이 엔드포인트는 특정 타임시리즈의 모든 데이터를 삭제해요.

  • HTTP 메서드: POST
  • 콘텐츠 타입: application/x-www-form-urlencoded

curl 사용:

curl -X POST http://localhost:9090/api/v1/admin/tsdb/delete_series \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'match[]=up{job="prometheus"}' \
    --data-urlencode 'start=2023-06-18T20:10:30.781Z' \
    --data-urlencode 'end=2023-06-18T20:23:00.000Z'

/api/*/admin/tsdb/clean_tombstones

이 엔드포인트는 현재 인스턴스의 툼스톤(tombstones)을 정리해요. delete_series로 삭제 표시된 시리즈 데이터나 오래된 데이터를 삭제해요.

  • HTTP 메서드: POST
  • 콘텐츠 타입: application/x-www-form-urlencoded

curl 사용:

curl -X POST http://localhost:9090/api/v1/admin/tsdb/clean_tombstones

/api/*/admin/tsdb/snapshot

이 엔드포인트는 현재 데이터베이스의 스냅샷을 만들어요.

  • HTTP 메서드: POST
  • 콘텐츠 타입: application/x-www-form-urlencoded

curl 사용:

curl -X POST http://localhost:9090/api/v1/admin/tsdb/snapshot

더 알아보기 (Learn more)