EIP-2159 공통 프로메테우스 지표 이름 표준 (Common Prometheus Metrics Names for Clients)

최종 확정 · 네트워크·노드 · 원문 상태 Final · 2019-07-01 작성

이더리움 클라이언트들이 프로메테우스로 내보내는 공통 모니터링 지표 4개(체인 높이, 최고 블록 번호, 피어 수, 피어 한도)의 이름과 의미를 표준으로 정합니다.

왜 필요한가

많은 이더리움 클라이언트는 운영자가 노드 상태를 지켜볼 수 있도록 프로메테우스(Prometheus)라는 모니터링 도구와 호환되는 지표를 내보냅니다. 체인이 멈추지는 않았는지, 오류 징후는 없는지 확인하고 경보를 울리는 데 쓰입니다. 그런데 지표 대부분은 클라이언트 내부 구현을 보여 주는 것이라 이름이 제각각이고 모든 클라이언트에 공통으로 적용되는 지표조차 합의된 이름과 의미가 없습니다. 그래서 클라이언트 개발팀마다 이름을 새로 만들었습니다. 서로 다른 클라이언트를 섞어 운영하는 노드 운영자는 하나의 대시보드나 경보 설정으로 전체를 지켜보기 어려웠습니다. 이 EIP는 공통 지표의 이름과 의미를 표준으로 정해, 여러 종류의 노드를 한 화면에서 같은 기준으로 모니터링할 수 있게 합니다.

무엇이 바뀌나

지금

EIP-2159 이후

누구에게 영향이 있나

심층 설명

표준 지표 4종의 정의

명세는 네 가지 지표를 정의하며 메트릭 타입은 모두 Gauge입니다. ethereum_blockchain_height는 카노니컬 체인의 현재 높이로, JSON-RPC의 eth_blockNumber에 해당합니다. ethereum_best_known_block_number는 노드가 알고 있는 가장 높은 블록의 추정값으로, 동기화 중이면 eth_syncing의 highestBlock, 동기화 중이 아니면 eth_blockNumber에 해당합니다. ethereum_peer_count는 현재 연결된 피어 수로 net_peerCount에 해당합니다. ethereum_peer_limit은 이 노드가 연결을 허용하는 최대 피어 수이며, 대응하는 JSON-RPC 메서드가 없습니다.

이름 공간 규칙과 값 보장

클라이언트는 표에 정의된 것 외에 추가 지표를 노출할 수 있지만 추가 지표에는 ethereum_ 접두사를 쓰지 않아야 합니다. 표준 이름 공간을 공통 지표만을 위해 남겨 두는 규칙입니다. 또 ethereum_best_known_block_number에는 항상 값이 있습니다. JSON-RPC의 eth_syncing 메서드가 false를 반환할 상황, 즉 동기화 중이 아닐 때는 현재 체인 높이를 그 값으로 씁니다. 따라서 이 지표가 비어 있는 경우는 없습니다.

설계 근거

정의된 지표는 특정 이더리움 클라이언트 구현에 묶이지 않으면서도 이더리움 노드 그룹을 모니터링하는 개요 대시보드를 만들기에 충분한 정보를 제공하도록 골랐습니다. 비콘 체인 클라이언트 지표에는 이와 비슷하지만 더 규범적인 별도 명세가 있습니다. 지표를 어떤 방식으로 노출할지는 표준화하지 않았습니다. 기존 구현마다 방식이 달라서 이를 통일해도 의미 있는 이득이 없다고 봤기 때문입니다.

하위 호환성

이 제안은 합의에 영향을 주는 변경이 아닙니다. 다만 이미 같은 지표를 다른 이름으로 내보내던 클라이언트가 새 이름으로 바꾸면 기존 경보나 대시보드가 깨질 수 있습니다. 이를 피하려는 클라이언트는 옛 이름과 새 이름 양쪽으로 지표를 노출할 수 있습니다. 반대로 이 표준과 같은 이름을 이미 다른 의미로 쓰고 있던 클라이언트의 경우에는 하위 호환성을 지킬 방법이 없습니다.

구현 사례와 상태

Pantheon 클라이언트가 1.2 릴리스에서 이 표준 지표 이름으로 전환했습니다. 이 EIP는 Interface 카테고리의 표준 트랙 제안으로 상태는 Final입니다. 합의 규칙이 아니라 클라이언트가 외부에 내보내는 모니터링 인터페이스를 다룹니다. 명세도 지표를 노출하는 클라이언트가 이 이름들을 쓸 수 있다는 형태로 쓰여 있어, 실제 채택은 각 클라이언트 팀의 구현에 달려 있습니다.

EIP 원문 · ← EIPs