metrics 지시문

metrics 지시문 (Prometheus 메트릭 노출)

metrics 지시문은 Prometheus 메트릭 노출 엔드포인트를 설정해서 수집한 메트릭을 스크래핑(수집)할 수 있게 해줘요. 메트릭을 쓰려면 먼저 글로벌 옵션에서 메트릭을 켜야 해요.

출처: Caddy 공식 문서

본문

수집된 메트릭을 스크래핑할 수 있도록 노출해 주는 Prometheus 메트릭 노출 엔드포인트를 설정해요. 메트릭은 먼저 글로벌 옵션에서 켜 두어야 해요.

참고로 /metrics 엔드포인트는 admin API에도 붙어 있는데, 이건 설정할 수 없고 admin API가 비활성화되면 사용할 수 없어요.

이 엔드포인트는 Prometheus exposition format으로 메트릭을 반환하며, 협상(negotiation)되면 OpenMetrics exposition format(application/openmetrics-text)으로 반환해요.

메트릭으로 Caddy 모니터링하기도 함께 살펴봐요.

문법 (Syntax)

metrics [<matcher>] {
	disable_openmetrics
}

• disable_openmetrics는 OpenMetrics 협상을 비활성화해요. 보통 필요 없지만, 파싱 버그를 우회해야 할 때 사용해요.

예시 (Examples)

기본 /metrics 경로에 메트릭을 노출해요:

metrics /metrics

다른 경로에 메트릭을 노출해요:

metrics /foo/bar/baz

별도의 서브도메인에서 메트릭을 제공해요:

metrics.example.com {
	metrics
}

OpenMetrics 협상을 비활성화해요:

metrics /metrics {
	disable_openmetrics
}

더 알아보기 (Learn more)

• Caddy 공식 문서