6 minutos de leitura

Visão geral

O Prometheus Exporter da Quicknode permite-lhe transmitir métricas da plataforma e da infraestrutura para a sua pilha de observabilidade existente, para monitorização em tempo real do estado do sistema.

Neste guia, vamos explicar-lhe como tirar partido do suporte ao Prometheus da API de administração do Quicknode para criar um painel do Grafana destinado à visualização avançada de métricas, com o objetivo de monitorizar os seus endpoints do Quicknode.

Retenção de registos

A Quicknode também oferece uma retenção de registos de 14 dias, tanto para a plataforma como para a infraestrutura, nos planos Enterprise. Para mais informações, consulte a nossa página de preços.

O que irá fazer

• Configure um exportador do Prometheus e crie um painel do Grafana para monitorizar a sua infraestrutura RPC

O que vai precisar

• Uma conta Quicknode com um plano Enterprise
• O Docker Desktop está instalado e a funcionar no seu computador
• Conhecimentos básicos sobre o Prometheus e o Grafana (Iremos orientá-lo em cada passo)

O exportador Prometheus só está disponível para os nossos clientes Enterprise. Se estiver interessado, entre em contacto connosco.

Introdução à API de administração do Quicknode

A API de administração do Quicknode oferece um acesso programático avançado a todas as ações disponíveis no Painel do Utilizador, permitindo-lhe gerir a sua infraestrutura, monitorizar o desempenho e controlar os seus custos de forma mais eficaz. Neste guia, iremos centrar-nos especificamente na utilização do Prometheus Exporter para aceder a métricas detalhadas do sistema e criar um painel de monitorização abrangente com o Grafana.

Se estiver interessado em saber como utilizar a API de administração para a gestão de pontos de extremidade, consulte o nosso guia: Como gerir a sua infraestrutura RPC com a API de administração do Quicknode.

Pré-requisitos

Conta Quicknode e chave API

Criar a sua chave API é muito simples.

1. Inicie sessão na sua conta Quicknode.
2. Clique no ícone do avatar no canto superior esquerdo e selecione «Chaves API» para aceder à página «Chaves API».
3. Crie uma chave de API com as permissões adequadas (vais precisar de CONSOLE_REST para utilizar a API de administração) e mantém-no à mão, pois vais precisar dele daqui a pouco.

Docker Desktop

Certifique-se de que tem o Docker Desktop instalado e em execução. Vamos utilizar o Docker para iniciar rapidamente o Prometheus e o Grafana.

Criação de um painel do Grafana com o Prometheus Exporter

Nesta secção, vamos orientá-lo na configuração do Prometheus e do Grafana utilizando o Docker para monitorizar as suas métricas do Quicknode. Uma vez que vamos utilizar o Docker, não é necessário instalar o Prometheus e o Grafana separadamente.

informações

Prometheus: Um sistema de monitorização de código aberto que recolhe e armazena métricas sob a forma de dados de séries temporais, permitindo-lhe acompanhar e analisar várias métricas de desempenho ao longo do tempo.

Grafana: Uma poderosa ferramenta de análise e visualização de código aberto que permite criar painéis dinâmicos e interativos para visualizar métricas provenientes de fontes de dados como o Prometheus.

Docker: Uma plataforma para desenvolver, distribuir e executar aplicações em contentores. Nesta configuração, vamos utilizar o Docker para executar o Prometheus e o Grafana em contentores isolados, simplificando o processo de instalação e configuração.

Criámos uma pasta no repositório «qn-guide-examples» do Quicknode, que contém todos os ficheiros de configuração necessários para o Prometheus e o Grafana.

Estrutura do projeto

.
├── docker-compose.yaml                     # Docker Compose file to launch Prometheus and Grafana
├── grafana
│   ├── dashboards                          
│   │   │   └── Quicknode Admin API.json  # Grafana dashboard JSON file
│   ├── provisioning
│   │   ├── dashboards
│   │   │   └── main.yaml                   # Configuration for loading dashboards into Grafana
│   │   └── datasources
│   │       └── prometheus-source.yaml      # Configuration for connecting Grafana to Prometheus
├── prometheus
│   └── prometheus.yaml                     # Prometheus configuration file

Siga estes passos para começar:

Passo 1: Clonar o repositório do projeto de exemplo

Abra o terminal/linha de comandos e clone o repositório:

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

Aceda à grafana-painel pasta dentro do repositório clonado:

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

Passo 2: Atualizar a sua chave API

Abrir o prometheus.yaml ficheiro localizado no Prometeu diretório.

Substituir <YOUR_API_KEY> com a sua chave de API do Quicknode que gerou anteriormente:

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"]

informações

Nota: Se estiver a utilizar Prometheus 3.x, poderá ser necessário adicionar o protocolo_de_reserva_de_extracção campo para o scrape_configs secção. Para tal, basta remover o comentário da linha destacada no exemplo acima.

Passo 3: Iniciar o Prometheus e o Grafana com o Docker

Já pré-configurámos um docker-compose.yaml ficheiro para simplificar a configuração. Pode iniciar tanto o Prometheus como o Grafana executando o comando abaixo a partir do diretório raiz (ou seja, grafana-painel):

docker-compose up

Adicionar -d opção para iniciar os serviços em modo independente, executando-os em segundo plano.

Passo 4: Aceda ao Grafana e visualize o seu painel

1. Abra um navegador da Web e aceda a http://localhost:3000.
2. Inicie sessão com as credenciais do projeto (nome de utilizador: admin, palavra-passe: palavra-passe) (conforme determinado no docker-compose.yaml ficheiro)
3. Aceda a Painéis.
4. Procure e clique no painel de controlo da API de administração do Quicknode.

Deve agora ver o painel a apresentar as métricas do seu ponto de extremidade Quicknode.

Nota: Se o painel de controlo aparecer vazio, significa que ainda não houve qualquer atividade no seu ponto de extremidade. Certifique-se de que realiza alguma atividade (por exemplo, enviar pedidos RPC para o seu ponto de extremidade) para começar a gerar dados que serão refletidos no painel de controlo.

O painel de controlo disponibiliza os seguintes painéis para o ajudar a monitorizar a sua infraestrutura Quicknode:

• Pedidos RPC do Quicknode (Indicador): Apresenta o número total atual de pedidos RPC efetuados ao seu ponto de extremidade do Quicknode.
• Créditos RPC do Quicknode (Indicador): Mostra o total de créditos utilizados pelo seu ponto de extremidade do Quicknode.
• Total de pedidos RPC do Quicknode nos últimos 30 dias: Um gráfico de série temporal que mostra o total de pedidos RPC nos últimos 30 dias.
• Créditos RPC do Quicknode – Total dos últimos 30 dias: Um gráfico de série temporal que mostra a utilização total de créditos nos últimos 30 dias.
• Estado da resposta do ponto de extremidade Quicknode: Apresenta o estado da resposta (por exemplo, 200, 400, etc.) dos pedidos enviados ao seu ponto de extremidade Quicknode.
• Tempo máximo de resposta do ponto de extremidade do Quicknode: Mostra o tempo máximo de resposta do seu ponto de extremidade.

Sinta-se à vontade para personalizar o painel, editando os painéis, adicionando novos ou ajustando o intervalo de tempo de acordo com as suas necessidades.

Explorar diretamente as métricas do Prometheus

Se quiser explorar diretamente as métricas recolhidas pelo Prometheus, pode seguir estes passos:

• Abra um navegador da Web e aceda a http://localhost:9090
• Aceda a «Status > Targets» na interface do Prometheus para confirmar se o alvo Quicknode consta da lista e se se encontra no estado «UP».
• Verifique os principais indicadores que o Quicknode disponibiliza:
  • Aceda ao separador «Gráfico ».
  • Na caixa de expressão, introduza uma a uma estas métricas e clique em Executar:
    • quicknode_rpc_credits
    • quicknode_rpc_requests
    • quicknode_rpc_response_status
    • quicknode_rpc_response_time_max
  • Isto permitir-lhe-á visualizar os dados brutos que estão a ser recolhidos, quer sob a forma de gráfico, quer em tabela.

Quando terminar, pode parar os serviços executando o seguinte comando:

docker-compose down

Conclusão

Parabéns! 🎉 Conseguiu ligar-se com sucesso ao Quicknode Prometheus Exporter para recolher métricas avançadas da sua infraestrutura RPC e criou um painel do Grafana para monitorizar o estado do seu sistema. Esta configuração proporciona-lhe informações valiosas em tempo real sobre a sua infraestrutura RPC, permitindo-lhe otimizar o desempenho e manter a visibilidade.

Se tiveres dúvidas, ideias ou sugestões, contacta-nos diretamente. Além disso, mantém-te a par das últimas novidades seguindo-nos no X e juntando-te ao nosso canal de anúncios no Discord e no Telegram.

Adoramos ❤️ os vossos comentários!

Diz-nos se tiveres algum comentário ou sugestão de novos temas. Adoraríamos saber a tua opinião.

Recursos adicionais

• Documentação da API de administração do Quicknode
• API de administração do Quicknode – Swagger
• Guia: Como gerir a sua infraestrutura RPC com a API de administração do Quicknode