#Configurando o Dashboard do Grafana

Agora que você tem seu nó funcionando, você provavelmente vai querer ter uma maneira conveniente de monitorar tudo sobre ele rapidamente para garantir que está funcionando corretamente (e que tipo de ganhos está gerando para você).

Existem muitas ferramentas por aí que fazem esse trabalho. Uma das mais populares é chamada Grafana - um sistema de dashboard de uso geral e fácil de usar que você pode acessar com um navegador.

Rocket Pool vem pronto para uso com suporte para Grafana e suas dependências; ele ainda vem com um dashboard pré-construído para cada um dos clientes de Consenso. Por exemplo, aqui está uma imagem do que o dashboard parece na rede de teste Hoodi:

O dashboard padrão inclui as seguintes informações, tudo em um formato conveniente:

• Superior esquerdo: algumas estatísticas importantes sobre a saúde e desempenho da sua máquina, e quaisquer atualizações de sistema pendentes
• Superior direito: a atividade e desempenho dos seus validadores na Beacon Chain, juntamente com algumas estatísticas do cliente de Execução e Consenso
• Inferior esquerdo: detalhes sobre toda a rede Rocket Pool, para referência
• Inferior direito: detalhes sobre suas recompensas de staking, tanto ETH quanto RPL

Neste guia, vamos mostrar como habilitar o sistema de métricas do Rocket Pool para que você possa usar este dashboard - ou até construir o seu próprio!

#Visão Geral da Pilha de Métricas do Rocket Pool

Se você optar por habilitar métricas durante o processo de configuração do Smartnode, seu nó adicionará os seguintes processos:

• Prometheus - um sistema de coleta, armazenamento e relatório de dados que captura todas as métricas que você vê acima (e muitas mais) e as armazena, para que possam ser consultadas ao longo do tempo
• O Node Exporter do Prometheus - um serviço que coleta informações sobre a saúde da sua máquina (como uso de CPU, uso de RAM, espaço livre em disco e espaço de swap, etc.) e relata para o Prometheus
• Grafana, a ferramenta que expõe os dados do Prometheus através de um site conveniente hospedado no seu nó
• Um conjunto opcional de scripts personalizados que relatará quaisquer atualizações de Sistema Operacional disponíveis ao Prometheus, para que você saiba se seu sistema precisa ser atualizado

A configuração padrão criará contêineres Docker com todos esses serviços que vivem ao lado dos outros contêineres Docker do Smartnode. Ela abrirá uma porta na sua máquina de nó para Grafana, para que você possa acessar seu dashboard de qualquer máquina na sua rede local com um navegador.

#Habilitando o Servidor de Métricas

rocketpool service config

rocketpool service install-update-tracker

docker restart rocketpool_exporter

--metrics --metrics.addr 0.0.0.0 --metrics.port 9105

--Metrics.Enabled true --Metrics.ExposePort 9105

--metrics-enabled --metrics-host=0.0.0.0 --metrics-port=9105

--metrics --metrics-address 0.0.0.0 --metrics-port 9100 --validator-monitor-auto

--metrics --metrics.address 0.0.0.0 --metrics.port 9100

--metrics --metrics-address=0.0.0.0 --metrics-port=9100

--monitoring-host 0.0.0.0 --monitoring-port 9100

--metrics-enabled=true --metrics-interface=0.0.0.0 --metrics-port=9100 --metrics-host-allowlist=*

wget https://github.com/prometheus/prometheus/releases/download/v2.45.3/prometheus-2.45.3.linux-amd64.tar.gz
wget https://github.com/prometheus/node_exporter/releases/download/v1.7.0/node_exporter-1.7.0.linux-amd64.tar.gz
wget https://github.com/prometheus/alertmanager/releases/download/v0.26.0/alertmanager-0.26.0.linux-amd64.tar.gz

sudo tar -zxvf prometheus-2.45.3.linux-amd64.tar.gz -C /usr/local/bin --wildcards '*/prometheus' --strip-components=1
sudo tar -zxvf node_exporter-1.7.0.linux-amd64.tar.gz -C /usr/local/bin --wildcards '*/node_exporter' --strip-components=1
sudo tar -zxvf alertmanager-0.26.0.linux-amd64.tar.gz -C /usr/local/bin --wildcards '*/alertmanager' --strip-components=1

sudo mkdir /etc/prometheus
sudo mkdir /etc/alertmanager
sudo mkdir /var/lib/prometheus
sudo mkdir /var/lib/alertmanager

global:
scrape_interval: 15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
scrape_timeout: 12s # Timeout must be shorter than the interval
evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.

scrape_configs:
- job_name: "prometheus"
static_configs:
- targets: ["localhost:9091"]

- job_name: "node"
static_configs:
- targets: ["localhost:9103"]
#     - targets: ['localhost:9103', 'node_hostname:9103']
- job_name: "eth1"
static_configs:
- targets: ["localhost:9105"]
# Uncomment the line below if you are using geth as Execution Client
#metrics_path: /debug/metrics/prometheus

- job_name: "eth2"
static_configs:
- targets: ["localhost:9100"]

- job_name: "validator"
static_configs:
- targets: ["validator:9101"]

- job_name: "rocketpool"
scrape_interval: 5m
scrape_timeout: 5m
static_configs:
- targets: ["node:9102"]

- job_name: "watchtower"
scrape_interval: 5m
scrape_timeout: 5m
static_configs:
- targets: ["watchtower:9104"]

alerting:
alertmanagers:
- static_configs:
- targets: ["localhost:9093"]

global:
# ResolveTimeout is the default value used by alertmanager if the alert does
# not include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated.
# This has no impact on alerts from Prometheus, as they always include EndsAt.
# default = 5m
resolve_timeout: 5m

route:
# The labels by which incoming alerts are grouped together.
group_by: ["alertname"]
# How long to initially wait to send a notification for a group
# of alerts. Allows to wait for an inhibiting alert to arrive or collect
# more initial alerts for the same group.
group_wait: 30s
# How long to wait before sending a notification about new alerts that
# are added to a group of alerts for which an initial notification has
# already been sent. (Usually ~5m or more.)
group_interval: 5m
# How long to wait before sending a notification again if it has already been sent successfully for an alert.
repeat_interval: 4h
routes:
# severity=info: Don't send the follow-up resolved notification.
- match:
severity: info
continue: false
# The notification destination
receiver: "node_operator_no_resolved"
# all other alerts get sent notifications for the initial firing _and_ resolved notifications.
- receiver: "node_operator_default"
#match: We want this to match all alerts (severity=info is first though so it will stop)

# The notification destination
receiver: "node_operator_default"

receivers:
- name: "node_operator_default"
discord_configs:
- webhook_url: "https://discord.com/api/webhooks/1206697259694170212/_Pk1eVVgXFLdwU1k0rfwehSvNLiAQJytVV_Ze8QYOhupHnhiB5c8awPBTfuw41lN9GJk"

- name: "node_operator_no_resolved"
discord_configs:
- webhook_url: "https://discord.com/api/webhooks/1206697259694170212/_Pk1eVVgXFLdwU1k0rfwehSvNLiAQJytVV_Ze8QYOhupHnhiB5c8awPBTfuw41lN9GJk"
send_resolved: false

inhibit_rules:
# Inhibit rules mute a new alert (target) that matches an existing alert (source).
- source_match:
# if the existing alert (source) is severity=critical
severity: "critical"
target_match:
# and the new alert (target) is severity=warning
severity: "warning"
# and the alertname, job, and instance labels have the same value
equal: ["alertname", "job", "instance"]

sudo useradd -r -s /sbin/nologin prometheus
sudo useradd -r -s /sbin/nologin alertmanager

sudo chown prometheus:prometheus /usr/local/bin/prometheus
sudo chown alertmanager:alertmanager /usr/local/bin/alertmanager
sudo chown prometheus:prometheus /usr/local/bin/node_exporter
sudo chown -R prometheus:prometheus /etc/prometheus
sudo chown -R alertmanager:alertmanager /etc/alertmanager
sudo chown -R prometheus:prometheus /var/lib/prometheus
sudo chown -R alertmanager:alertmanager /var/lib/alertmanager
sudo chmod u+sx,g+sx,o-wx /usr/local/bin/prometheus
sudo chmod u+sx,g+sx,o-wx /usr/local/bin/alertmanager
sudo chmod u+sx,g+sx,o-wx /usr/local/bin/node_exporter

[Unit]
Description=Node metrics exporter for Prometheus
Documentation=https://prometheus.io/docs/introduction/overview
Wants=network-online.target
After=network-online.target

[Service]
User=prometheus
Group=prometheus
Type=simple
Restart=on-failure
WorkingDirectory=/var/lib/prometheus
RuntimeDirectory=node-exporter
RuntimeDirectoryMode=0750
ExecStart=/usr/local/bin/node_exporter --web.listen-address=:9103

[Install]
WantedBy=multi-user.target

[Unit]
Description=Prometheus instance
Documentation=https://prometheus.io/docs/introduction/overview
Wants=network-online.target
After=network-online.target

[Service]
User=prometheus
Group=prometheus
Type=simple
Restart=on-failure
WorkingDirectory=/var/lib/prometheus
RuntimeDirectory=prometheus
RuntimeDirectoryMode=0750
ExecStart=/usr/local/bin/prometheus --config.file /etc/prometheus/prometheus.yml --web.listen-address=:9091

[Install]
WantedBy=multi-user.target

[Unit]
Description=Alertmanager instance
Documentation=https://prometheus.io/docs/alerting/latest/alertmanager/
Wants=network-online.target
After=network-online.target

[Service]
User=alertmanager
Group=alertmanager
Type=simple
Restart=on-failure
WorkingDirectory=/var/lib/alertmanager
RuntimeDirectory=alertmanager
RuntimeDirectoryMode=0750
ExecStart=/usr/local/bin/alertmanager --config.file /etc/alertmanager/alertmanager.yml --web.listen-address=:9093

[Install]
WantedBy=multi-user.target

sudo systemctl daemon-reload

sudo systemctl enable node-exporter
sudo systemctl start node-exporter

sudo systemctl status node-exporter

sudo systemctl enable prometheus
sudo systemctl start prometheus

sudo systemctl enable alertmanager
sudo systemctl start alertmanager

sudo systemctl status prometheus
sudo systemctl status alertmanager

sudo apt-get update
sudo apt-get install -y apt-transport-https software-properties-common
sudo mkdir -p /etc/apt/keyrings/
wget -q -O - https://apt.grafana.com/gpg.key | gpg --dearmor | sudo tee /etc/apt/keyrings/grafana.gpg > /dev/null
echo "deb [signed-by=/etc/apt/keyrings/grafana.gpg] https://apt.grafana.com stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list

sudo apt-get update
sudo apt-get install grafana

apiVersion: 1

deleteDatasources:
- name: Prometheus
orgId: 1

datasources:
- name: Prometheus
type: prometheus
access: proxy
orgId: 1
url: http://localhost:9091
basicAuth: false
isDefault: true
version: 1
editable: true

sudo systemctl daemon-reload
sudo systemctl enable grafana-server
sudo systemctl start grafana-server

sudo systemctl status grafana-server

#Configure o firewall para permitir conexões para monitoramento

RP_NET=$(docker inspect rocketpool_net | grep -Po "(?<=\"Subnet\": \")[0-9./]+")
sudo ufw allow from $RP_NET to any port 9105 comment "Allow Prometheus access to Execution Client"
sudo ufw allow from $RP_NET to any port 9100 comment "Allow Prometheus access to Consensus Client"
sudo ufw allow from $RP_NET to any port 9103 comment "Allow Prometheus access to Exporter"

sudo ufw allow from 192.168.1.6 to any port 9100:9105 proto tcp comment 'Allow Prometheus host to scrape metrics of this host'

sudo ufw allow out from any to 192.168.1.5 port 9100:9105 proto tcp comment 'Allow this host to scrape node metrics'

Você pode então abrir o firewall para permitir que dispositivos externos acessem seu dashboard do Grafana.

# This assumes your local IP structure is 192.168.1.xxx
sudo ufw allow from 192.168.1.0/24 proto tcp to any port 3100 comment 'Allow grafana from local network'

# To allow any devices in the broader subnet
# for example allowing 192.168.2.20 to access
# grafana on 192.168.1.20
sudo ufw allow from 192.168.1.0/16 proto tcp to any port 3100 comment 'Allow grafana from local subnets'

# Allow any IP to connect to Grafana
sudo ufw allow 3100/tcp comment 'Allow grafana from anywhere'

#Configurando o Grafana

Agora que o servidor de métricas está pronto, você pode acessá-lo com qualquer navegador na sua rede local.

Consulte as abas abaixo para o seu modo de instalação do Smartnode.

Navegue para a seguinte URL, substituindo as variáveis pela sua configuração conforme necessário:

http://<your node IP>:<grafana port>

Por exemplo, se o IP do seu nó fosse 192.168.1.5 e você usasse a porta padrão do Grafana de 3100, então você iria para esta URL no seu navegador:

http://192.168.1.5:3100

Você verá uma tela de login assim:

As informações padrão do Grafana são:

Username: admin
Password: admin

Você será então solicitado a alterar a senha padrão da conta admin. Escolha algo forte e não esqueça!

docker exec -it rocketpool_grafana grafana-cli admin reset-admin-password admin

sudo grafana-cli admin reset-admin-password admin

Graças ao trabalho do membro da comunidade tedsteen, o Grafana se conectará automaticamente à sua instância do Prometheus para que tenha acesso às métricas que coleta. Tudo que você precisa fazer é obter o dashboard!

#Importando o Dashboard do Rocket Pool

Agora que você tem o Grafana anexado ao Prometheus, você pode importar o dashboard padrão (ou construir o seu próprio usando as métricas que ele fornece, se você estiver familiarizado com esse processo).

Comece indo para o menu Create (o ícone de mais na barra lateral direita) e clique em Import:

Quando solicitado para o ID do dashboard na caixa Import via grafana.com, digite 21863 ou use a URL completa ((https://grafana.com/grafana/dashboards/24900-rocket-pool-dashboard-v1-4-0/) e pressione o botão Load.

Você será solicitado com algumas informações sobre o dashboard aqui, como seu nome e onde você gostaria de armazená-lo (a pasta padrão General é boa a menos que você use muitos dashboards e queira organizá-los).

Sob o menu suspenso Prometheus na parte inferior, você deve ter apenas uma única opção rotulada Prometheus (default). Selecione esta opção.

Sua tela deve parecer com isto:

Se a sua corresponder, clique no botão Import e você será imediatamente levado ao seu novo dashboard.

À primeira vista, você deve ver muitas informações sobre seu nó e seus validadores. Cada caixa vem com uma dica útil no canto superior esquerdo (o ícone i) sobre a qual você pode passar o mouse para saber mais sobre ela. Por exemplo, aqui está a dica para a caixa Your Validator Share:

No entanto, ainda não terminamos de configurar as coisas - ainda há um pouco mais de configuração a fazer.

#Ajustando o Monitor de Hardware ao seu Sistema

Agora que o dashboard está funcionando, você pode notar que algumas caixas estão vazias, como SSD Latency e Network Usage. Temos que ajustar o dashboard ao seu hardware específico para que ele saiba como capturar essas coisas.

#CPU Temp

Para atualizar seu medidor de temperatura da CPU, clique no título da caixa CPU Temp e selecione Edit no menu suspenso. Sua tela agora ficará algo assim:

Este é o modo de edição do Grafana, onde você pode alterar o que é exibido e como parece. Estamos interessados na caixa de consulta destacada em vermelho, à direita do botão Metrics browser.

Por padrão, essa caixa tem isto nela:

node_hwmon_temp_celsius{job="node", chip="", sensor=""}

Existem dois campos neste texto que estão atualmente em branco: chip e sensor. Estes são únicos para cada máquina, então você terá que preenchê-los com base no que sua máquina fornece.

Para fazer isso, siga estes passos:

1. Remova a parte , sensor="" para que termine com chip=""}. Para clareza, o todo agora deve ser node_hwmon_temp_celsius{job="node", chip=""}.
2. Coloque seu cursor entre as aspas de chip="" e pressione Ctrl+Spacebar. Isso abrirá uma caixa de preenchimento automático com as opções disponíveis, que se parece com isto:

3. Selecione a opção que corresponde à CPU do seu sistema.
4. Uma vez selecionado, adicione , sensor="" de volta na string. Coloque seu cursor entre as aspas de sensor="" e pressione Ctrl+Spacebar para obter outro menu de preenchimento automático. Selecione o sensor que você deseja monitorar.

k10temp-pci-00c3
Tctl:
  temp1_input: 33.500
Tdie:
  temp2_input: 33.500

Uma vez que você esteja satisfeito com suas seleções, clique no botão azul Apply no canto superior direito da tela para salvar as configurações.

#SSD Latency

O gráfico SSD Latency rastreia quanto tempo leva para operações de leitura/escrita ocorrerem. Isso é útil para avaliar quão rápido seu SSD é, para que você saiba se ele se torna um gargalo se seu validador sofre de desempenho ruim. Para atualizar o SSD que você deseja rastrear no gráfico, clique no título SSD Latency e selecione Edit.

Este gráfico tem quatro campos de consulta (quatro caixas de texto) com oito partes device="" no total. Você precisará atualizar as primeiras quatro dessas partes com o dispositivo que você deseja rastrear.

Simplesmente coloque seu cursor entre as aspas e pressione Ctrl+Spacebar para obter a lista de preenchimento automático do Grafana, e selecione a opção correta de lá para cada uma das partes device="". Você quer começar pela configuração vazia mais à esquerda primeiro, ou a lista de preenchimento automático pode não aparecer.

lsblk

NAME        MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
...
loop25        7:25   0   132K  1 loop /snap/gtk2-common-themes/9
loop26        7:26   0  65,1M  1 loop /snap/gtk-common-themes/1515
nvme0n1     259:0    0 238,5G  0 disk
├─nvme0n1p1 259:1    0   512M  0 part /boot/efi
├─nvme0n1p2 259:2    0 150,1G  0 part /
├─nvme0n1p3 259:3    0  87,4G  0 part
└─nvme0n1p4 259:4    0   527M  0 part

Opcionalmente, você também pode rastrear a latência de um segundo disco no seu sistema. Isso é destinado a pessoas que mantêm seu Sistema Operacional e dados de cadeia em drives separados. Para configurar isso, simplesmente siga as instruções acima para os últimos dois campos de consulta, substituindo os valores da parte device="" com os do disco que você deseja rastrear.

Uma vez que você esteja satisfeito com suas seleções, clique no botão azul Apply no canto superior direito da tela para salvar as configurações.

#Network Usage

Este gráfico rastreia quanto dados você está enviando e recebendo em uma conexão de rede específica. Como você deve esperar, o dashboard precisa saber qual rede você quer que ele rastreie.

Para alterá-la, clique no título Network Usage e selecione Edit.

Este gráfico tem dois campos de consulta com duas partes device="" no total. Você precisará atualizar estes com a rede que você deseja rastrear.

Coloque seu cursor entre as aspas e pressione Ctrl+Spacebar para obter a lista de preenchimento automático do Grafana, e selecione a opção correta de lá para cada uma das partes device="".

sudo route

Kernel IP routing table
Destination     Gateway         Genmask         Flags Metric Ref    Use Iface
default         192.168.1.1     0.0.0.0         UG    100    0        0 eth0
192.168.1.0     0.0.0.0         255.255.255.0   U     0      0        0 eth0
192.168.1.1     0.0.0.0         255.255.255.255 UH    100    0        0 eth0

Uma vez que você esteja satisfeito com suas seleções, clique no botão azul Apply no canto superior direito da tela para salvar as configurações.

#Total Net I/O

Isso rastreia a quantidade total de dados que você enviou e recebeu. Você pode achar útil observar se, por exemplo, seu provedor de internet limita você a uma certa quantidade de dados por mês.

A configuração é idêntica à caixa Network Usage acima, então simplesmente siga essas instruções para esta caixa também.

#Disk Space Used

Isso fica de olho em quão cheio seu disco do Sistema Operacional está ficando, para que você saiba quando é hora de limpar (e se seus dados de cadeia estiverem no mesmo drive, hora de podar Geth ou Nethermind).

Os passos são os mesmos da caixa SSD Latency acima, então simplesmente siga essas instruções para esta caixa também. Como lembrete, você quer o drive que abriga a partição que tem / na coluna MOUNTPOINT para este, porque esse será seu drive do Sistema Operacional. Preencha isso no primeiro campo de consulta.

Opcionalmente, você também pode rastrear o espaço livre de um segundo disco no seu sistema. Isso é destinado a pessoas que mantêm seu Sistema Operacional e dados de cadeia em drives separados. Configure isso seguindo o mesmo processo, mas em vez de procurar qual partição tem / na coluna MOUNTPOINT, você quer procurar a que tem qualquer que seja o ponto de montagem do seu segundo drive. Atualize o segundo campo de consulta com o disco associado a essa partição.

#Disk Temp

Isso rastreia a temperatura atual do seu disco do Sistema Operacional. Os passos são os mesmos da caixa CPU Temp acima, então simplesmente siga essas instruções para esta caixa também, substituindo valores de chip e sensor de CPU com os do seu disco do Sistema Operacional. Preencha esses valores no primeiro campo de consulta.

Opcionalmente, você também pode rastrear a temperatura atual de um segundo disco no seu sistema. Configure isso seguindo o mesmo processo, substituindo os valores de chip e sensor com os do seu segundo drive. Preencha esses valores no segundo campo de consulta.

#Personalizando o Dashboard

Embora o dashboard padrão tente fazer um bom trabalho capturando tudo que você gostaria de ver rapidamente, é bastante fácil personalizar um dashboard do Grafana como você quiser. Você pode adicionar novos gráficos, alterar a aparência dos gráficos, mover as coisas, e muito mais!

Dê uma olhada na página Tutoriais do Grafana para aprender como brincar com ele e configurá-lo ao seu gosto.

#Personalizando a Pilha de Métricas

As ferramentas usadas na Pilha de Métricas do Rocket Pool oferecem uma ampla variedade de opções de configuração além do que está incluído na instalação padrão do Rocket Pool. Esta seção inclui exemplos de configuração para diferentes casos de uso.

Em geral, opções de configuração do Grafana devem ser passadas usando variáveis de ambiente em override/grafana.yml. Qualquer opção de configuração pode ser convertida em uma variável de ambiente usando a seguinte sintaxe:

GF_<SectionName>_<KeyName>

#Configurações SMTP do Grafana para Envio de Emails

Para enviar emails do Grafana, por exemplo, para alertas ou para convidar outros usuários, as configurações SMTP precisam ser configuradas na Pilha de Métricas do Rocket Pool. Consulte a página configuração SMTP do Grafana para referência.

version: "3.7"
services:
grafana:
x-rp-comment: Add your customizations below this line
environment:
## SMTP settings start, replace values with those of your SMTP provider
- GF_SMTP_ENABLED=true
- GF_SMTP_HOST=mail.example.com:`port` # Gmail users should use smtp.gmail.com:587
- GF_SMTP_USER=admin@example.com
- GF_SMTP_PASSWORD=password
- GF_SMTP_FROM_ADDRESS=admin@example.com
- GF_SMTP_FROM_NAME="Rocketpool Grafana Admin"
## SMTP server settings end

[smtp]
enabled = true
host = mail.example.com:`port` # Gmail users should use smtp.gmail.com:587
user = admin@example.com
# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
password = """passw0rd"""
from_address = admin@example.com
from_name = "Rocketpool Grafana Admin"

Depois de fazer essas modificações, execute o seguinte para aplicar as alterações:

docker stop rocketpool_grafana

rocketpool service start

sudo systemctl restart grafana-server

Para testar as configurações SMTP, vá para o menu Alerting e clique em Contact points.

Clique em New contact point e selecione Email como tipo de Contact point. Digite um endereço de email na seção Addresses e clique em Test.

Verifique se o email de teste foi recebido. Clique em Save contact point* quando terminar.