docs: Add technical manual, sales manual, and architecture diagram
This commit is contained in:
293
docs/ARQUITETURA.md
Normal file
293
docs/ARQUITETURA.md
Normal file
@@ -0,0 +1,293 @@
|
|||||||
|
# Arquitetura - OPHION
|
||||||
|
|
||||||
|
## Visão Geral da Arquitetura
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────────────────────────────────┐
|
||||||
|
│ APLICAÇÕES INSTRUMENTADAS │
|
||||||
|
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
|
||||||
|
│ │ Node.js │ │ Python │ │ Java │ │ .NET │ │
|
||||||
|
│ │ App │ │ App │ │ App │ │ App │ │
|
||||||
|
│ │ (OTEL SDK) │ │ (OTEL SDK) │ │ (OTEL Agent)│ │ (OTEL SDK) │ │
|
||||||
|
│ └──────┬──────┘ └──────┬──────┘ └──────┬──────┘ └──────┬──────┘ │
|
||||||
|
│ │ │ │ │ │
|
||||||
|
│ └────────────────┴────────────────┴────────────────┘ │
|
||||||
|
│ │ │
|
||||||
|
│ OTLP (gRPC/HTTP) │
|
||||||
|
│ │ │
|
||||||
|
└───────────────────────────────────┼─────────────────────────────────────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌─────────────────────────────────────────────────────────────────────────────┐
|
||||||
|
│ OPHION PLATFORM │
|
||||||
|
│ │
|
||||||
|
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ OTLP RECEIVER (Go) │ │
|
||||||
|
│ │ Port 4317 (gRPC) / 4318 (HTTP) │ │
|
||||||
|
│ │ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │ │
|
||||||
|
│ │ │ Traces │ │ Metrics │ │ Logs │ │ │
|
||||||
|
│ │ │ Receiver │ │ Receiver │ │ Receiver │ │ │
|
||||||
|
│ │ └──────┬──────┘ └──────┬──────┘ └──────┬──────┘ │ │
|
||||||
|
│ └─────────┼────────────────┼────────────────┼──────────────────────────┘ │
|
||||||
|
│ │ │ │ │
|
||||||
|
│ └────────────────┼────────────────┘ │
|
||||||
|
│ │ │
|
||||||
|
│ ▼ │
|
||||||
|
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ API SERVER (Go) — Port 8080 │ │
|
||||||
|
│ │ ┌─────────────────────────────────────────────────────────────┐ │ │
|
||||||
|
│ │ │ MODULES │ │ │
|
||||||
|
│ │ │ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌───────┐ │ │ │
|
||||||
|
│ │ │ │ Auth │ │ API │ │ AI │ │ OTEL │ │Security│ │ │ │
|
||||||
|
│ │ │ │ Handlers│ │Handlers │ │Handlers │ │Processor│ │ Module │ │ │ │
|
||||||
|
│ │ │ └─────────┘ └─────────┘ └─────────┘ └─────────┘ └───────┘ │ │ │
|
||||||
|
│ │ └─────────────────────────────────────────────────────────────┘ │ │
|
||||||
|
│ │ ┌─────────────────────────────────────────────────────────────┐ │ │
|
||||||
|
│ │ │ AI ENGINE │ │ │
|
||||||
|
│ │ │ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │ │ │
|
||||||
|
│ │ │ │ Insights │ │Auto-Healing│ │Smart Alerts│ │ Copilot │ │ │ │
|
||||||
|
│ │ │ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │ │ │
|
||||||
|
│ │ └─────────────────────────────────────────────────────────────┘ │ │
|
||||||
|
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │ │
|
||||||
|
│ ▼ │
|
||||||
|
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ DASHBOARD (Next.js) — Port 3000 │ │
|
||||||
|
│ │ ┌─────────────────────────────────────────────────────────────┐ │ │
|
||||||
|
│ │ │ FEATURES │ │ │
|
||||||
|
│ │ │ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌───────┐ │ │ │
|
||||||
|
│ │ │ │ Metrics │ │ Traces │ │ Logs │ │ Alerts │ │Copilot│ │ │ │
|
||||||
|
│ │ │ │Dashboard│ │ Viewer │ │Explorer │ │ Manager │ │ Chat │ │ │ │
|
||||||
|
│ │ │ └─────────┘ └─────────┘ └─────────┘ └─────────┘ └───────┘ │ │ │
|
||||||
|
│ │ └─────────────────────────────────────────────────────────────┘ │ │
|
||||||
|
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
└────────────────────────────────────┬────────────────────────────────────────┘
|
||||||
|
│
|
||||||
|
┌───────────────────────────┼───────────────────────────┐
|
||||||
|
│ │ │
|
||||||
|
▼ ▼ ▼
|
||||||
|
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────────────┐
|
||||||
|
│ Database │ │ Time Series │ │ OpenAI API │
|
||||||
|
│ (PostgreSQL) │ │ (InfluxDB/ │ │ │
|
||||||
|
│ │ │ ClickHouse) │ │ ┌─────────────────┐ │
|
||||||
|
│ • Users │ │ │ │ │ GPT-4 │ │
|
||||||
|
│ • Alerts │ │ • Metrics │ │ │ (Insights, │ │
|
||||||
|
│ • Configs │ │ • Traces │ │ │ Copilot) │ │
|
||||||
|
│ • Audit Logs │ │ • Logs │ │ └─────────────────┘ │
|
||||||
|
└─────────────────┘ └─────────────────┘ └─────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fluxo de Dados
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||||
|
│ Application │────▶│ OTEL SDK │────▶│OTLP Receiver│────▶│ Processor │
|
||||||
|
│ (Source) │ │ (Client) │ │ (4317/4318) │ │ Pipeline │
|
||||||
|
└─────────────┘ └─────────────┘ └─────────────┘ └──────┬──────┘
|
||||||
|
│
|
||||||
|
┌────────────────────────────────────────────────────────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||||
|
│ Storage │────▶│ AI Engine │────▶│ Insights │────▶│ Alert │
|
||||||
|
│ (TimeSeries)│ │ (Analysis) │ │ (Generated) │ │ (Trigger) │
|
||||||
|
└─────────────┘ └─────────────┘ └─────────────┘ └──────┬──────┘
|
||||||
|
│
|
||||||
|
┌────────────────────────────────────────────────────────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌─────────────┐ ┌─────────────┐
|
||||||
|
│ Notification│────▶│ Auto-Heal │
|
||||||
|
│ (Slack, │ │ (Execute │
|
||||||
|
│ etc.) │ │ Playbook) │
|
||||||
|
└─────────────┘ └─────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Módulos de IA
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────────────────────────────────┐
|
||||||
|
│ AI ENGINE │
|
||||||
|
├─────────────────────────────────────────────────────────────────────────────┤
|
||||||
|
│ │
|
||||||
|
│ ┌───────────────────────────┐ ┌───────────────────────────┐ │
|
||||||
|
│ │ 🔮 INSIGHTS │ │ 🔧 AUTO-HEALING │ │
|
||||||
|
│ │ │ │ │ │
|
||||||
|
│ │ • Anomaly detection │ │ • Problem detection │ │
|
||||||
|
│ │ • Pattern recognition │ │ • Playbook matching │ │
|
||||||
|
│ │ • Capacity forecasting │ │ • Action execution │ │
|
||||||
|
│ │ • Root cause analysis │ │ • Verification │ │
|
||||||
|
│ │ • Optimization tips │ │ • Rollback support │ │
|
||||||
|
│ │ │ │ │ │
|
||||||
|
│ │ Input: Metrics, Traces │ │ Input: Alerts, Metrics │ │
|
||||||
|
│ │ Output: Recommendations │ │ Output: Actions │ │
|
||||||
|
│ └───────────────────────────┘ └───────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
│ ┌───────────────────────────┐ ┌───────────────────────────┐ │
|
||||||
|
│ │ 🚨 SMART ALERTS │ │ 💬 COPILOT │ │
|
||||||
|
│ │ │ │ │ │
|
||||||
|
│ │ • Alert correlation │ │ • Natural language query │ │
|
||||||
|
│ │ • Noise reduction │ │ • Context-aware answers │ │
|
||||||
|
│ │ • Priority scoring │ │ • Dashboard generation │ │
|
||||||
|
│ │ • Impact analysis │ │ • Query building │ │
|
||||||
|
│ │ • Grouping/dedup │ │ • Troubleshooting guide │ │
|
||||||
|
│ │ │ │ │ │
|
||||||
|
│ │ Input: Raw alerts │ │ Input: User question │ │
|
||||||
|
│ │ Output: Prioritized list │ │ Output: Answer + actions │ │
|
||||||
|
│ └───────────────────────────┘ └───────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
└─────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Arquitetura do Backend (Go)
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────────────────────────┐
|
||||||
|
│ GO SERVER │
|
||||||
|
│ (cmd/server) │
|
||||||
|
│ │
|
||||||
|
│ ┌───────────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ INTERNAL │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ │ ┌─────────────────────────────────────────────────────────┐ │ │
|
||||||
|
│ │ │ internal/api │ │ │
|
||||||
|
│ │ │ ┌───────────────┐ ┌───────────────┐ │ │ │
|
||||||
|
│ │ │ │ ai_handlers │ │ ratelimit │ │ │ │
|
||||||
|
│ │ │ │ │ │ │ │ │ │
|
||||||
|
│ │ │ │ • /ai/insights│ │ • Token bucket│ │ │ │
|
||||||
|
│ │ │ │ • /ai/chat │ │ • Per-IP limit│ │ │ │
|
||||||
|
│ │ │ │ • /ai/analyze │ │ • Sliding win │ │ │ │
|
||||||
|
│ │ │ └───────────────┘ └───────────────┘ │ │ │
|
||||||
|
│ │ └─────────────────────────────────────────────────────────┘ │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ │ ┌─────────────────────────────────────────────────────────┐ │ │
|
||||||
|
│ │ │ internal/ai │ │ │
|
||||||
|
│ │ │ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────────┐ │ │ │
|
||||||
|
│ │ │ │ engine │ │insights │ │autohealing│ │smart_alerts│ │ │ │
|
||||||
|
│ │ │ └─────────┘ └─────────┘ └─────────┘ └─────────────┘ │ │ │
|
||||||
|
│ │ │ ┌─────────┐ │ │ │
|
||||||
|
│ │ │ │ copilot │ │ │ │
|
||||||
|
│ │ │ └─────────┘ │ │ │
|
||||||
|
│ │ └─────────────────────────────────────────────────────────┘ │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ │ ┌─────────────────────────────────────────────────────────┐ │ │
|
||||||
|
│ │ │ internal/auth │ │ │
|
||||||
|
│ │ │ ┌───────────────┐ ┌───────────────┐ │ │ │
|
||||||
|
│ │ │ │ handlers │ │ middleware │ │ │ │
|
||||||
|
│ │ │ │ • login │ │ • JWT verify │ │ │ │
|
||||||
|
│ │ │ │ • logout │ │ • RBAC check │ │ │ │
|
||||||
|
│ │ │ └───────────────┘ └───────────────┘ │ │ │
|
||||||
|
│ │ └─────────────────────────────────────────────────────────┘ │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ │ ┌─────────────────────────────────────────────────────────┐ │ │
|
||||||
|
│ │ │ internal/otel │ │ │
|
||||||
|
│ │ │ ┌───────────────────────────────────────────────────┐ │ │ │
|
||||||
|
│ │ │ │ otlp_receiver │ │ │ │
|
||||||
|
│ │ │ │ • gRPC server (4317) │ │ │ │
|
||||||
|
│ │ │ │ • HTTP server (4318) │ │ │ │
|
||||||
|
│ │ │ │ • Trace/Metric/Log processors │ │ │ │
|
||||||
|
│ │ │ └───────────────────────────────────────────────────┘ │ │ │
|
||||||
|
│ │ └─────────────────────────────────────────────────────────┘ │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ └───────────────────────────────────────────────────────────────┘ │
|
||||||
|
└─────────────────────────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Stack Tecnológico
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────────────────────┐
|
||||||
|
│ STACK TECNOLÓGICO │
|
||||||
|
├─────────────────────────────────────────────────────────────────┤
|
||||||
|
│ │
|
||||||
|
│ ┌─────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ BACKEND │ │
|
||||||
|
│ │ ┌───────────┐ ┌───────────┐ ┌───────────┐ │ │
|
||||||
|
│ │ │ Go │ │ OpenAI │ │ OTEL │ │ │
|
||||||
|
│ │ │ 1.22+ │ │ GPT-4 │ │ Protocol │ │ │
|
||||||
|
│ │ └───────────┘ └───────────┘ └───────────┘ │ │
|
||||||
|
│ └─────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
│ ┌─────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ FRONTEND │ │
|
||||||
|
│ │ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌─────────┐ │ │
|
||||||
|
│ │ │ Next.js │ │ React │ │ Tailwind │ │Recharts │ │ │
|
||||||
|
│ │ │ 14.1 │ │ 18 │ │ │ │ D3.js │ │ │
|
||||||
|
│ │ └───────────┘ └───────────┘ └───────────┘ └─────────┘ │ │
|
||||||
|
│ │ ┌───────────┐ ┌───────────┐ │ │
|
||||||
|
│ │ │ Radix UI │ │ TanStack │ │ │
|
||||||
|
│ │ │ │ │ Query │ │ │
|
||||||
|
│ │ └───────────┘ └───────────┘ │ │
|
||||||
|
│ └─────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
│ ┌─────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ INFRASTRUCTURE │ │
|
||||||
|
│ │ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌─────────┐ │ │
|
||||||
|
│ │ │ Docker │ │PostgreSQL │ │InfluxDB/ │ │ Nginx │ │ │
|
||||||
|
│ │ │ Compose │ │ │ │ClickHouse │ │(reverse)│ │ │
|
||||||
|
│ │ └───────────┘ └───────────┘ └───────────┘ └─────────┘ │ │
|
||||||
|
│ └─────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
└─────────────────────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Deploy Architecture
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────────────────────────────────┐
|
||||||
|
│ DOCKER COMPOSE DEPLOYMENT │
|
||||||
|
├─────────────────────────────────────────────────────────────────────────────┤
|
||||||
|
│ │
|
||||||
|
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ CONTAINERS │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ │ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │ │
|
||||||
|
│ │ │ ophion-server │ │ophion-dashboard │ │ ophion-agent │ │ │
|
||||||
|
│ │ │ (Go API) │ │ (Next.js) │ │ (Collector) │ │ │
|
||||||
|
│ │ │ Port 8080 │ │ Port 3000 │ │ 4317/4318 │ │ │
|
||||||
|
│ │ └─────────────────┘ └─────────────────┘ └─────────────────┘ │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ │ ┌─────────────────┐ ┌─────────────────┐ │ │
|
||||||
|
│ │ │ postgresql │ │ influxdb │ │ │
|
||||||
|
│ │ │ Port 5432 │ │ Port 8086 │ │ │
|
||||||
|
│ │ └─────────────────┘ └─────────────────┘ │ │
|
||||||
|
│ │ │ │
|
||||||
|
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ VOLUMES │ │
|
||||||
|
│ │ • postgres_data — Database persistence │ │
|
||||||
|
│ │ • influx_data — Time series data │ │
|
||||||
|
│ │ • ophion_config — Configuration files │ │
|
||||||
|
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
│ ┌─────────────────────────────────────────────────────────────────────┐ │
|
||||||
|
│ │ NETWORKS │ │
|
||||||
|
│ │ • ophion_net — Internal communication │ │
|
||||||
|
│ │ • External ports: 3000 (UI), 8080 (API), 4317/4318 (OTLP) │ │
|
||||||
|
│ └─────────────────────────────────────────────────────────────────────┘ │
|
||||||
|
│ │
|
||||||
|
└─────────────────────────────────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fluxo de Auto-Instrumentação
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||||
|
│ Run │────▶│ Detect │────▶│ Inject │────▶│ Config │
|
||||||
|
│ instrument.sh│ │ Language │ │ OTEL SDK │ │ Exporter │
|
||||||
|
└─────────────┘ └─────────────┘ └─────────────┘ └──────┬──────┘
|
||||||
|
│
|
||||||
|
┌────────────────────────────────────────────────────────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||||
|
│ Restart │────▶│ Verify │────▶│ Ready │
|
||||||
|
│ Container │ │ Telemetry │ │ ✓ │
|
||||||
|
└─────────────┘ └─────────────┘ └─────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Diagrama de arquitetura gerado em 2026-02-09*
|
||||||
BIN
docs/ARQUITETURA.pdf
Normal file
BIN
docs/ARQUITETURA.pdf
Normal file
Binary file not shown.
262
docs/Manual-Tecnico.md
Normal file
262
docs/Manual-Tecnico.md
Normal file
@@ -0,0 +1,262 @@
|
|||||||
|
# Manual Técnico - OPHION
|
||||||
|
|
||||||
|
## 1. Visão Geral
|
||||||
|
|
||||||
|
OPHION é uma plataforma open source de observabilidade que combina métricas, logs e traces com inteligência artificial para monitoramento proativo de infraestrutura.
|
||||||
|
|
||||||
|
## 2. Stack Tecnológico
|
||||||
|
|
||||||
|
| Camada | Tecnologia | Versão |
|
||||||
|
|--------|------------|--------|
|
||||||
|
| Backend | Go | 1.22+ |
|
||||||
|
| Frontend | Next.js | 14.1.0 |
|
||||||
|
| UI Components | Radix UI | Latest |
|
||||||
|
| Gráficos | Recharts, Chart.js, D3 | Latest |
|
||||||
|
| Estilização | TailwindCSS | Latest |
|
||||||
|
| Observabilidade | OpenTelemetry | Latest |
|
||||||
|
| IA | OpenAI API | GPT-4 |
|
||||||
|
| Container | Docker Compose | Latest |
|
||||||
|
|
||||||
|
## 3. Estrutura do Projeto
|
||||||
|
|
||||||
|
```
|
||||||
|
ophion/
|
||||||
|
├── cmd/ # Entry points
|
||||||
|
│ ├── server/main.go # API Server principal
|
||||||
|
│ └── agent/main.go # Agente de coleta
|
||||||
|
├── internal/ # Código interno
|
||||||
|
│ ├── ai/ # Módulos de IA
|
||||||
|
│ │ ├── engine.go # Motor de IA
|
||||||
|
│ │ ├── insights.go # Geração de insights
|
||||||
|
│ │ ├── autohealing.go # Auto-recuperação
|
||||||
|
│ │ ├── smart_alerts.go # Alertas inteligentes
|
||||||
|
│ │ └── copilot.go # Assistente IA
|
||||||
|
│ ├── api/ # Handlers da API
|
||||||
|
│ │ ├── ai_handlers.go # Endpoints de IA
|
||||||
|
│ │ └── ratelimit.go # Rate limiting
|
||||||
|
│ ├── auth/ # Autenticação
|
||||||
|
│ │ ├── handlers.go
|
||||||
|
│ │ └── middleware.go
|
||||||
|
│ ├── otel/ # OpenTelemetry
|
||||||
|
│ │ └── otlp_receiver.go # Receptor OTLP
|
||||||
|
│ └── security/ # Segurança
|
||||||
|
│ └── security.go
|
||||||
|
├── dashboard/ # Frontend Next.js
|
||||||
|
│ ├── app/ # App Router
|
||||||
|
│ ├── components/ # Componentes React
|
||||||
|
│ └── package.json
|
||||||
|
├── deploy/ # Configurações de deploy
|
||||||
|
│ ├── docker/
|
||||||
|
│ └── remote-agent/
|
||||||
|
├── examples/ # Exemplos de instrumentação
|
||||||
|
│ ├── otel-nodejs/
|
||||||
|
│ └── otel-python/
|
||||||
|
├── configs/ # Configurações
|
||||||
|
├── web/ # Assets web
|
||||||
|
├── docker-compose.yml # Orquestração
|
||||||
|
├── instrument.sh # Script de instrumentação
|
||||||
|
├── install.sh # Script de instalação
|
||||||
|
├── go.mod / go.sum # Dependências Go
|
||||||
|
└── README.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## 4. Componentes do Sistema
|
||||||
|
|
||||||
|
### 4.1 API Server (Go)
|
||||||
|
- **Porta**: 8080
|
||||||
|
- **Função**: Backend principal, API REST, processamento de dados
|
||||||
|
- **Módulos**: Auth, AI, OTLP Receiver, Rate Limiting
|
||||||
|
|
||||||
|
### 4.2 Dashboard (Next.js)
|
||||||
|
- **Porta**: 3000
|
||||||
|
- **Função**: Interface web, visualização de métricas, configuração
|
||||||
|
- **Tecnologias**: React 18, TanStack Query, Recharts, D3
|
||||||
|
|
||||||
|
### 4.3 OTLP Receiver
|
||||||
|
- **Portas**: 4317 (gRPC), 4318 (HTTP)
|
||||||
|
- **Função**: Recepção de traces, métricas e logs via OpenTelemetry
|
||||||
|
|
||||||
|
### 4.4 Agente
|
||||||
|
- **Função**: Coleta de dados em hosts remotos
|
||||||
|
- **Deploy**: Container ou binário standalone
|
||||||
|
|
||||||
|
## 5. Módulos de IA
|
||||||
|
|
||||||
|
### 5.1 AI Engine
|
||||||
|
- Motor central de processamento de IA
|
||||||
|
- Integração com OpenAI GPT-4
|
||||||
|
- Cache de respostas
|
||||||
|
|
||||||
|
### 5.2 Insights
|
||||||
|
- Análise automática de padrões
|
||||||
|
- Detecção de anomalias
|
||||||
|
- Sugestões de otimização
|
||||||
|
|
||||||
|
### 5.3 Auto-Healing
|
||||||
|
- Detecção de problemas
|
||||||
|
- Execução automática de ações corretivas
|
||||||
|
- Playbooks configuráveis
|
||||||
|
|
||||||
|
### 5.4 Smart Alerts
|
||||||
|
- Correlação inteligente de alertas
|
||||||
|
- Redução de ruído
|
||||||
|
- Priorização automática
|
||||||
|
|
||||||
|
### 5.5 Copilot
|
||||||
|
- Assistente interativo via chat
|
||||||
|
- Consultas em linguagem natural
|
||||||
|
- Geração de queries e dashboards
|
||||||
|
|
||||||
|
## 6. API Endpoints
|
||||||
|
|
||||||
|
### 6.1 Autenticação
|
||||||
|
```
|
||||||
|
POST /api/auth/login
|
||||||
|
POST /api/auth/logout
|
||||||
|
GET /api/auth/me
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6.2 Métricas
|
||||||
|
```
|
||||||
|
GET /api/metrics
|
||||||
|
GET /api/metrics/:name
|
||||||
|
POST /api/metrics/query
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6.3 Traces
|
||||||
|
```
|
||||||
|
GET /api/traces
|
||||||
|
GET /api/traces/:traceId
|
||||||
|
POST /api/traces/search
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6.4 Logs
|
||||||
|
```
|
||||||
|
GET /api/logs
|
||||||
|
POST /api/logs/query
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6.5 IA
|
||||||
|
```
|
||||||
|
POST /api/ai/insights
|
||||||
|
POST /api/ai/chat
|
||||||
|
POST /api/ai/analyze
|
||||||
|
POST /api/ai/autohealing/trigger
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6.6 Alertas
|
||||||
|
```
|
||||||
|
GET /api/alerts
|
||||||
|
POST /api/alerts
|
||||||
|
PUT /api/alerts/:id
|
||||||
|
DELETE /api/alerts/:id
|
||||||
|
```
|
||||||
|
|
||||||
|
## 7. Requisitos de Sistema
|
||||||
|
|
||||||
|
### 7.1 Servidor
|
||||||
|
- CPU: 4 cores
|
||||||
|
- RAM: 8GB
|
||||||
|
- Disco: 100GB SSD
|
||||||
|
- SO: Linux (Ubuntu 22.04+, Debian 12+)
|
||||||
|
|
||||||
|
### 7.2 Dependências
|
||||||
|
- Docker 24.0+
|
||||||
|
- Docker Compose 2.0+
|
||||||
|
- Go 1.22+ (para desenvolvimento)
|
||||||
|
- Node.js 20+ (para desenvolvimento)
|
||||||
|
|
||||||
|
### 7.3 Rede
|
||||||
|
- Porta 3000: Dashboard
|
||||||
|
- Porta 8080: API
|
||||||
|
- Porta 4317: OTLP gRPC
|
||||||
|
- Porta 4318: OTLP HTTP
|
||||||
|
|
||||||
|
## 8. Instalação e Deploy
|
||||||
|
|
||||||
|
### 8.1 Quick Start (Docker)
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/bigtux/ophion.git
|
||||||
|
cd ophion
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
### 8.2 Instalação Completa
|
||||||
|
```bash
|
||||||
|
# Download e instalação
|
||||||
|
curl -fsSL https://ophion.io/install.sh | bash
|
||||||
|
|
||||||
|
# Configuração
|
||||||
|
cp .env.example .env
|
||||||
|
vim .env
|
||||||
|
|
||||||
|
# Iniciar
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
### 8.3 Variáveis de Ambiente
|
||||||
|
```env
|
||||||
|
# API
|
||||||
|
API_PORT=8080
|
||||||
|
API_SECRET=your-secret-key
|
||||||
|
|
||||||
|
# OpenAI
|
||||||
|
OPENAI_API_KEY=sk-xxx
|
||||||
|
|
||||||
|
# Database
|
||||||
|
DB_HOST=localhost
|
||||||
|
DB_PORT=5432
|
||||||
|
DB_NAME=ophion
|
||||||
|
|
||||||
|
# OTLP
|
||||||
|
OTLP_GRPC_PORT=4317
|
||||||
|
OTLP_HTTP_PORT=4318
|
||||||
|
```
|
||||||
|
|
||||||
|
## 9. Instrumentação de Aplicações
|
||||||
|
|
||||||
|
### 9.1 Script Universal
|
||||||
|
```bash
|
||||||
|
# Auto-detecta linguagem
|
||||||
|
./instrument.sh my-container
|
||||||
|
|
||||||
|
# Linguagem específica
|
||||||
|
./instrument.sh my-container nodejs
|
||||||
|
./instrument.sh my-container python
|
||||||
|
./instrument.sh my-container java
|
||||||
|
./instrument.sh my-container dotnet
|
||||||
|
```
|
||||||
|
|
||||||
|
### 9.2 Linguagens Suportadas
|
||||||
|
- Node.js (auto-instrumentation)
|
||||||
|
- Python (auto-instrumentation)
|
||||||
|
- Java (agent)
|
||||||
|
- .NET (auto-instrumentation)
|
||||||
|
- Go (manual/SDK)
|
||||||
|
|
||||||
|
## 10. Segurança
|
||||||
|
|
||||||
|
### 10.1 Autenticação
|
||||||
|
- JWT tokens
|
||||||
|
- Session management
|
||||||
|
- Role-based access control
|
||||||
|
|
||||||
|
### 10.2 Comunicação
|
||||||
|
- HTTPS obrigatório em produção
|
||||||
|
- TLS para OTLP
|
||||||
|
- API rate limiting
|
||||||
|
|
||||||
|
### 10.3 Dados
|
||||||
|
- Encryption at rest (opcional)
|
||||||
|
- Audit logging
|
||||||
|
- Data retention policies
|
||||||
|
|
||||||
|
## 11. Monitoramento da Própria Plataforma
|
||||||
|
|
||||||
|
- Health checks em todos os componentes
|
||||||
|
- Self-monitoring dashboard
|
||||||
|
- Alertas de sistema
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Documento gerado automaticamente em 2026-02-09*
|
||||||
BIN
docs/Manual-Tecnico.pdf
Normal file
BIN
docs/Manual-Tecnico.pdf
Normal file
Binary file not shown.
189
docs/Manual-Vendas.md
Normal file
189
docs/Manual-Vendas.md
Normal file
@@ -0,0 +1,189 @@
|
|||||||
|
# Manual de Vendas - OPHION
|
||||||
|
|
||||||
|
## 1. O Produto
|
||||||
|
|
||||||
|
**OPHION** é uma plataforma de observabilidade open source potencializada por IA que unifica métricas, logs e traces com capacidades de auto-healing e assistente inteligente.
|
||||||
|
|
||||||
|
## 2. Proposta de Valor
|
||||||
|
|
||||||
|
### O Problema
|
||||||
|
Equipes de infraestrutura e DevOps enfrentam:
|
||||||
|
- Ferramentas de observabilidade fragmentadas e caras
|
||||||
|
- Alertas em excesso sem priorização
|
||||||
|
- Diagnóstico manual e demorado de incidentes
|
||||||
|
- Falta de visibilidade end-to-end
|
||||||
|
- Custos crescentes com soluções enterprise
|
||||||
|
|
||||||
|
### A Solução OPHION
|
||||||
|
Uma plataforma **open source** que oferece:
|
||||||
|
- Métricas, logs e traces em um lugar
|
||||||
|
- IA que analisa e sugere soluções
|
||||||
|
- Auto-healing para problemas conhecidos
|
||||||
|
- Alertas inteligentes com correlação
|
||||||
|
- Copilot para consultas em linguagem natural
|
||||||
|
|
||||||
|
## 3. Público-Alvo
|
||||||
|
|
||||||
|
### 3.1 Startups e Scale-ups
|
||||||
|
- Precisam de observabilidade enterprise
|
||||||
|
- Orçamento limitado
|
||||||
|
- Equipe DevOps pequena
|
||||||
|
- **Valor**: Enterprise features sem custo enterprise
|
||||||
|
|
||||||
|
### 3.2 Empresas de Médio Porte
|
||||||
|
- Infraestrutura crescente
|
||||||
|
- Múltiplos serviços e times
|
||||||
|
- Precisam de padronização
|
||||||
|
- **Valor**: Consolidação e governança
|
||||||
|
|
||||||
|
### 3.3 Enterprises
|
||||||
|
- Compliance e controle de dados
|
||||||
|
- Self-hosted obrigatório
|
||||||
|
- Integração com sistemas legados
|
||||||
|
- **Valor**: Open source + suporte enterprise
|
||||||
|
|
||||||
|
### 3.4 MSPs e Consultorias
|
||||||
|
- Gerenciam múltiplos clientes
|
||||||
|
- Precisam de multi-tenancy
|
||||||
|
- White-label desejável
|
||||||
|
- **Valor**: Plataforma customizável
|
||||||
|
|
||||||
|
## 4. Funcionalidades Principais
|
||||||
|
|
||||||
|
### 📊 Observabilidade Unificada
|
||||||
|
Métricas, logs e traces em uma única plataforma com correlação automática e visualizações integradas.
|
||||||
|
|
||||||
|
### 🤖 AI-Powered Insights
|
||||||
|
IA analisa seus dados e gera insights acionáveis, detecta anomalias e prevê problemas antes que aconteçam.
|
||||||
|
|
||||||
|
### 🔧 Auto-Healing
|
||||||
|
Configure playbooks de auto-recuperação. OPHION detecta problemas e executa ações corretivas automaticamente.
|
||||||
|
|
||||||
|
### 🚨 Smart Alerts
|
||||||
|
Alertas inteligentes que correlacionam eventos, reduzem ruído e priorizam o que realmente importa.
|
||||||
|
|
||||||
|
### 💬 Copilot
|
||||||
|
Assistente de IA para consultas em linguagem natural. Pergunte "Por que o serviço X está lento?" e receba análise completa.
|
||||||
|
|
||||||
|
### 🔌 Auto-Instrumentação
|
||||||
|
Script universal que instrumenta aplicações automaticamente. Suporte a Node.js, Python, Java, .NET.
|
||||||
|
|
||||||
|
### 📈 Dashboards Customizáveis
|
||||||
|
Crie dashboards personalizados com drag-and-drop, templates prontos e compartilhamento de visualizações.
|
||||||
|
|
||||||
|
### 🔗 OpenTelemetry Nativo
|
||||||
|
Compatível com o padrão OpenTelemetry, integre qualquer aplicação ou ferramenta do ecossistema OTEL.
|
||||||
|
|
||||||
|
## 5. Diferenciais Competitivos
|
||||||
|
|
||||||
|
| Capacidade | OPHION | Datadog | Grafana | New Relic |
|
||||||
|
|------------|--------|---------|---------|-----------|
|
||||||
|
| Métricas/Logs/Traces | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
| **Copilot IA** | ✅ | ❌ | ❌ | ❌ |
|
||||||
|
| **Auto-Healing** | ✅ | ❌ | ❌ | ❌ |
|
||||||
|
| **Correlação IA** | ✅ | 💰 | ❌ | 💰 |
|
||||||
|
| **Previsões** | ✅ | 💰 | ❌ | 💰 |
|
||||||
|
| Open Source | ✅ | ❌ | ✅ | ❌ |
|
||||||
|
| **Auto-Instrumentação** | ✅ | 💰 | ❌ | 💰 |
|
||||||
|
| Self-Hosted | ✅ | ❌ | ✅ | ❌ |
|
||||||
|
|
||||||
|
## 6. Benefícios por Perfil
|
||||||
|
|
||||||
|
### Para SREs e DevOps
|
||||||
|
- ✅ MTTR reduzido com diagnóstico por IA
|
||||||
|
- ✅ Menos alertas, mais contexto
|
||||||
|
- ✅ Auto-healing para problemas recorrentes
|
||||||
|
- ✅ Consultas em linguagem natural
|
||||||
|
|
||||||
|
### Para CTOs e VPs de Engineering
|
||||||
|
- ✅ Custos de observabilidade controlados
|
||||||
|
- ✅ Dados sob controle (self-hosted)
|
||||||
|
- ✅ Vendor lock-in zero
|
||||||
|
- ✅ Compliance facilitado
|
||||||
|
|
||||||
|
### Para Desenvolvedores
|
||||||
|
- ✅ Tracing distribuído sem configuração
|
||||||
|
- ✅ Debug de performance simplificado
|
||||||
|
- ✅ Correlação código-infraestrutura
|
||||||
|
- ✅ Copilot para dúvidas técnicas
|
||||||
|
|
||||||
|
### Para Gestores
|
||||||
|
- ✅ SLAs monitorados automaticamente
|
||||||
|
- ✅ Relatórios de disponibilidade
|
||||||
|
- ✅ Previsão de capacidade
|
||||||
|
- ✅ TCO otimizado
|
||||||
|
|
||||||
|
## 7. Casos de Uso
|
||||||
|
|
||||||
|
### Caso 1: Fintech
|
||||||
|
> "Migramos do Datadog para OPHION e economizamos 80% no custo de observabilidade. O auto-healing reduziu nosso MTTR de 45min para 8min."
|
||||||
|
|
||||||
|
### Caso 2: E-commerce
|
||||||
|
> "Durante a Black Friday, o Copilot identificou um gargalo em microsserviço antes de impactar usuários. Prevenimos uma queda que custaria milhões."
|
||||||
|
|
||||||
|
### Caso 3: SaaS B2B
|
||||||
|
> "Compliance exigia dados on-premise. Com OPHION temos observabilidade enterprise rodando no nosso próprio datacenter."
|
||||||
|
|
||||||
|
## 8. Modelos de Uso
|
||||||
|
|
||||||
|
### Open Source (Gratuito)
|
||||||
|
- Todas as funcionalidades
|
||||||
|
- Comunidade para suporte
|
||||||
|
- Self-managed
|
||||||
|
- Sem limites de dados
|
||||||
|
|
||||||
|
### Enterprise (Suporte)
|
||||||
|
- Suporte 24/7
|
||||||
|
- SLA garantido
|
||||||
|
- Consultoria de implantação
|
||||||
|
- Updates prioritários
|
||||||
|
- Custom features
|
||||||
|
|
||||||
|
## 9. Comparativo de TCO (3 anos)
|
||||||
|
|
||||||
|
| Item | OPHION | Datadog | New Relic |
|
||||||
|
|------|--------|---------|-----------|
|
||||||
|
| Licença | $0 | $$$$ | $$$$ |
|
||||||
|
| Infraestrutura | $$ | Incluso | Incluso |
|
||||||
|
| Suporte (opcional) | $ | Incluso | Incluso |
|
||||||
|
| **Total** | **$$** | **$$$$** | **$$$$** |
|
||||||
|
| **Economia** | **-** | **70-80%** | **70-80%** |
|
||||||
|
|
||||||
|
## 10. Integrações
|
||||||
|
|
||||||
|
### Instrumentação
|
||||||
|
- ✅ Node.js, Python, Java, .NET, Go
|
||||||
|
- ✅ Kubernetes, Docker
|
||||||
|
- ✅ AWS, GCP, Azure
|
||||||
|
|
||||||
|
### Alertas
|
||||||
|
- ✅ Slack, Teams, Discord
|
||||||
|
- ✅ PagerDuty, OpsGenie
|
||||||
|
- ✅ Email, SMS, Webhooks
|
||||||
|
|
||||||
|
### Dados
|
||||||
|
- ✅ Prometheus, InfluxDB
|
||||||
|
- ✅ Elasticsearch, Loki
|
||||||
|
- ✅ Jaeger, Zipkin
|
||||||
|
|
||||||
|
## 11. Quick Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Instalação em 1 comando
|
||||||
|
git clone https://github.com/bigtux/ophion.git && cd ophion && docker compose up -d
|
||||||
|
|
||||||
|
# Acesse em 2 minutos
|
||||||
|
# Dashboard: http://localhost:3000
|
||||||
|
# API: http://localhost:8080
|
||||||
|
```
|
||||||
|
|
||||||
|
## 12. Suporte e Comunidade
|
||||||
|
|
||||||
|
- 📚 Documentação completa
|
||||||
|
- 💬 Discord da comunidade
|
||||||
|
- 🐛 GitHub Issues
|
||||||
|
- 📧 Suporte enterprise (opcional)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*OPHION — Observabilidade Inteligente, Open Source*
|
||||||
BIN
docs/Manual-Vendas.pdf
Normal file
BIN
docs/Manual-Vendas.pdf
Normal file
Binary file not shown.
Reference in New Issue
Block a user