Skip to main content

Guardião dos servidores — monitoramento de status, recursos, custo/expiração e segurança de hosts Linux via SSH.

Project description

Vordr 🐺

Na mitologia nórdica, Vörðr é o espírito-guardião que acompanha cada pessoa do nascimento à morte, vigiando-a sem descanso. Aqui, Vordr monta guarda diante dos seus servidores.

Vordr é uma CLI que vigia seus hosts Linux por SSH e responde, num só lugar, às perguntas que importam no dia a dia:

  • Estão de pé? — estado, uptime, carga, RAM, disco e containers de todos os hosts.
  • Vou ser cobrado? — há quanto tempo você hospeda cada host, quando o servidor renova e quando o domínio expira, e quanto você gasta por mês. O recurso que evita a cobrança surpresa.
  • Estão seguros? — falhas de login, portas em escuta, fail2ban, atualizações pendentes e necessidade de reboot.

Sem agentes instalados nos servidores, sem banco de dados, sem segredos no código: Vordr só precisa do seu ~/.ssh/config.

┌──────────────────────────────────────────────────────────────────────┐
│ Vordr · status dos servidores                                          │
├───────────┬──────────┬─────────┬──────┬─────┬───────┬────────┬─────────┤
│ host      │ estado   │ uptime  │ load │ ram │ disco │ docker │ expira  │
├───────────┼──────────┼─────────┼──────┼─────┼───────┼────────┼─────────┤
│ web       │ ● online │ 2sem 5d │ 0.28 │ 32% │ 22%   │ 5/6    │ 53d     │
│ db        │ ● online │ 4sem 4d │ 0.04 │ 18% │ 62%   │ 6/6    │ 6d  ⚠   │
└───────────┴──────────┴─────────┴──────┴─────┴───────┴────────┴─────────┘

Por que existe

Quem mantém alguns servidores acaba acumulando comandos soltos e logins repetidos para responder perguntas simples. Vordr junta isso numa camada única que:

  1. olha todos os hosts de uma vez, com métricas comparáveis e coloridas por limiar (load por CPU, % de disco/RAM);
  2. avisa antes de uma renovação cobrar de novo;
  3. dá uma auditoria rápida de segurança sem precisar logar em cada máquina.

Vordr coleta métricas via pequenos scripts sh que emitem CHAVE=valor (estável e testável) em vez de parsear saída colorida e frágil — mas ainda oferece um modo --raw que reproduz a saída nativa de um status_command seu, quando você define um.

Instalação

Requer Python 3.11+ e o cliente ssh configurado com os hosts que você quer monitorar.

pipx install vordr          # recomendado (ferramenta isolada no PATH)
# ou, para desenvolvimento:
pip install -e ".[dev]"

Começo rápido (só com um token)

Para custo e cobrança você não precisa configurar nada: dê um token de provedor e o Vordr descobre os servidores da sua conta sozinho.

vordr secret set hetzner   # ou: vordr secret set vultr
vordr cost                 # lista os servidores da conta, com custo e tempo de uso
vordr billing              # saldo/crédito e próxima cobrança

O config.toml é opcional e serve só para o que a API não sabe: um apelido bonito, o alias SSH (para status/resources/security) ou um preço travado que difere do de lista (promoção/legado). O que você escrever no config sempre vence o que vem da API.

Configuração (opcional)

Os hosts são aliases do seu ~/.ssh/config — nenhum IP, usuário ou chave fica guardado pelo Vordr. Cada host tem dois blocos de ciclo de vida: [hosts.X.server] (a hospedagem) e [hosts.X.domain] (o domínio) — ambos com campos todos opcionais, preenchidos pela API/RDAP quando você os deixa em branco.

vordr init        # assistente: importa os servidores da API e mapeia aliases SSH

Num terminal, vordr init é um assistente: com um token salvo, ele lista os servidores da conta, sugere o alias SSH de cada um (lendo seu ~/.ssh/config) e pergunta se há um preço fixo a travar — gerando o config sem você escrever TOML. Em pipe/CI, ou sem token, escreve um modelo comentado.

Se um servidor não tiver alias SSH (você deixa em branco, ou escreve ssh = ""), ele entra como billing-only: aparece em cost/billing, mas status/resources/ security o ignoram (com um aviso), pois não há como contatá-lo.

[thresholds]
warn_days = 14
critical_days = 7

[hosts.web]
ssh = "web"                   # alias no ~/.ssh/config
label = "Web"
# status_command = "meu-status"   # opcional: seu script para `vordr status --raw`

  [hosts.web.server]          # a hospedagem
  provider = "Hetzner"
  since   = "2024-03-01"      # desde quando você hospeda (tempo de hospedagem)
  expires = "2026-08-15"      # AAAA-MM-DD — próxima renovação do servidor
  cost = 6.99
  currency = "USD"
  cycle = "monthly"           # monthly | yearly

  [hosts.web.domain]          # o domínio (opcional)
  name = "web.exemplo.com"
  registrar = "Cloudflare"
  expires = "2027-03-01"
  cost = 12.00
  currency = "USD"
  cycle = "yearly"

Vordr não embute nenhum host. Sem config e sem token, os comandos apenas orientam o próximo passo (vordr secret set ou vordr init). Os comandos que dependem de SSH (status, resources, security) precisam dos aliases no config; já cost e billing funcionam só com o token.

Uso

vordr status              # painel de todos os hosts
vordr status web          # só um host
vordr status --watch 5    # atualiza a cada 5s (tela cheia)
vordr status --raw        # saída nativa do status_command do host

vordr resources           # CPU/load, memória e disco em detalhe
vordr security            # auditoria: logins, falhas, portas, fail2ban, updates
vordr cost                # tabela: hospedagem, renovação de servidor/domínio, custo/mês
vordr cost web            # painel detalhado do ciclo de vida de um host
vordr cost --offline      # sem rede: usa só o que está no config
vordr billing             # saldo/crédito e próxima cobrança por provedor
vordr hosts               # lista o que está configurado

vordr secret set hetzner  # guarda o token da API (chmod 600, fora do repo)
vordr secret status       # mostra quais provedores têm token (mascarado)

Todas as cores seguem limiares: verde (ok), amarelo (atenção), vermelho (crítico) — para disco/RAM, load por CPU e dias até a cobrança.

Automação do cost (sem digitar datas)

O cost preenche sozinho o que você não informou — e o valor do config sempre vence (útil para preços promocionais/legados):

  • Domínio: informe só name no [hosts.X.domain] e a expiração vem do RDAP (público, sem credencial), cacheada em ~/.cache/vordr/rdap.json.
  • Servidor: com provider = "Hetzner" ou "Vultr" e um token configurado, o since (data de criação) e o custo mensal vêm da API do provedor.

Provedores suportados: Hetzner (HCLOUD_TOKEN) e Vultr (VULTR_API_KEY). Tokens nunca ficam no repositório: são lidos de variável de ambiente ou de ~/.config/vordr/secrets.toml (chmod 600, no .gitignore), com o env tendo prioridade. Configure com vordr secret set <provedor>. Valores vindos da rede aparecem marcados com (API) / (RDAP).

⚠️ O preço da API é o de lista do tipo/plano — se a sua conta tem valor promocional/travado, informe cost no config (ele vence). A API da Vultr usa allowlist de IP e o token é full-access (não há read-only): cuide bem dele.

Saldo e próxima cobrança (vordr billing)

Com o token configurado, vordr billing responde quando e de onde sai a cobrança — cada provedor tem um modelo:

  • Pré-pago (ex.: Vultr): mostra crédito, uso pendente do ciclo e o runway — quantos dias o saldo ainda cobre (somando o custo dos servidores da conta) e a data em que ele esgota. Útil quando se roda em cima de bônus/crédito: a cobrança no cartão só começa quando o saldo zera. Um resumo dessa linha aparece também no rodapé do vordr cost.
  • Postpago (ex.: Hetzner): a Cloud API não expõe saldo; o billing mostra a próxima data de cobrança (1º do mês seguinte) e o custo mensal estimado.

Como funciona

Camada Arquivo Responsabilidade
Transporte SSH vordr/ssh.py Executa comandos remotos (BatchMode, timeout).
Coleta de métrica vordr/probe.py Scripts shCHAVE=valor → dataclasses.
Configuração vordr/config.py Lê o TOML; cálculo de dias/custo.
Expiração domínio vordr/rdap.py RDAP público + cache em disco (sem credencial).
API de provedor vordr/hetzner.py, vordr/vultr.py Clientes read-only (since, preço e saldo).
Segredos vordr/secrets.py Tokens fora do repo (env > arquivo chmod 600).
Formatação vordr/format.py Funções puras (uptime, bytes, limiares de cor).
CLI vordr/cli.py Typer + Rich; orquestra tudo em paralelo.

Os hosts são consultados em paralelo (ThreadPoolExecutor), então monitorar 2 ou 10 servidores leva praticamente o mesmo tempo.

Segurança por design

  • Read-only: Vordr só roda comandos de leitura (/proc, df, ss, last, …).
  • Sem segredos no repositório: hosts são aliases SSH; o config.toml real fica fora do versionamento (veja .gitignore).
  • Sem sudo interativo: checagens privilegiadas usam sudo -n (não-interativo) e degradam graciosamente quando não há permissão — nunca travam o terminal.
  • BatchMode: se a chave não estiver disponível, falha rápido em vez de pedir senha.

Desenvolvimento

pip install -e ".[dev]"
ruff check .
pytest

Os testes não tocam a rede: a camada SSH é injetada (monkeypatch) e a lógica de parsing/formatação é testada com amostras reais de saída dos servidores.

Licença

MIT — veja LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vordr-0.5.0.tar.gz (38.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vordr-0.5.0-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file vordr-0.5.0.tar.gz.

File metadata

  • Download URL: vordr-0.5.0.tar.gz
  • Upload date:
  • Size: 38.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vordr-0.5.0.tar.gz
Algorithm Hash digest
SHA256 9e2dc80dfe7f711cef37cd5acfa6b17571762b7675986f31f07d2cf5ccf2b251
MD5 1ad366003cc5fffea2bed29e2aa8f6d1
BLAKE2b-256 7359c049956f56e936deceffda17023be0b7514632f8b409f23ecc56cf38f83a

See more details on using hashes here.

Provenance

The following attestation bundles were made for vordr-0.5.0.tar.gz:

Publisher: publish.yml on gusta-ve/vordr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vordr-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: vordr-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vordr-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f70f2c292bfaa6832445bbe37f4087a06b498dcfc49d7c4da232f6b1f9763071
MD5 58d4cb272a49b49b797587cd60d87ca0
BLAKE2b-256 df6aab3b9a4f4b930652b0e253845eade44f501510bbc888716934d508ac837e

See more details on using hashes here.

Provenance

The following attestation bundles were made for vordr-0.5.0-py3-none-any.whl:

Publisher: publish.yml on gusta-ve/vordr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page