읽는 데 6분

개요

Quicknode의 Prometheus Exporter를 사용하면 플랫폼 및 인프라 메트릭을 기존 가시성 스택으로 스트리밍하여 시스템 상태를 실시간으로 모니터링할 수 있습니다.

이 가이드에서는 Quicknode Admin API의 Prometheus 지원 기능을 활용하여 Quicknode 엔드포인트를 모니터링하기 위한 고급 메트릭 시각화용 Grafana 대시보드를 구축하는 방법을 단계별로 안내해 드리겠습니다.

로그 보존 기간

또한 Quicknode는 엔터프라이즈 요금제 이용 고객에게 플랫폼 및 인프라 모두에 대해 14일간의 로그 보존 서비스를 제공합니다. 자세한 내용은 요금제 페이지를 참조해 주시기 바랍니다.

주요 업무

• Prometheus 익스포터를 설정하고 RPC 인프라를 모니터링할 Grafana 대시보드를 구축하세요

준비물

• 엔터프라이즈 요금제가 적용된 Quicknode 계정
• 컴퓨터에 Docker Desktop이 설치되어 실행 중입니다.
• Prometheus 및 Grafana에 대한 기초 지식 (각 단계별로 안내해 드리겠습니다)

프로메테우스 익스포터는 엔터프라이즈 고객만 이용하실 수 있습니다. 관심이 있으시면 당사로 문의해 주시기 바랍니다.

Quicknode 관리자 API 소개

Quicknode 관리자 API는 사용자 대시보드에서 사용할 수 있는 모든 기능에 대한 강력한 프로그래밍 방식의 접근 기능을 제공하여, 인프라를 관리하고, 성능을 모니터링하며, 비용을 보다 효과적으로 통제할 수 있도록 지원합니다. 이 가이드에서는 특히 Prometheus 익스포터를 사용하여 상세한 시스템 메트릭에 접근하고, Grafana를 통해 포괄적인 모니터링 대시보드를 구축하는 방법에 중점을 둘 것입니다.

엔드포인트 관리를 위해 Admin API를 사용하는 방법에 대해 알고 싶으시다면, 당사의 가이드인 ‘Quicknode Admin API를 활용한 RPC 인프라 관리 방법’을 확인해 보세요.

필수 조건

Quicknode 계정 및 API 키

API 키를 생성하는 방법은 매우 간단합니다.

1. Quicknode 계정에 로그인하세요.
2. 왼쪽 상단의 아바타 아이콘을 클릭한 다음, ‘API 키’를 선택하여 API 키 페이지로 이동하세요.
3. 적절한 권한이 부여된 API 키를 생성합니다 (다음이 필요합니다 CONSOLE_REST Admin API를 사용하려면) 그리고 곧 필요하게 될 테니 가까이에 두세요.

Docker Desktop

다음이 설치되어 있는지 확인하십시오. Docker Desktop이 이 설치되어 있고 실행 중인지 확인하십시오. Docker를 사용하여 Prometheus와 Grafana를 빠르게 실행할 것입니다.

Prometheus 익스포터를 사용하여 Grafana 대시보드 구축하기

이 섹션에서는 Docker를 사용하여 Quicknode 메트릭을 모니터링하기 위해 Prometheus와 Grafana를 설정하는 방법을 안내해 드리겠습니다. Docker를 사용할 예정이므로, Prometheus와 Grafana를 별도로 설치할 필요는 없습니다.

정보

프로메테우스: 메트릭을 시계열 데이터로 수집 및 저장하는 오픈소스 모니터링 시스템으로, 시간 경과에 따른 다양한 성능 지표를 추적하고 분석할 수 있게 해줍니다.

Grafana: Prometheus와 같은 데이터 소스의 메트릭을 시각화하기 위해 동적이고 상호작용이 가능한 대시보드를 생성할 수 있는 강력한 오픈소스 분석 및 시각화 도구입니다.

Docker: 컨테이너 내에서 애플리케이션을 개발, 배포 및 실행하기 위한 플랫폼입니다. 이번 설정에서는 Docker를 사용하여 Prometheus와 Grafana를 서로 분리된 컨테이너에서 실행함으로써, 설치 및 구성 과정을 간소화할 것입니다.

Quicknode의 qn-guide-examples 저장소에 폴더를 생성했으며, 이 폴더에는 Prometheus와 Grafana에 필요한 모든 구성 파일이 포함되어 있습니다.

프로젝트 구조

.
├── docker-compose.yaml                     # Prometheus와 Grafana를 실행하기 위한 Docker Compose 파일
├── grafana
│   ├── dashboards                          
│   │   │   └── Quicknode Admin API.json  # Grafana 대시보드 JSON 파일
│   ├── provisioning
│   │   ├── 대시보드
│   │   │   └── main.yaml                   # Grafana에 대시보드를 불러오기 위한 구성
│   │   └── 데이터 소스
│   │       └── prometheus-source.yaml      # Grafana를 Prometheus에 연결하기 위한 구성
├── prometheus
│   └── prometheus.yaml                     # Prometheus 구성 파일

시작하려면 다음 단계를 따르세요:

1단계: 샘플 프로젝트 저장소를 복제하기

터미널/명령 프롬프트를 열고 저장소를 복제하세요:

git https://github.com/quiknode-labs/qn-guide-examples.git 복제

다음으로 이동하십시오. grafana-dashboard 복제된 저장소 내의 폴더:

cd qn-guide-examples/admin-api/grafana-dashboard

2단계: API 키 업데이트하기

다음 파일을 엽니다. prometheus.yaml 다음 위치에 있는 파일: 프로메테우스 디렉터리.

바꾸기 <YOUR_API_KEY> 앞서 생성한 실제 Quicknode API 키를 다음과 같이 입력하세요:

prometheus/prometheus.yaml

global:
  scrape_interval: 30s

scrape_configs:
  - job_name: "quicknode_prometheus_exporter"
    metrics_path: "v0/prometheus/metrics"
    scheme: "https"
    authorization:
      type: "bearer"
      credentials: "<API_KEY>"
    # fallback_scrape_protocol: PrometheusText0.0.4
    static_configs:
      - targets: ["api.quicknode.com"]

정보

참고: 만약 다음을 사용하고 있다면 프로메테우스 3.x, 다음을 추가해야 할 수도 있습니다. fallback_scrape_protocol 필드를 scrape_configs 섹션. 이를 위해서는 위 예시에서 강조 표시된 줄의 주석 처리를 해제하기만 하면 됩니다.

3단계: Docker를 사용하여 Prometheus와 Grafana 실행하기

저희는 미리 설정해 둔 docker-compose.yaml 설정을 간편하게 하기 위한 파일입니다. 루트 디렉터리에서 아래 명령어를 실행하면 Prometheus와 Grafana를 모두 실행할 수 있습니다(예: grafana-dashboard):

docker-compose up

추가 -d 서비스를 분리된 모드로 시작하여 백그라운드에서 실행하도록 하는 플래그.

4단계: Grafana에 접속하여 대시보드를 확인하세요

1. 웹 브라우저를 열고 다음 주소로 이동하세요. http://localhost:3000.
2. 프로젝트 인증 정보로 로그인하세요 (사용자 이름: 관리자, 비밀번호: 비밀번호) (에서 정한 바에 따라 docker-compose.yaml (파일)
3. 다음으로 이동하세요 대시보드.
4. Quicknode Admin API 대시보드를 찾아 클릭하세요.

이제 Quicknode 엔드포인트의 메트릭이 표시된 대시보드가 보일 것입니다.

참고: 대시보드가 비어 있다면, 해당 엔드포인트에서 아직 아무런 활동이 발생하지 않았음을 의미합니다. 대시보드에 반영될 데이터가 생성되기 시작하도록, 엔드포인트에 RPC 요청을 보내는 등의 활동을 수행해 주세요.

대시보드에는 Quicknode 인프라를 모니터링하는 데 도움이 되는 다음과 같은 패널이 제공됩니다:

• Quicknode RPC 요청 (게이지): Quicknode 엔드포인트로 전송된 현재 RPC 요청의 총 개수를 표시합니다.
• Quicknode RPC 크레딧 (게이지): Quicknode 엔드포인트에서 사용한 총 크레딧을 표시합니다.
• 지난 30일 동안의 Quicknode RPC 요청 총계: 지난 30일 동안의 RPC 요청 총계를 보여주는 시계열 차트입니다.
• Quicknode RPC 크레딧 지난 30일 누적: 지난 30일 동안의 총 크레딧 사용량을 보여주는 시계열 차트입니다.
• Quicknode 엔드포인트 응답 상태: Quicknode 엔드포인트 요청의 응답 상태(예: 200, 400 등)를 표시합니다.
• Quicknode 엔드포인트 최대 응답 시간: 엔드포인트의 최대 응답 시간을 표시합니다.

필요에 따라 패널을 편집하거나, 새로운 패널을 추가하거나, 시간 범위를 조정하여 대시보드를 자유롭게 맞춤 설정해 보세요.

프로메테우스 메트릭스 직접 살펴보기

Prometheus에서 수집한 메트릭을 직접 확인해 보고 싶다면 다음 단계를 따르세요:

• 웹 브라우저를 열고 다음 주소로 이동하세요. http://localhost:9090
• Prometheus 인터페이스에서 [Status] > [Targets] 로 이동하여 Quicknode 타겟이 목록에 표시되어 있고 상태가 UP인지 확인하십시오.
• Quicknode가 제공하는 주요 지표를 확인해 보세요:
  • '그래프' 탭으로 이동합니다.
  • 입력란에 다음 지표 중 하나를 하나씩 입력한 다음 클릭하세요. 실행:
    • quicknode_rpc_크레딧
    • quicknode_rpc_요청
    • quicknode_rpc_응답_상태
    • quicknode_rpc_응답_시간_최대
  • 이를 통해 수집된 원시 데이터를 그래프나 표 형태로 확인할 수 있습니다.

작업이 끝나면 다음 명령을 실행하여 서비스를 중지할 수 있습니다:

docker-compose 중지

결론

축하합니다! 🎉 Quicknode Prometheus Exporter에 성공적으로 연결하여 RPC 인프라에서 고급 메트릭을 가져오고, 시스템 상태를 모니터링할 수 있는 Grafana 대시보드를 구축하셨습니다. 이 설정을 통해 RPC 인프라에 대한 귀중한 실시간 인사이트를 확보할 수 있어, 성능을 최적화하고 시스템 상태를 지속적으로 파악할 수 있습니다.

궁금한 점이나 아이디어, 제안 사항이 있으시면 저희에게 직접 문의해 주시기 바랍니다. 또한, X에서 저희를 팔로우하고 디스코드 및 텔레그램 공지 채널에 가입하여 최신 소식을 놓치지 마세요.

여러분의 피드백을 ❤️ 환영합니다!

의견이나 다루었으면 하는 새로운 주제가 있다면 알려주세요. 여러분의 의견을 기다리고 있습니다.

추가 자료

• Quicknode 관리자 API 문서
• Quicknode 관리자 API Swagger
• 가이드: Quicknode Admin API를 사용하여 RPC 인프라를 관리하는 방법