Sync to Gitea
This commit is contained in:
bigtux
565
docs/manual_tecnico.html
Normal file
565
docs/manual_tecnico.html
Normal file
@@ -0,0 +1,565 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="pt-BR">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>OPHION - Manual Técnico</title>
|
||||
<style>
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
body {
|
||||
font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
||||
color: #2D3142;
|
||||
background: white;
|
||||
line-height: 1.6;
|
||||
padding: 40px 60px;
|
||||
max-width: 900px;
|
||||
margin: 0 auto;
|
||||
}
|
||||
h1 {
|
||||
color: #1A7A4C;
|
||||
font-size: 28px;
|
||||
margin-bottom: 20px;
|
||||
padding-bottom: 10px;
|
||||
border-bottom: 3px solid #1A7A4C;
|
||||
}
|
||||
h2 {
|
||||
color: #1A7A4C;
|
||||
font-size: 22px;
|
||||
margin-top: 30px;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
h3 {
|
||||
color: #1A7A4C;
|
||||
font-size: 18px;
|
||||
margin-top: 20px;
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
p {
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
margin: 20px 0;
|
||||
}
|
||||
th, td {
|
||||
border: 1px solid #E2E4E8;
|
||||
padding: 12px;
|
||||
text-align: left;
|
||||
}
|
||||
th {
|
||||
background: #1A7A4C;
|
||||
color: white;
|
||||
font-weight: 600;
|
||||
}
|
||||
tr:nth-child(even) {
|
||||
background: #f9f9f9;
|
||||
}
|
||||
code {
|
||||
background: #f4f4f4;
|
||||
padding: 2px 6px;
|
||||
border-radius: 4px;
|
||||
font-family: 'Courier New', monospace;
|
||||
font-size: 14px;
|
||||
}
|
||||
pre {
|
||||
background: #1e1e1e;
|
||||
color: #d4d4d4;
|
||||
padding: 20px;
|
||||
border-radius: 8px;
|
||||
overflow-x: auto;
|
||||
margin: 20px 0;
|
||||
}
|
||||
pre code {
|
||||
background: none;
|
||||
padding: 0;
|
||||
color: inherit;
|
||||
}
|
||||
ul, ol {
|
||||
margin: 15px 0;
|
||||
padding-left: 30px;
|
||||
}
|
||||
li {
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
blockquote {
|
||||
border-left: 4px solid #1A7A4C;
|
||||
padding-left: 20px;
|
||||
margin: 20px 0;
|
||||
font-style: italic;
|
||||
color: #555;
|
||||
}
|
||||
hr {
|
||||
border: none;
|
||||
border-top: 2px solid #E2E4E8;
|
||||
margin: 30px 0;
|
||||
}
|
||||
strong {
|
||||
color: #1A7A4C;
|
||||
}
|
||||
.page-break {
|
||||
page-break-after: always;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>OPHION - Manual Técnico</h1>
|
||||
<h2>Plataforma de Observabilidade com IA</h2>
|
||||
<hr />
|
||||
<h2>1. Visão Geral</h2>
|
||||
<p><strong>OPHION</strong> é uma plataforma de observabilidade open source que combina <strong>métricas, logs e traces</strong> em uma única solução, potencializada por <strong>inteligência artificial</strong> para monitoramento proativo e auto-healing.</p>
|
||||
<hr />
|
||||
<h2>2. Stack Tecnológico</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Camada</th>
|
||||
<th>Tecnologia</th>
|
||||
<th>Função</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>API Server</td>
|
||||
<td>Go 1.22</td>
|
||||
<td>Backend principal</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Dashboard</td>
|
||||
<td>Next.js + TypeScript</td>
|
||||
<td>Interface web</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Collector</td>
|
||||
<td>OpenTelemetry Collector</td>
|
||||
<td>Ingestão de telemetria</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Database</td>
|
||||
<td>PostgreSQL</td>
|
||||
<td>Dados estruturados</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Time Series</td>
|
||||
<td>ClickHouse</td>
|
||||
<td>Métricas de alta performance</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Cache</td>
|
||||
<td>Redis</td>
|
||||
<td>Cache e filas</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Container</td>
|
||||
<td>Docker Compose</td>
|
||||
<td>Orquestração</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<h2>3. Arquitetura do Sistema</h2>
|
||||
<pre><code>┌─────────────────────────────────────────────────────────────────┐
|
||||
│ APLICAÇÕES INSTRUMENTADAS │
|
||||
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
|
||||
│ │ Node.js │ │ Python │ │ Java │ │ .NET │ │ Go │ │
|
||||
│ └────┬────┘ └────┬────┘ └────┬────┘ └────┬────┘ └────┬────┘ │
|
||||
│ └───────────┴───────────┼───────────┴───────────┘ │
|
||||
│ │ OTLP (4317/4318) │
|
||||
└───────────────────────────────┼─────────────────────────────────┘
|
||||
│
|
||||
┌───────────────────────────────┼─────────────────────────────────┐
|
||||
│ OPHION STACK ▼ │
|
||||
│ ┌─────────────────────────────────────────────────┐ │
|
||||
│ │ OpenTelemetry Collector │ │
|
||||
│ │ (receivers → processors → exporters) │ │
|
||||
│ └─────────────────────────┬───────────────────────┘ │
|
||||
│ │ │
|
||||
│ ┌────────────────┐ ▼ ┌────────────────┐ │
|
||||
│ │ Dashboard │◄───► Server ◄──►│ PostgreSQL │ │
|
||||
│ │ (Next.js) │ (Go API) │ ClickHouse │ │
|
||||
│ │ :3000 │ :8080 │ Redis │ │
|
||||
│ └────────────────┘ └────────────────┘ │
|
||||
│ │
|
||||
│ ┌────────────────────────────────────────────────┐ │
|
||||
│ │ AI Engine (Copilot) │ │
|
||||
│ │ - Correlação de alertas │ │
|
||||
│ │ - Previsão de capacidade │ │
|
||||
│ │ - Auto-healing │ │
|
||||
│ └────────────────────────────────────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h2>4. Estrutura de Diretórios</h2>
|
||||
<pre><code>ophion/
|
||||
├── cmd/
|
||||
│ ├── server/ # API Server (Go)
|
||||
│ └── agent/ # Agent de coleta
|
||||
├── internal/ # Código interno Go
|
||||
│ ├── api/ # Handlers HTTP
|
||||
│ ├── db/ # Repositórios
|
||||
│ ├── ai/ # Engine de IA
|
||||
│ └── telemetry/ # Processamento OTLP
|
||||
├── dashboard/ # Frontend Next.js
|
||||
│ ├── src/
|
||||
│ │ ├── app/ # App Router
|
||||
│ │ ├── components/ # UI Components
|
||||
│ │ └── lib/ # Utilitários
|
||||
│ └── package.json
|
||||
├── deploy/
|
||||
│ ├── docker/ # Docker configs
|
||||
│ │ └── otel-collector-config.yaml
|
||||
│ ├── remote-agent/ # Agent remoto
|
||||
│ └── instrumentation/ # Scripts de instrumentação
|
||||
├── examples/ # Exemplos por linguagem
|
||||
│ ├── otel-nodejs/
|
||||
│ ├── otel-python/
|
||||
│ └── docker/
|
||||
├── configs/ # Configurações
|
||||
├── docs/ # Documentação
|
||||
├── instrument.sh # Script de auto-instrumentação
|
||||
├── install.sh # Instalador
|
||||
├── docker-compose.yml
|
||||
├── go.mod / go.sum
|
||||
└── server # Binário compilado
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h2>5. Componentes Principais</h2>
|
||||
<h3>5.1 OpenTelemetry Collector</h3>
|
||||
<p><strong>Portas:</strong>
|
||||
- <code>4317</code> - OTLP gRPC
|
||||
- <code>4318</code> - OTLP HTTP</p>
|
||||
<p><strong>Pipeline:</strong></p>
|
||||
<pre><code class="language-yaml">receivers:
|
||||
otlp:
|
||||
protocols:
|
||||
grpc:
|
||||
endpoint: 0.0.0.0:4317
|
||||
http:
|
||||
endpoint: 0.0.0.0:4318
|
||||
|
||||
processors:
|
||||
batch:
|
||||
timeout: 1s
|
||||
memory_limiter:
|
||||
limit_mib: 512
|
||||
|
||||
exporters:
|
||||
ophion:
|
||||
endpoint: http://server:8080
|
||||
</code></pre>
|
||||
<h3>5.2 Server (Go API)</h3>
|
||||
<p><strong>Endpoints principais:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Endpoint</th>
|
||||
<th>Método</th>
|
||||
<th>Descrição</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>/api/v1/traces</code></td>
|
||||
<td>POST</td>
|
||||
<td>Ingestão de traces</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>/api/v1/metrics</code></td>
|
||||
<td>POST</td>
|
||||
<td>Ingestão de métricas</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>/api/v1/logs</code></td>
|
||||
<td>POST</td>
|
||||
<td>Ingestão de logs</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>/api/v1/services</code></td>
|
||||
<td>GET</td>
|
||||
<td>Lista serviços</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>/api/v1/alerts</code></td>
|
||||
<td>GET/POST</td>
|
||||
<td>Gerenciamento de alertas</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>/api/v1/ai/analyze</code></td>
|
||||
<td>POST</td>
|
||||
<td>Análise por IA</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>5.3 Dashboard (Next.js)</h3>
|
||||
<p><strong>Recursos:</strong>
|
||||
- Service Map visual
|
||||
- Trace waterfall
|
||||
- Métricas em tempo real
|
||||
- Logs agregados
|
||||
- Alertas e notificações
|
||||
- AI Copilot chat</p>
|
||||
<hr />
|
||||
<h2>6. Auto-Instrumentação</h2>
|
||||
<h3>6.1 Script Universal</h3>
|
||||
<pre><code class="language-bash"># Auto-detecta linguagem
|
||||
./instrument.sh <container-name>
|
||||
|
||||
# Especifica linguagem
|
||||
./instrument.sh my-app nodejs
|
||||
./instrument.sh my-app python
|
||||
./instrument.sh my-app java
|
||||
./instrument.sh my-app dotnet
|
||||
</code></pre>
|
||||
<h3>6.2 Suporte por Linguagem</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Linguagem</th>
|
||||
<th>Método</th>
|
||||
<th>Complexidade</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>.NET</td>
|
||||
<td>Auto-instrumentation</td>
|
||||
<td>Zero code</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Node.js</td>
|
||||
<td>Auto-instrumentation</td>
|
||||
<td>Zero code</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Python</td>
|
||||
<td>Auto-instrumentation</td>
|
||||
<td>Zero code</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Java</td>
|
||||
<td>Java Agent</td>
|
||||
<td>Zero code</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Go</td>
|
||||
<td>SDK (compile-time)</td>
|
||||
<td>Pequenas mudanças</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PHP</td>
|
||||
<td>SDK</td>
|
||||
<td>Pequenas mudanças</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>6.3 Variáveis de Ambiente</h3>
|
||||
<pre><code class="language-env">OTEL_EXPORTER_OTLP_ENDPOINT=http://ophion:4318
|
||||
OTEL_SERVICE_NAME=my-service
|
||||
OTEL_RESOURCE_ATTRIBUTES=deployment.environment=production
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h2>7. AI Engine</h2>
|
||||
<h3>7.1 Funcionalidades</h3>
|
||||
<ul>
|
||||
<li><strong>Correlação de Alertas</strong>: Agrupa alertas relacionados</li>
|
||||
<li><strong>Root Cause Analysis</strong>: Identifica causa raiz</li>
|
||||
<li><strong>Previsão de Capacidade</strong>: Prevê saturação de recursos</li>
|
||||
<li><strong>Auto-Healing</strong>: Executa ações corretivas automáticas</li>
|
||||
<li><strong>Copilot</strong>: Chat para consultas em linguagem natural</li>
|
||||
</ul>
|
||||
<h3>7.2 Integração OpenAI</h3>
|
||||
<pre><code class="language-env">OPENAI_API_KEY=sk-...
|
||||
AI_MODEL=gpt-4
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h2>8. Deploy</h2>
|
||||
<h3>8.1 Quick Start (Docker)</h3>
|
||||
<pre><code class="language-bash">git clone https://github.com/bigtux/ophion.git
|
||||
cd ophion
|
||||
docker compose up -d
|
||||
</code></pre>
|
||||
<h3>8.2 Acessos</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Serviço</th>
|
||||
<th>URL</th>
|
||||
<th>Porta</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Dashboard</td>
|
||||
<td>http://localhost:3000</td>
|
||||
<td>3000</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API</td>
|
||||
<td>http://localhost:8080</td>
|
||||
<td>8080</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OTLP gRPC</td>
|
||||
<td>localhost:4317</td>
|
||||
<td>4317</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OTLP HTTP</td>
|
||||
<td>localhost:4318</td>
|
||||
<td>4318</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>8.3 Produção</h3>
|
||||
<pre><code class="language-bash"># Com install.sh
|
||||
./install.sh --production
|
||||
|
||||
# Ou manualmente
|
||||
docker compose -f docker-compose.prod.yml up -d
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h2>9. Requisitos do Sistema</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Recurso</th>
|
||||
<th>Mínimo</th>
|
||||
<th>Recomendado</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>CPU</td>
|
||||
<td>2 cores</td>
|
||||
<td>4+ cores</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>RAM</td>
|
||||
<td>4 GB</td>
|
||||
<td>8+ GB</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Disco</td>
|
||||
<td>20 GB SSD</td>
|
||||
<td>100+ GB SSD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Docker</td>
|
||||
<td>20.10+</td>
|
||||
<td>Latest</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Docker Compose</td>
|
||||
<td>v2+</td>
|
||||
<td>Latest</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<h2>10. Configuração</h2>
|
||||
<h3>10.1 Variáveis de Ambiente</h3>
|
||||
<pre><code class="language-env"># Server
|
||||
PORT=8080
|
||||
DATABASE_URL=postgres://user:pass@localhost:5432/ophion
|
||||
REDIS_URL=redis://localhost:6379
|
||||
CLICKHOUSE_URL=clickhouse://localhost:9000
|
||||
|
||||
# Auth
|
||||
JWT_SECRET=your-secret
|
||||
AGENT_KEY=agent-secret-key
|
||||
|
||||
# AI
|
||||
OPENAI_API_KEY=sk-...
|
||||
AI_ENABLED=true
|
||||
|
||||
# Notifications
|
||||
TELEGRAM_BOT_TOKEN=...
|
||||
TELEGRAM_CHAT_ID=...
|
||||
</code></pre>
|
||||
<h3>10.2 Configuração do Collector</h3>
|
||||
<pre><code class="language-yaml"># otel-collector-config.yaml
|
||||
receivers:
|
||||
otlp:
|
||||
protocols:
|
||||
grpc:
|
||||
endpoint: 0.0.0.0:4317
|
||||
http:
|
||||
endpoint: 0.0.0.0:4318
|
||||
|
||||
processors:
|
||||
batch:
|
||||
timeout: 1s
|
||||
send_batch_size: 1024
|
||||
|
||||
exporters:
|
||||
otlphttp:
|
||||
endpoint: http://server:8080/api/v1
|
||||
|
||||
service:
|
||||
pipelines:
|
||||
traces:
|
||||
receivers: [otlp]
|
||||
processors: [batch]
|
||||
exporters: [otlphttp]
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h2>11. Segurança</h2>
|
||||
<ul>
|
||||
<li>Autenticação JWT para dashboard</li>
|
||||
<li>API Key para agents (<code>AGENT_KEY</code>)</li>
|
||||
<li>TLS opcional para OTLP</li>
|
||||
<li>Isolamento de rede via Docker</li>
|
||||
<li>Logs de auditoria</li>
|
||||
</ul>
|
||||
<hr />
|
||||
<h2>12. Desenvolvimento</h2>
|
||||
<pre><code class="language-bash"># Backend (Go)
|
||||
go run ./cmd/server
|
||||
|
||||
# Frontend (Next.js)
|
||||
cd dashboard
|
||||
npm install
|
||||
npm run dev
|
||||
|
||||
# Testes
|
||||
go test ./...
|
||||
</code></pre>
|
||||
<hr />
|
||||
<h2>13. Troubleshooting</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Problema</th>
|
||||
<th>Solução</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Traces não aparecem</td>
|
||||
<td>Verificar OTEL_EXPORTER_OTLP_ENDPOINT</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Dashboard lento</td>
|
||||
<td>Aumentar RAM do ClickHouse</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Collector crash</td>
|
||||
<td>Verificar memory_limiter no config</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Auth falhando</td>
|
||||
<td>Verificar JWT_SECRET</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<h2>14. Licença</h2>
|
||||
<p>AGPL-3.0 (Community Edition)</p>
|
||||
<hr />
|
||||
<p><em>Documento gerado automaticamente - OPHION</em></p>
|
||||
</body>
|
||||
</html>
|
||||
352
docs/manual_tecnico.md
Normal file
352
docs/manual_tecnico.md
Normal file
@@ -0,0 +1,352 @@
|
||||
# OPHION - Manual Técnico
|
||||
|
||||
## Plataforma de Observabilidade com IA
|
||||
|
||||
---
|
||||
|
||||
## 1. Visão Geral
|
||||
|
||||
**OPHION** é uma plataforma de observabilidade open source que combina **métricas, logs e traces** em uma única solução, potencializada por **inteligência artificial** para monitoramento proativo e auto-healing.
|
||||
|
||||
---
|
||||
|
||||
## 2. Stack Tecnológico
|
||||
|
||||
| Camada | Tecnologia | Função |
|
||||
|--------|------------|--------|
|
||||
| API Server | Go 1.22 | Backend principal |
|
||||
| Dashboard | Next.js + TypeScript | Interface web |
|
||||
| Collector | OpenTelemetry Collector | Ingestão de telemetria |
|
||||
| Database | PostgreSQL | Dados estruturados |
|
||||
| Time Series | ClickHouse | Métricas de alta performance |
|
||||
| Cache | Redis | Cache e filas |
|
||||
| Container | Docker Compose | Orquestração |
|
||||
|
||||
---
|
||||
|
||||
## 3. Arquitetura do Sistema
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ APLICAÇÕES INSTRUMENTADAS │
|
||||
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
|
||||
│ │ Node.js │ │ Python │ │ Java │ │ .NET │ │ Go │ │
|
||||
│ └────┬────┘ └────┬────┘ └────┬────┘ └────┬────┘ └────┬────┘ │
|
||||
│ └───────────┴───────────┼───────────┴───────────┘ │
|
||||
│ │ OTLP (4317/4318) │
|
||||
└───────────────────────────────┼─────────────────────────────────┘
|
||||
│
|
||||
┌───────────────────────────────┼─────────────────────────────────┐
|
||||
│ OPHION STACK ▼ │
|
||||
│ ┌─────────────────────────────────────────────────┐ │
|
||||
│ │ OpenTelemetry Collector │ │
|
||||
│ │ (receivers → processors → exporters) │ │
|
||||
│ └─────────────────────────┬───────────────────────┘ │
|
||||
│ │ │
|
||||
│ ┌────────────────┐ ▼ ┌────────────────┐ │
|
||||
│ │ Dashboard │◄───► Server ◄──►│ PostgreSQL │ │
|
||||
│ │ (Next.js) │ (Go API) │ ClickHouse │ │
|
||||
│ │ :3000 │ :8080 │ Redis │ │
|
||||
│ └────────────────┘ └────────────────┘ │
|
||||
│ │
|
||||
│ ┌────────────────────────────────────────────────┐ │
|
||||
│ │ AI Engine (Copilot) │ │
|
||||
│ │ - Correlação de alertas │ │
|
||||
│ │ - Previsão de capacidade │ │
|
||||
│ │ - Auto-healing │ │
|
||||
│ └────────────────────────────────────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Estrutura de Diretórios
|
||||
|
||||
```
|
||||
ophion/
|
||||
├── cmd/
|
||||
│ ├── server/ # API Server (Go)
|
||||
│ └── agent/ # Agent de coleta
|
||||
├── internal/ # Código interno Go
|
||||
│ ├── api/ # Handlers HTTP
|
||||
│ ├── db/ # Repositórios
|
||||
│ ├── ai/ # Engine de IA
|
||||
│ └── telemetry/ # Processamento OTLP
|
||||
├── dashboard/ # Frontend Next.js
|
||||
│ ├── src/
|
||||
│ │ ├── app/ # App Router
|
||||
│ │ ├── components/ # UI Components
|
||||
│ │ └── lib/ # Utilitários
|
||||
│ └── package.json
|
||||
├── deploy/
|
||||
│ ├── docker/ # Docker configs
|
||||
│ │ └── otel-collector-config.yaml
|
||||
│ ├── remote-agent/ # Agent remoto
|
||||
│ └── instrumentation/ # Scripts de instrumentação
|
||||
├── examples/ # Exemplos por linguagem
|
||||
│ ├── otel-nodejs/
|
||||
│ ├── otel-python/
|
||||
│ └── docker/
|
||||
├── configs/ # Configurações
|
||||
├── docs/ # Documentação
|
||||
├── instrument.sh # Script de auto-instrumentação
|
||||
├── install.sh # Instalador
|
||||
├── docker-compose.yml
|
||||
├── go.mod / go.sum
|
||||
└── server # Binário compilado
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Componentes Principais
|
||||
|
||||
### 5.1 OpenTelemetry Collector
|
||||
|
||||
**Portas:**
|
||||
- `4317` - OTLP gRPC
|
||||
- `4318` - OTLP HTTP
|
||||
|
||||
**Pipeline:**
|
||||
```yaml
|
||||
receivers:
|
||||
otlp:
|
||||
protocols:
|
||||
grpc:
|
||||
endpoint: 0.0.0.0:4317
|
||||
http:
|
||||
endpoint: 0.0.0.0:4318
|
||||
|
||||
processors:
|
||||
batch:
|
||||
timeout: 1s
|
||||
memory_limiter:
|
||||
limit_mib: 512
|
||||
|
||||
exporters:
|
||||
ophion:
|
||||
endpoint: http://server:8080
|
||||
```
|
||||
|
||||
### 5.2 Server (Go API)
|
||||
|
||||
**Endpoints principais:**
|
||||
|
||||
| Endpoint | Método | Descrição |
|
||||
|----------|--------|-----------|
|
||||
| `/api/v1/traces` | POST | Ingestão de traces |
|
||||
| `/api/v1/metrics` | POST | Ingestão de métricas |
|
||||
| `/api/v1/logs` | POST | Ingestão de logs |
|
||||
| `/api/v1/services` | GET | Lista serviços |
|
||||
| `/api/v1/alerts` | GET/POST | Gerenciamento de alertas |
|
||||
| `/api/v1/ai/analyze` | POST | Análise por IA |
|
||||
|
||||
### 5.3 Dashboard (Next.js)
|
||||
|
||||
**Recursos:**
|
||||
- Service Map visual
|
||||
- Trace waterfall
|
||||
- Métricas em tempo real
|
||||
- Logs agregados
|
||||
- Alertas e notificações
|
||||
- AI Copilot chat
|
||||
|
||||
---
|
||||
|
||||
## 6. Auto-Instrumentação
|
||||
|
||||
### 6.1 Script Universal
|
||||
|
||||
```bash
|
||||
# Auto-detecta linguagem
|
||||
./instrument.sh <container-name>
|
||||
|
||||
# Especifica linguagem
|
||||
./instrument.sh my-app nodejs
|
||||
./instrument.sh my-app python
|
||||
./instrument.sh my-app java
|
||||
./instrument.sh my-app dotnet
|
||||
```
|
||||
|
||||
### 6.2 Suporte por Linguagem
|
||||
|
||||
| Linguagem | Método | Complexidade |
|
||||
|-----------|--------|--------------|
|
||||
| .NET | Auto-instrumentation | Zero code |
|
||||
| Node.js | Auto-instrumentation | Zero code |
|
||||
| Python | Auto-instrumentation | Zero code |
|
||||
| Java | Java Agent | Zero code |
|
||||
| Go | SDK (compile-time) | Pequenas mudanças |
|
||||
| PHP | SDK | Pequenas mudanças |
|
||||
|
||||
### 6.3 Variáveis de Ambiente
|
||||
|
||||
```env
|
||||
OTEL_EXPORTER_OTLP_ENDPOINT=http://ophion:4318
|
||||
OTEL_SERVICE_NAME=my-service
|
||||
OTEL_RESOURCE_ATTRIBUTES=deployment.environment=production
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 7. AI Engine
|
||||
|
||||
### 7.1 Funcionalidades
|
||||
|
||||
- **Correlação de Alertas**: Agrupa alertas relacionados
|
||||
- **Root Cause Analysis**: Identifica causa raiz
|
||||
- **Previsão de Capacidade**: Prevê saturação de recursos
|
||||
- **Auto-Healing**: Executa ações corretivas automáticas
|
||||
- **Copilot**: Chat para consultas em linguagem natural
|
||||
|
||||
### 7.2 Integração OpenAI
|
||||
|
||||
```env
|
||||
OPENAI_API_KEY=sk-...
|
||||
AI_MODEL=gpt-4
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 8. Deploy
|
||||
|
||||
### 8.1 Quick Start (Docker)
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bigtux/ophion.git
|
||||
cd ophion
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### 8.2 Acessos
|
||||
|
||||
| Serviço | URL | Porta |
|
||||
|---------|-----|-------|
|
||||
| Dashboard | http://localhost:3000 | 3000 |
|
||||
| API | http://localhost:8080 | 8080 |
|
||||
| OTLP gRPC | localhost:4317 | 4317 |
|
||||
| OTLP HTTP | localhost:4318 | 4318 |
|
||||
|
||||
### 8.3 Produção
|
||||
|
||||
```bash
|
||||
# Com install.sh
|
||||
./install.sh --production
|
||||
|
||||
# Ou manualmente
|
||||
docker compose -f docker-compose.prod.yml up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. Requisitos do Sistema
|
||||
|
||||
| Recurso | Mínimo | Recomendado |
|
||||
|---------|--------|-------------|
|
||||
| CPU | 2 cores | 4+ cores |
|
||||
| RAM | 4 GB | 8+ GB |
|
||||
| Disco | 20 GB SSD | 100+ GB SSD |
|
||||
| Docker | 20.10+ | Latest |
|
||||
| Docker Compose | v2+ | Latest |
|
||||
|
||||
---
|
||||
|
||||
## 10. Configuração
|
||||
|
||||
### 10.1 Variáveis de Ambiente
|
||||
|
||||
```env
|
||||
# Server
|
||||
PORT=8080
|
||||
DATABASE_URL=postgres://user:pass@localhost:5432/ophion
|
||||
REDIS_URL=redis://localhost:6379
|
||||
CLICKHOUSE_URL=clickhouse://localhost:9000
|
||||
|
||||
# Auth
|
||||
JWT_SECRET=your-secret
|
||||
AGENT_KEY=agent-secret-key
|
||||
|
||||
# AI
|
||||
OPENAI_API_KEY=sk-...
|
||||
AI_ENABLED=true
|
||||
|
||||
# Notifications
|
||||
TELEGRAM_BOT_TOKEN=...
|
||||
TELEGRAM_CHAT_ID=...
|
||||
```
|
||||
|
||||
### 10.2 Configuração do Collector
|
||||
|
||||
```yaml
|
||||
# otel-collector-config.yaml
|
||||
receivers:
|
||||
otlp:
|
||||
protocols:
|
||||
grpc:
|
||||
endpoint: 0.0.0.0:4317
|
||||
http:
|
||||
endpoint: 0.0.0.0:4318
|
||||
|
||||
processors:
|
||||
batch:
|
||||
timeout: 1s
|
||||
send_batch_size: 1024
|
||||
|
||||
exporters:
|
||||
otlphttp:
|
||||
endpoint: http://server:8080/api/v1
|
||||
|
||||
service:
|
||||
pipelines:
|
||||
traces:
|
||||
receivers: [otlp]
|
||||
processors: [batch]
|
||||
exporters: [otlphttp]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. Segurança
|
||||
|
||||
- Autenticação JWT para dashboard
|
||||
- API Key para agents (`AGENT_KEY`)
|
||||
- TLS opcional para OTLP
|
||||
- Isolamento de rede via Docker
|
||||
- Logs de auditoria
|
||||
|
||||
---
|
||||
|
||||
## 12. Desenvolvimento
|
||||
|
||||
```bash
|
||||
# Backend (Go)
|
||||
go run ./cmd/server
|
||||
|
||||
# Frontend (Next.js)
|
||||
cd dashboard
|
||||
npm install
|
||||
npm run dev
|
||||
|
||||
# Testes
|
||||
go test ./...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 13. Troubleshooting
|
||||
|
||||
| Problema | Solução |
|
||||
|----------|---------|
|
||||
| Traces não aparecem | Verificar OTEL_EXPORTER_OTLP_ENDPOINT |
|
||||
| Dashboard lento | Aumentar RAM do ClickHouse |
|
||||
| Collector crash | Verificar memory_limiter no config |
|
||||
| Auth falhando | Verificar JWT_SECRET |
|
||||
|
||||
---
|
||||
|
||||
## 14. Licença
|
||||
|
||||
AGPL-3.0 (Community Edition)
|
||||
|
||||
---
|
||||
|
||||
*Documento gerado automaticamente - OPHION*
|
||||
BIN
docs/manual_tecnico.pdf
Normal file
BIN
docs/manual_tecnico.pdf
Normal file
Binary file not shown.
453
docs/manual_vendas.html
Normal file
453
docs/manual_vendas.html
Normal file
@@ -0,0 +1,453 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="pt-BR">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>OPHION - Manual de Vendas</title>
|
||||
<style>
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
body {
|
||||
font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
||||
color: #2D3142;
|
||||
background: white;
|
||||
line-height: 1.6;
|
||||
padding: 40px 60px;
|
||||
max-width: 900px;
|
||||
margin: 0 auto;
|
||||
}
|
||||
h1 {
|
||||
color: #1A7A4C;
|
||||
font-size: 28px;
|
||||
margin-bottom: 20px;
|
||||
padding-bottom: 10px;
|
||||
border-bottom: 3px solid #1A7A4C;
|
||||
}
|
||||
h2 {
|
||||
color: #1A7A4C;
|
||||
font-size: 22px;
|
||||
margin-top: 30px;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
h3 {
|
||||
color: #1A7A4C;
|
||||
font-size: 18px;
|
||||
margin-top: 20px;
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
p {
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
margin: 20px 0;
|
||||
}
|
||||
th, td {
|
||||
border: 1px solid #E2E4E8;
|
||||
padding: 12px;
|
||||
text-align: left;
|
||||
}
|
||||
th {
|
||||
background: #1A7A4C;
|
||||
color: white;
|
||||
font-weight: 600;
|
||||
}
|
||||
tr:nth-child(even) {
|
||||
background: #f9f9f9;
|
||||
}
|
||||
code {
|
||||
background: #f4f4f4;
|
||||
padding: 2px 6px;
|
||||
border-radius: 4px;
|
||||
font-family: 'Courier New', monospace;
|
||||
font-size: 14px;
|
||||
}
|
||||
pre {
|
||||
background: #1e1e1e;
|
||||
color: #d4d4d4;
|
||||
padding: 20px;
|
||||
border-radius: 8px;
|
||||
overflow-x: auto;
|
||||
margin: 20px 0;
|
||||
}
|
||||
pre code {
|
||||
background: none;
|
||||
padding: 0;
|
||||
color: inherit;
|
||||
}
|
||||
ul, ol {
|
||||
margin: 15px 0;
|
||||
padding-left: 30px;
|
||||
}
|
||||
li {
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
blockquote {
|
||||
border-left: 4px solid #1A7A4C;
|
||||
padding-left: 20px;
|
||||
margin: 20px 0;
|
||||
font-style: italic;
|
||||
color: #555;
|
||||
}
|
||||
hr {
|
||||
border: none;
|
||||
border-top: 2px solid #E2E4E8;
|
||||
margin: 30px 0;
|
||||
}
|
||||
strong {
|
||||
color: #1A7A4C;
|
||||
}
|
||||
.page-break {
|
||||
page-break-after: always;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>OPHION - Manual de Vendas</h1>
|
||||
<h2>Observabilidade Inteligente para o Mundo Real</h2>
|
||||
<hr />
|
||||
<h2>1. Proposta de Valor</h2>
|
||||
<p><strong>OPHION</strong> é a primeira plataforma de observabilidade open source que combina <strong>métricas, logs e traces</strong> com <strong>inteligência artificial</strong> para não apenas monitorar, mas <strong>prever e resolver problemas automaticamente</strong>.</p>
|
||||
<blockquote>
|
||||
<p><em>"Não apenas veja seus sistemas. Entenda-os."</em></p>
|
||||
</blockquote>
|
||||
<h3>O Problema de Observabilidade Hoje</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Desafio</th>
|
||||
<th>Impacto no Negócio</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Ferramentas fragmentadas</td>
|
||||
<td>Tempo perdido alternando dashboards</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Alertas sem contexto</td>
|
||||
<td>Alert fatigue, problemas ignorados</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Diagnóstico manual</td>
|
||||
<td>Horas para encontrar root cause</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Dashboards estáticos</td>
|
||||
<td>Não preveem problemas</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Custos por volume</td>
|
||||
<td>Contas astronômicas (Datadog, New Relic)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>A Diferença OPHION</h3>
|
||||
<p>✅ <strong>Uma plataforma, toda telemetria</strong> (métricas, logs, traces)<br />
|
||||
✅ <strong>IA que correlaciona</strong> alertas e identifica root cause<br />
|
||||
✅ <strong>Previsão de capacidade</strong> antes do problema acontecer<br />
|
||||
✅ <strong>Auto-healing</strong> para ações corretivas automáticas<br />
|
||||
✅ <strong>Custo previsível</strong> — não cobra por volume</p>
|
||||
<hr />
|
||||
<h2>2. Público-Alvo</h2>
|
||||
<h3>2.1 Equipes de SRE / Platform Engineering</h3>
|
||||
<ul>
|
||||
<li>Responsáveis por uptime e performance</li>
|
||||
<li>Precisam de visibilidade cross-service</li>
|
||||
<li>Buscam reduzir MTTR</li>
|
||||
</ul>
|
||||
<h3>2.2 DevOps / Infrastructure Teams</h3>
|
||||
<ul>
|
||||
<li>Gerenciam dezenas/centenas de serviços</li>
|
||||
<li>Precisam de troubleshooting rápido</li>
|
||||
<li>Querem automatizar operações</li>
|
||||
</ul>
|
||||
<h3>2.3 CTOs e VPs de Engineering</h3>
|
||||
<ul>
|
||||
<li>Buscam reduzir custos de observabilidade</li>
|
||||
<li>Precisam de métricas de SLA/SLO</li>
|
||||
<li>Querem visão executiva de saúde</li>
|
||||
</ul>
|
||||
<h3>2.4 Startups em Crescimento</h3>
|
||||
<ul>
|
||||
<li>Infraestrutura ficando complexa</li>
|
||||
<li>Budget limitado para ferramentas enterprise</li>
|
||||
<li>Precisam escalar observabilidade</li>
|
||||
</ul>
|
||||
<h3>2.5 Empresas com Compliance</h3>
|
||||
<ul>
|
||||
<li>Precisam manter dados on-premise</li>
|
||||
<li>Regulamentações de soberania de dados</li>
|
||||
<li>Auditoria e rastreabilidade</li>
|
||||
</ul>
|
||||
<hr />
|
||||
<h2>3. Funcionalidades</h2>
|
||||
<h3>📊 Unified Telemetry</h3>
|
||||
<p>Uma única interface para tudo:
|
||||
- <strong>Métricas</strong>: CPU, memória, latência, custom metrics
|
||||
- <strong>Logs</strong>: Agregados, pesquisáveis, correlacionados
|
||||
- <strong>Traces</strong>: Distributed tracing com waterfall</p>
|
||||
<h3>🗺️ Service Map</h3>
|
||||
<p>Visualize sua arquitetura em tempo real:
|
||||
- Dependências entre serviços
|
||||
- Latência por salto
|
||||
- Detecção de gargalos
|
||||
- Health status por serviço</p>
|
||||
<h3>🤖 AI Copilot</h3>
|
||||
<p>Inteligência artificial integrada:
|
||||
- <strong>Chat em linguagem natural</strong>: "Por que o checkout está lento?"
|
||||
- <strong>Correlação de alertas</strong>: Agrupa relacionados automaticamente
|
||||
- <strong>Root Cause Analysis</strong>: Identifica a origem do problema
|
||||
- <strong>Sugestões de correção</strong>: O que fazer para resolver</p>
|
||||
<h3>🔮 Predictive Analytics</h3>
|
||||
<p>Antecipe problemas:
|
||||
- Previsão de saturação de recursos
|
||||
- Detecção de anomalias
|
||||
- Tendências de degradação
|
||||
- Alertas proativos</p>
|
||||
<h3>⚡ Auto-Healing</h3>
|
||||
<p>Ações automáticas:
|
||||
- Restart de containers
|
||||
- Scale-up/down automático
|
||||
- Rollback de deployments
|
||||
- Notificações inteligentes</p>
|
||||
<h3>🔧 Auto-Instrumentação</h3>
|
||||
<p>Zero code para começar:
|
||||
- Node.js, Python, Java, .NET
|
||||
- Script único: <code>./instrument.sh my-app</code>
|
||||
- OpenTelemetry nativo
|
||||
- Suporte a todas as linguagens populares</p>
|
||||
<h3>📈 SLO/SLI Management</h3>
|
||||
<p>Gerencie objetivos de serviço:
|
||||
- Definição de SLOs
|
||||
- Error budgets
|
||||
- Burn rate alerts
|
||||
- Relatórios de compliance</p>
|
||||
<h3>🔔 Alerting Inteligente</h3>
|
||||
<p>Alertas que fazem sentido:
|
||||
- Correlação para reduzir ruído
|
||||
- Escalation automático
|
||||
- Integração: Telegram, Slack, PagerDuty
|
||||
- Silenciamento inteligente</p>
|
||||
<hr />
|
||||
<h2>4. Benefícios</h2>
|
||||
<h3>Para SRE/DevOps</h3>
|
||||
<p>✅ <strong>MTTR 10x menor</strong>: Root cause em segundos, não horas<br />
|
||||
✅ <strong>Alert fatigue eliminado</strong>: IA agrupa e prioriza<br />
|
||||
✅ <strong>Troubleshooting visual</strong>: Service map + traces<br />
|
||||
✅ <strong>Menos toil</strong>: Auto-healing reduz intervenções manuais</p>
|
||||
<h3>Para a Empresa</h3>
|
||||
<p>✅ <strong>Custo previsível</strong>: Sem surpresas na fatura<br />
|
||||
✅ <strong>Uptime melhorado</strong>: Previsão de problemas<br />
|
||||
✅ <strong>Compliance</strong>: Dados on-premise, auditáveis<br />
|
||||
✅ <strong>ROI rápido</strong>: Implementação em horas, não semanas</p>
|
||||
<h3>Para Desenvolvedores</h3>
|
||||
<p>✅ <strong>Debug em produção</strong>: Traces detalhados<br />
|
||||
✅ <strong>Contexto completo</strong>: Logs + traces correlacionados<br />
|
||||
✅ <strong>Zero config</strong>: Auto-instrumentação<br />
|
||||
✅ <strong>Ownership</strong>: Veja o impacto do seu código</p>
|
||||
<hr />
|
||||
<h2>5. Casos de Uso</h2>
|
||||
<h3>Caso 1: E-commerce em Black Friday</h3>
|
||||
<blockquote>
|
||||
<p>Um e-commerce com 500k requests/min usa OPHION para monitorar a Black Friday. O AI Copilot detecta degradação no serviço de pagamentos 15 minutos antes de virar problema. Auto-healing escala o serviço automaticamente. <strong>Zero downtime, R$ 2M em vendas salvas</strong>.</p>
|
||||
</blockquote>
|
||||
<h3>Caso 2: Fintech com Compliance</h3>
|
||||
<blockquote>
|
||||
<p>Uma fintech precisa de observabilidade mas não pode enviar dados para cloud pública. OPHION roda on-premise, com logs criptografados e trilha de auditoria completa. <strong>Compliance SOC 2 atendido</strong>.</p>
|
||||
</blockquote>
|
||||
<h3>Caso 3: Startup Escalonando</h3>
|
||||
<blockquote>
|
||||
<p>Uma startup cresceu de 5 para 50 microserviços em 1 ano. O service map do OPHION mostra dependências que ninguém documentou. Root cause analysis reduz MTTR de 4h para 10 minutos. <strong>Equipe de 3 pessoas gerencia tudo</strong>.</p>
|
||||
</blockquote>
|
||||
<h3>Caso 4: Migração para Kubernetes</h3>
|
||||
<blockquote>
|
||||
<p>Uma empresa migra para K8s e perde visibilidade. OPHION com auto-instrumentação cobre todos os pods sem mudar código. <strong>Observabilidade completa em 1 dia</strong>.</p>
|
||||
</blockquote>
|
||||
<hr />
|
||||
<h2>6. Comparativo de Mercado</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Feature</th>
|
||||
<th>OPHION</th>
|
||||
<th>Datadog</th>
|
||||
<th>Grafana Cloud</th>
|
||||
<th>New Relic</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Métricas + Logs + Traces</td>
|
||||
<td>✅</td>
|
||||
<td>✅</td>
|
||||
<td>✅</td>
|
||||
<td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>AI Copilot</strong></td>
|
||||
<td>✅</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
<td>Parcial</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Auto-Healing</strong></td>
|
||||
<td>✅</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Correlação IA</strong></td>
|
||||
<td>✅</td>
|
||||
<td>💰💰</td>
|
||||
<td>❌</td>
|
||||
<td>💰💰</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Previsão de Capacidade</strong></td>
|
||||
<td>✅</td>
|
||||
<td>💰💰</td>
|
||||
<td>❌</td>
|
||||
<td>💰</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Open Source</td>
|
||||
<td>✅</td>
|
||||
<td>❌</td>
|
||||
<td>Parcial</td>
|
||||
<td>❌</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>On-Premise</td>
|
||||
<td>✅</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Auto-instrumentação</td>
|
||||
<td>✅</td>
|
||||
<td>💰</td>
|
||||
<td>❌</td>
|
||||
<td>💰</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Custo por volume</strong></td>
|
||||
<td>❌ Fixo</td>
|
||||
<td>💰💰💰</td>
|
||||
<td>💰💰</td>
|
||||
<td>💰💰💰</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<h2>7. Modelo de Implantação</h2>
|
||||
<h3>Community Edition (Open Source)</h3>
|
||||
<ul>
|
||||
<li>Todas as funcionalidades core</li>
|
||||
<li>Self-hosted</li>
|
||||
<li>Suporte via comunidade</li>
|
||||
<li>Licença AGPL-3.0</li>
|
||||
</ul>
|
||||
<h3>Enterprise Edition</h3>
|
||||
<ul>
|
||||
<li>SLA garantido</li>
|
||||
<li>Suporte dedicado</li>
|
||||
<li>Funcionalidades avançadas de compliance</li>
|
||||
<li>Multi-tenancy</li>
|
||||
</ul>
|
||||
<h3>Managed (Cloud)</h3>
|
||||
<ul>
|
||||
<li>OPHION gerenciado</li>
|
||||
<li>SLA 99.9%</li>
|
||||
<li>Backups automáticos</li>
|
||||
<li>Updates gerenciados</li>
|
||||
</ul>
|
||||
<hr />
|
||||
<h2>8. Integrações</h2>
|
||||
<h3>Plataformas</h3>
|
||||
<ul>
|
||||
<li>Kubernetes, Docker, AWS, GCP, Azure</li>
|
||||
</ul>
|
||||
<h3>Linguagens (Auto-instrumentação)</h3>
|
||||
<ul>
|
||||
<li>Node.js, Python, Java, .NET, Go, PHP</li>
|
||||
</ul>
|
||||
<h3>Alerting</h3>
|
||||
<ul>
|
||||
<li>Telegram, Slack, PagerDuty, OpsGenie, Email</li>
|
||||
</ul>
|
||||
<h3>CI/CD</h3>
|
||||
<ul>
|
||||
<li>GitHub Actions, GitLab CI, Jenkins</li>
|
||||
</ul>
|
||||
<h3>Standards</h3>
|
||||
<ul>
|
||||
<li>OpenTelemetry, Prometheus, Jaeger</li>
|
||||
</ul>
|
||||
<hr />
|
||||
<h2>9. Implementação</h2>
|
||||
<h3>Timeline Típico</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Fase</th>
|
||||
<th>Duração</th>
|
||||
<th>Atividade</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Setup</td>
|
||||
<td>1h</td>
|
||||
<td>docker compose up</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Instrumentação</td>
|
||||
<td>1-2h</td>
|
||||
<td>Auto-instrument serviços críticos</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Configuração</td>
|
||||
<td>2-4h</td>
|
||||
<td>Alertas, dashboards, SLOs</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Produção</td>
|
||||
<td>1 semana</td>
|
||||
<td>Refinamento e ajustes</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Pré-requisitos</h3>
|
||||
<ul>
|
||||
<li>Docker 20.10+</li>
|
||||
<li>4GB RAM mínimo</li>
|
||||
<li>Acesso aos serviços a monitorar</li>
|
||||
</ul>
|
||||
<hr />
|
||||
<h2>10. Próximos Passos</h2>
|
||||
<ol>
|
||||
<li><strong>Demo</strong>: Veja OPHION em ação (15 min)</li>
|
||||
<li><strong>POC</strong>: Instale em ambiente de teste</li>
|
||||
<li><strong>Pilot</strong>: Instrumente 3-5 serviços críticos</li>
|
||||
<li><strong>Rollout</strong>: Expanda para toda infraestrutura</li>
|
||||
<li><strong>Optimize</strong>: Configure AI e auto-healing</li>
|
||||
</ol>
|
||||
<hr />
|
||||
<h2>11. Suporte</h2>
|
||||
<ul>
|
||||
<li>📚 Documentação: docs.ophion.io</li>
|
||||
<li>💬 Comunidade: Discord</li>
|
||||
<li>📧 Enterprise: contato@ophion.io</li>
|
||||
</ul>
|
||||
<hr />
|
||||
<p><em>OPHION - Observabilidade que pensa por você</em></p>
|
||||
</body>
|
||||
</html>
|
||||
256
docs/manual_vendas.md
Normal file
256
docs/manual_vendas.md
Normal file
@@ -0,0 +1,256 @@
|
||||
# OPHION - Manual de Vendas
|
||||
|
||||
## Observabilidade Inteligente para o Mundo Real
|
||||
|
||||
---
|
||||
|
||||
## 1. Proposta de Valor
|
||||
|
||||
**OPHION** é a primeira plataforma de observabilidade open source que combina **métricas, logs e traces** com **inteligência artificial** para não apenas monitorar, mas **prever e resolver problemas automaticamente**.
|
||||
|
||||
> *"Não apenas veja seus sistemas. Entenda-os."*
|
||||
|
||||
### O Problema de Observabilidade Hoje
|
||||
|
||||
| Desafio | Impacto no Negócio |
|
||||
|---------|-------------------|
|
||||
| Ferramentas fragmentadas | Tempo perdido alternando dashboards |
|
||||
| Alertas sem contexto | Alert fatigue, problemas ignorados |
|
||||
| Diagnóstico manual | Horas para encontrar root cause |
|
||||
| Dashboards estáticos | Não preveem problemas |
|
||||
| Custos por volume | Contas astronômicas (Datadog, New Relic) |
|
||||
|
||||
### A Diferença OPHION
|
||||
|
||||
✅ **Uma plataforma, toda telemetria** (métricas, logs, traces)
|
||||
✅ **IA que correlaciona** alertas e identifica root cause
|
||||
✅ **Previsão de capacidade** antes do problema acontecer
|
||||
✅ **Auto-healing** para ações corretivas automáticas
|
||||
✅ **Custo previsível** — não cobra por volume
|
||||
|
||||
---
|
||||
|
||||
## 2. Público-Alvo
|
||||
|
||||
### 2.1 Equipes de SRE / Platform Engineering
|
||||
- Responsáveis por uptime e performance
|
||||
- Precisam de visibilidade cross-service
|
||||
- Buscam reduzir MTTR
|
||||
|
||||
### 2.2 DevOps / Infrastructure Teams
|
||||
- Gerenciam dezenas/centenas de serviços
|
||||
- Precisam de troubleshooting rápido
|
||||
- Querem automatizar operações
|
||||
|
||||
### 2.3 CTOs e VPs de Engineering
|
||||
- Buscam reduzir custos de observabilidade
|
||||
- Precisam de métricas de SLA/SLO
|
||||
- Querem visão executiva de saúde
|
||||
|
||||
### 2.4 Startups em Crescimento
|
||||
- Infraestrutura ficando complexa
|
||||
- Budget limitado para ferramentas enterprise
|
||||
- Precisam escalar observabilidade
|
||||
|
||||
### 2.5 Empresas com Compliance
|
||||
- Precisam manter dados on-premise
|
||||
- Regulamentações de soberania de dados
|
||||
- Auditoria e rastreabilidade
|
||||
|
||||
---
|
||||
|
||||
## 3. Funcionalidades
|
||||
|
||||
### 📊 Unified Telemetry
|
||||
Uma única interface para tudo:
|
||||
- **Métricas**: CPU, memória, latência, custom metrics
|
||||
- **Logs**: Agregados, pesquisáveis, correlacionados
|
||||
- **Traces**: Distributed tracing com waterfall
|
||||
|
||||
### 🗺️ Service Map
|
||||
Visualize sua arquitetura em tempo real:
|
||||
- Dependências entre serviços
|
||||
- Latência por salto
|
||||
- Detecção de gargalos
|
||||
- Health status por serviço
|
||||
|
||||
### 🤖 AI Copilot
|
||||
Inteligência artificial integrada:
|
||||
- **Chat em linguagem natural**: "Por que o checkout está lento?"
|
||||
- **Correlação de alertas**: Agrupa relacionados automaticamente
|
||||
- **Root Cause Analysis**: Identifica a origem do problema
|
||||
- **Sugestões de correção**: O que fazer para resolver
|
||||
|
||||
### 🔮 Predictive Analytics
|
||||
Antecipe problemas:
|
||||
- Previsão de saturação de recursos
|
||||
- Detecção de anomalias
|
||||
- Tendências de degradação
|
||||
- Alertas proativos
|
||||
|
||||
### ⚡ Auto-Healing
|
||||
Ações automáticas:
|
||||
- Restart de containers
|
||||
- Scale-up/down automático
|
||||
- Rollback de deployments
|
||||
- Notificações inteligentes
|
||||
|
||||
### 🔧 Auto-Instrumentação
|
||||
Zero code para começar:
|
||||
- Node.js, Python, Java, .NET
|
||||
- Script único: `./instrument.sh my-app`
|
||||
- OpenTelemetry nativo
|
||||
- Suporte a todas as linguagens populares
|
||||
|
||||
### 📈 SLO/SLI Management
|
||||
Gerencie objetivos de serviço:
|
||||
- Definição de SLOs
|
||||
- Error budgets
|
||||
- Burn rate alerts
|
||||
- Relatórios de compliance
|
||||
|
||||
### 🔔 Alerting Inteligente
|
||||
Alertas que fazem sentido:
|
||||
- Correlação para reduzir ruído
|
||||
- Escalation automático
|
||||
- Integração: Telegram, Slack, PagerDuty
|
||||
- Silenciamento inteligente
|
||||
|
||||
---
|
||||
|
||||
## 4. Benefícios
|
||||
|
||||
### Para SRE/DevOps
|
||||
|
||||
✅ **MTTR 10x menor**: Root cause em segundos, não horas
|
||||
✅ **Alert fatigue eliminado**: IA agrupa e prioriza
|
||||
✅ **Troubleshooting visual**: Service map + traces
|
||||
✅ **Menos toil**: Auto-healing reduz intervenções manuais
|
||||
|
||||
### Para a Empresa
|
||||
|
||||
✅ **Custo previsível**: Sem surpresas na fatura
|
||||
✅ **Uptime melhorado**: Previsão de problemas
|
||||
✅ **Compliance**: Dados on-premise, auditáveis
|
||||
✅ **ROI rápido**: Implementação em horas, não semanas
|
||||
|
||||
### Para Desenvolvedores
|
||||
|
||||
✅ **Debug em produção**: Traces detalhados
|
||||
✅ **Contexto completo**: Logs + traces correlacionados
|
||||
✅ **Zero config**: Auto-instrumentação
|
||||
✅ **Ownership**: Veja o impacto do seu código
|
||||
|
||||
---
|
||||
|
||||
## 5. Casos de Uso
|
||||
|
||||
### Caso 1: E-commerce em Black Friday
|
||||
> Um e-commerce com 500k requests/min usa OPHION para monitorar a Black Friday. O AI Copilot detecta degradação no serviço de pagamentos 15 minutos antes de virar problema. Auto-healing escala o serviço automaticamente. **Zero downtime, R$ 2M em vendas salvas**.
|
||||
|
||||
### Caso 2: Fintech com Compliance
|
||||
> Uma fintech precisa de observabilidade mas não pode enviar dados para cloud pública. OPHION roda on-premise, com logs criptografados e trilha de auditoria completa. **Compliance SOC 2 atendido**.
|
||||
|
||||
### Caso 3: Startup Escalonando
|
||||
> Uma startup cresceu de 5 para 50 microserviços em 1 ano. O service map do OPHION mostra dependências que ninguém documentou. Root cause analysis reduz MTTR de 4h para 10 minutos. **Equipe de 3 pessoas gerencia tudo**.
|
||||
|
||||
### Caso 4: Migração para Kubernetes
|
||||
> Uma empresa migra para K8s e perde visibilidade. OPHION com auto-instrumentação cobre todos os pods sem mudar código. **Observabilidade completa em 1 dia**.
|
||||
|
||||
---
|
||||
|
||||
## 6. Comparativo de Mercado
|
||||
|
||||
| Feature | OPHION | Datadog | Grafana Cloud | New Relic |
|
||||
|---------|--------|---------|---------------|-----------|
|
||||
| Métricas + Logs + Traces | ✅ | ✅ | ✅ | ✅ |
|
||||
| **AI Copilot** | ✅ | ❌ | ❌ | Parcial |
|
||||
| **Auto-Healing** | ✅ | ❌ | ❌ | ❌ |
|
||||
| **Correlação IA** | ✅ | 💰💰 | ❌ | 💰💰 |
|
||||
| **Previsão de Capacidade** | ✅ | 💰💰 | ❌ | 💰 |
|
||||
| Open Source | ✅ | ❌ | Parcial | ❌ |
|
||||
| On-Premise | ✅ | ❌ | ❌ | ❌ |
|
||||
| Auto-instrumentação | ✅ | 💰 | ❌ | 💰 |
|
||||
| **Custo por volume** | ❌ Fixo | 💰💰💰 | 💰💰 | 💰💰💰 |
|
||||
|
||||
---
|
||||
|
||||
## 7. Modelo de Implantação
|
||||
|
||||
### Community Edition (Open Source)
|
||||
- Todas as funcionalidades core
|
||||
- Self-hosted
|
||||
- Suporte via comunidade
|
||||
- Licença AGPL-3.0
|
||||
|
||||
### Enterprise Edition
|
||||
- SLA garantido
|
||||
- Suporte dedicado
|
||||
- Funcionalidades avançadas de compliance
|
||||
- Multi-tenancy
|
||||
|
||||
### Managed (Cloud)
|
||||
- OPHION gerenciado
|
||||
- SLA 99.9%
|
||||
- Backups automáticos
|
||||
- Updates gerenciados
|
||||
|
||||
---
|
||||
|
||||
## 8. Integrações
|
||||
|
||||
### Plataformas
|
||||
- Kubernetes, Docker, AWS, GCP, Azure
|
||||
|
||||
### Linguagens (Auto-instrumentação)
|
||||
- Node.js, Python, Java, .NET, Go, PHP
|
||||
|
||||
### Alerting
|
||||
- Telegram, Slack, PagerDuty, OpsGenie, Email
|
||||
|
||||
### CI/CD
|
||||
- GitHub Actions, GitLab CI, Jenkins
|
||||
|
||||
### Standards
|
||||
- OpenTelemetry, Prometheus, Jaeger
|
||||
|
||||
---
|
||||
|
||||
## 9. Implementação
|
||||
|
||||
### Timeline Típico
|
||||
|
||||
| Fase | Duração | Atividade |
|
||||
|------|---------|-----------|
|
||||
| Setup | 1h | docker compose up |
|
||||
| Instrumentação | 1-2h | Auto-instrument serviços críticos |
|
||||
| Configuração | 2-4h | Alertas, dashboards, SLOs |
|
||||
| Produção | 1 semana | Refinamento e ajustes |
|
||||
|
||||
### Pré-requisitos
|
||||
- Docker 20.10+
|
||||
- 4GB RAM mínimo
|
||||
- Acesso aos serviços a monitorar
|
||||
|
||||
---
|
||||
|
||||
## 10. Próximos Passos
|
||||
|
||||
1. **Demo**: Veja OPHION em ação (15 min)
|
||||
2. **POC**: Instale em ambiente de teste
|
||||
3. **Pilot**: Instrumente 3-5 serviços críticos
|
||||
4. **Rollout**: Expanda para toda infraestrutura
|
||||
5. **Optimize**: Configure AI e auto-healing
|
||||
|
||||
---
|
||||
|
||||
## 11. Suporte
|
||||
|
||||
- 📚 Documentação: docs.ophion.io
|
||||
- 💬 Comunidade: Discord
|
||||
- 📧 Enterprise: contato@ophion.io
|
||||
|
||||
---
|
||||
|
||||
*OPHION - Observabilidade que pensa por você*
|
||||
|
||||
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