Ctrl K
ComunidadGuías…

README.pt-BR.md

Rama main · réplica de lectura del repositorio original.

Archivo original ↗Preguntar a KiBot
# Argus

[![CI](https://github.com/HarryRaddatz/argus-observability/actions/workflows/ci.yml/badge.svg)](https://github.com/HarryRaddatz/argus-observability/actions/workflows/ci.yml)

Observabilidade de hosts e workloads Docker: métricas, logs, eventos, traces e painel web.

Hub central + agent leve por host. Persistência plugável; Postgres é o driver incluso.

[English](README.md)

## Quickstart

Requisitos: Docker Engine com Compose v2.

```bash
git clone https://github.com/HarryRaddatz/argus-observability.git
cd argus-observability
cp .env.example .env
# Edite ARGUS_AGENT_TOKEN se quiser autenticar ingest
docker compose up -d --build
```

| Serviço | URL |
|---|---|
| Painel | http://localhost:3000 |
| Hub API | http://localhost:8080 |
| Health | http://localhost:8080/health |

O agent monta o Docker socket e passa a reportar containers em execução. Abra o painel e confira **Visão geral** e **Containers**.

Exemplo mínimo adicional: [examples/compose-minimal/](examples/compose-minimal/).

## Releases e imagens

Versões em [GitHub Releases](https://github.com/HarryRaddatz/argus-observability/releases). Cada tag `vX.Y.Z` publica `argus-hub`, `argus-agent` e `argus-web` para `linux/amd64` e `linux/arm64`, com tags `X.Y.Z`, `X.Y` e `latest`:

| Registry | Imagens |
|---|---|
| Docker Hub | [`pseudohuery/argus-hub`](https://hub.docker.com/r/pseudohuery/argus-hub) · [`argus-agent`](https://hub.docker.com/r/pseudohuery/argus-agent) · [`argus-web`](https://hub.docker.com/r/pseudohuery/argus-web) |
| GHCR | `ghcr.io/harryraddatz/argus-{hub,agent,web}` |

Para atualizar uma instância em execução, siga [docs/deploy.md](docs/deploy.md).

## Componentes

| Binário | Função |
|---|---|
| `argus-hub` | API REST, WebSocket, bus de eventos, Store |
| `argus-agent` | Coleta métricas e logs do runtime; envia ao hub |

```mermaid
flowchart LR
  Agent[Agent] -->|ingest| Hub[Hub]
  Hub --> Store[(Store)]
  Hub --> Bus[Event bus]
  Bus --> Rules[Regras]
  Rules --> Notify[Notificacoes]
  UI[UI] --> Hub
```

## Documentação

Site: [harryraddatz.github.io/argus-observability](https://harryraddatz.github.io/argus-observability/)

| Recurso | Arquivo |
|---|---|
| Mapa do produto | [docs/map.md](docs/map.md) |
| Roadmap biblioteca pública | [docs/public-library/roadmap.md](docs/public-library/roadmap.md) |
| API reference | [docs/api/](docs/api/) |
| Visão geral | [docs/overview.md](docs/overview.md) |
| Painel (rotas e IA) | [docs/flows/ui-panel.md](docs/flows/ui-panel.md) |
| Fluxos | [docs/flows/](docs/flows/) |
| Deploy e atualização | [docs/deploy.md](docs/deploy.md) |

## Desenvolvimento local

```bash
go run ./cmd/hub
go run ./cmd/agent
cd web && npm install && npm run dev
```

O dev server Vite faz proxy de `/api` e `/health` para `http://127.0.0.1:8080`.

## Configuração

Variáveis principais — ver `.env.example` e [docs/api/configuration.md](docs/api/configuration.md).

## Contribuir

Leia [CONTRIBUTING.md](CONTRIBUTING.md) e [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). Vulnerabilidades: [SECURITY.md](SECURITY.md).

## Licença

MIT — ver [LICENSE](LICENSE).