install-openserve/README.md

5.5 KiB

install-openserve

Script para instalação e configuração automática do agente OpenObserve (OpenTelemetry Collector) em servidores Linux, VMs e containers LXC.

Compatibilidade

  • Qualquer distribuição Linux com systemd (Ubuntu, Debian, etc.)
  • VMs e containers LXC do Proxmox

Configuração padrão

Item Valor
Endpoint de ingestão https://openobserve.ledcloud.com.br/api/<org_id>/
Organização LED Cloud
Autenticação Token de ingestão (Base64), gerado em Dados > Fontes de dados > Gerenciar tokens
Serviço instalado otel-collector (binário otelcol-contrib)
Arquivo de configuração /etc/otel-config.yaml
Identificação do host host.name = hostname curto da máquina (detectado automaticamente)

Uso

Execute como root na máquina que vai enviar dados:

wget -O openobserve-install.sh https://git.ledcloud.com.br/LED_Cloud/install-openserve/raw/branch/main/openobserve-install.sh
chmod +x openobserve-install.sh
sudo ./openobserve-install.sh

Ou, se o repositório já estiver clonado localmente:

git clone https://git.ledcloud.com.br/LED_Cloud/install-openserve.git
cd install-openserve
chmod +x openobserve-install.sh
sudo ./openobserve-install.sh

O script pergunta interativamente pela URL de ingestão e pelo token em Base64 (cole exatamente o valor mostrado na tela "Gerenciar tokens", sem editar). Para rodar sem prompts (automação, rollout em massa), use variáveis de ambiente:

sudo OO_URL="https://openobserve.ledcloud.com.br/api/<org_id>/" \
     OO_AUTH_B64="<token_base64_copiado_da_tela>" \
     ./openobserve-install.sh

Variável opcional:

  • OO_HOSTNAME — nome que vai aparecer em Infra > Hosts. Padrão: hostname curto da máquina (hostname -s).

O que o script faz

  1. Confere se está rodando como root.
  2. Valida que o token colado em OO_AUTH_B64 é Base64 válido (evita erros silenciosos de 401 por valor colado errado).
  3. Se o coletor ainda não estiver instalado, baixa o instalador oficial do OpenObserve e instala o otelcol-contrib com a URL e o token informados.
  4. Se já estiver instalado, só reconfigura: faz backup do /etc/otel-config.yaml antes de qualquer alteração.
  5. Grava o header Authorization: Basic <token> em todos os exporters do arquivo de configuração, usando o valor exatamente como foi colado (sem recodificar).
  6. Fixa host.name no processor resource/hostname, garantindo que o host apareça com o nome correto em Infra > Hosts, mesmo em containers LXC onde as métricas de recurso podem se confundir com as do nó físico.
  7. Valida a configuração (otelcol-contrib validate) antes de reiniciar o serviço — se a validação falhar, nada é reiniciado.
  8. Reinicia e habilita o serviço otel-collector.
  9. Aguarda alguns segundos e verifica nos logs se não há mais erros 401 (autenticação), avisando se algo ainda estiver incorreto.

Observações

  • O script precisa ser executado como root (sudo).
  • É seguro executar o script mais de uma vez na mesma máquina: ele detecta se o coletor já está instalado e apenas atualiza a configuração, sem reinstalar o binário.
  • Nunca recombine o token com e-mail nem gere um novo Base64 em cima do valor copiado da tela "Gerenciar tokens" — o valor já vem pronto para o header Authorization e qualquer recodificação quebra a autenticação (erro 401).
  • Se aparecerem erros 401 persistentes nos logs (journalctl -u otel-collector), confira se o token ainda está ativo em Gerenciar tokens e se foi colado sem espaços ou quebras de linha.
  • Trate o token de ingestão como uma credencial: não o cole em canais públicos nem o deixe em scripts versionados. Se ele for exposto, revogue-o e gere um novo.

Rollout em massa (LXCs e VMs de um host Proxmox)

Para instalar em muitos containers LXC de uma vez, use deploy-openobserve-fleet.sh, executado no próprio host Proxmox como root, na mesma pasta onde está openobserve-install.sh:

wget -O deploy-openobserve-fleet.sh https://git.ledcloud.com.br/LED_Cloud/install-openserve/raw/branch/main/deploy-openobserve-fleet.sh
chmod +x deploy-openobserve-fleet.sh

sudo OO_URL="https://openobserve.ledcloud.com.br/api/<org_id>/" \
     OO_AUTH_B64="<token_base64_copiado_da_tela>" \
     ./deploy-openobserve-fleet.sh

Ele lista todos os LXCs (pct list), pede confirmação e, para cada container em execução, copia o openobserve-install.sh com pct push, executa com pct exec em modo não interativo e remove o arquivo temporário ao final. Ao término, mostra um resumo de quais hosts tiveram sucesso, foram pulados ou falharam.

Variáveis opcionais:

  • SKIP_LXC_IDS — IDs de LXC a pular, separados por espaço (ex.: "105 112").
  • VM_SSH_HOSTS — lista de IPs/hosts de VMs para instalar também via SSH (requer chave SSH configurada para root), separados por espaço.

Exemplo incluindo VMs:

sudo OO_URL="https://openobserve.ledcloud.com.br/api/<org_id>/" \
     OO_AUTH_B64="<token_base64>" \
     VM_SSH_HOSTS="10.0.0.11 10.0.0.12" \
     SKIP_LXC_IDS="105" \
     ./deploy-openobserve-fleet.sh