first commit
This commit is contained in:
136
ARCHITECTURE.md
Normal file
136
ARCHITECTURE.md
Normal file
@@ -0,0 +1,136 @@
|
||||
# 🏗️ Arquitetura
|
||||
|
||||
## Fluxo de Dados
|
||||
|
||||
```
|
||||
PersonalizeIT API
|
||||
↓
|
||||
(login)
|
||||
↓
|
||||
API Client
|
||||
(bearer token)
|
||||
↓
|
||||
(busca tickets)
|
||||
↓
|
||||
PersonalizeIT API
|
||||
(tickets)
|
||||
↓
|
||||
Data Formatter
|
||||
↓
|
||||
┌──────────┬──────────┐
|
||||
↓ ↓ ↓
|
||||
JSON Prometheus TimeSeries
|
||||
↓ ↓ ↓
|
||||
(JSON) (Metrics) (TS)
|
||||
↓ ↓ ↓
|
||||
└────────┬─────────┘
|
||||
↓
|
||||
Flask API
|
||||
↓ ↓
|
||||
JSON Prometheus
|
||||
API Endpoint
|
||||
↓ ↓
|
||||
┌──────┬──────┐
|
||||
↓ ↓ ↓
|
||||
Grafana Prom Bash
|
||||
↓ ↓ Scripts
|
||||
Dash Alert
|
||||
↓ ↓
|
||||
UI Notifi-
|
||||
cações
|
||||
|
||||
```
|
||||
|
||||
## Componentes
|
||||
|
||||
### 📡 API Client (`api_client.py`)
|
||||
- Autenticação na PersonalizeIT API
|
||||
- Gerenciamento baseado em bearer token
|
||||
- Busca de tickets com filtros
|
||||
- Tratamento de erros e retry
|
||||
|
||||
### 🔄 Data Formatter (`data_formatter.py`)
|
||||
- Formata dados em 3 formatos:
|
||||
- **JSON**: Para datasources JSON do Grafana
|
||||
- **Prometheus**: Métricas no padrão Prometheus
|
||||
- **TimeSeries**: Dados agregados por tempo
|
||||
|
||||
### 🌐 Flask App (`app.py`)
|
||||
Endpoints principais:
|
||||
- `GET /` - Status
|
||||
- `GET /health` - Health check
|
||||
- `GET /api/tickets` - Tickets em JSON
|
||||
- `GET /metrics` - Métricas Prometheus
|
||||
- `GET /api/summary` - Resumo estatístico
|
||||
- `GET /api/timeseries` - Série temporal
|
||||
|
||||
### 📊 Grafana
|
||||
- Visualização dos dados
|
||||
- 2 Datasources:
|
||||
- Prometheus (para gráficos)
|
||||
- JSON API (para tabelas)
|
||||
- Dashboard pré-configurado
|
||||
|
||||
### 🔥 Prometheus
|
||||
- Scraping de métricas
|
||||
- Storage de time series
|
||||
- Alerting baseado em regras
|
||||
|
||||
## Configuração
|
||||
|
||||
```
|
||||
.env
|
||||
├── API_BASE_URL
|
||||
├── API_USERNAME
|
||||
├── API_PASSWORD
|
||||
├── FLASK_PORT
|
||||
├── REFRESH_INTERVAL
|
||||
└── QUEUE_IDS
|
||||
```
|
||||
|
||||
## Cache e Refresh
|
||||
|
||||
- **Refresh Interval**: Por padrão 30s (configurável em .env)
|
||||
- **Cache**: Dados em memória entre requisições
|
||||
- **Atualização**: Automática na primeira requisição após expiração
|
||||
|
||||
## Escalabilidade
|
||||
|
||||
Para produção:
|
||||
|
||||
```
|
||||
┌─────────────────────────┐
|
||||
│ Reverse Proxy │
|
||||
│ (nginx/caddy) │
|
||||
└────────────┬────────────┘
|
||||
↓
|
||||
┌─────────────────────────┐
|
||||
│ Load Balancer │
|
||||
└────────────┬────────────┘
|
||||
┌──────┴──────┐
|
||||
↓ ↓
|
||||
[Api 1] [Api 2]
|
||||
↓ ↓
|
||||
└──────┬──────┘
|
||||
↓
|
||||
Redis Cache
|
||||
↓
|
||||
PostgreSQL DB
|
||||
(histórico opcional)
|
||||
```
|
||||
|
||||
## Segurança
|
||||
|
||||
- ✅ SSL/TLS para conexão com API
|
||||
- ✅ Bearer token para autenticação
|
||||
- ✅ Senhas em variáveis de ambiente (.env)
|
||||
- ✅ Health checks automáticos
|
||||
- ✅ Timeout em requisições
|
||||
|
||||
## Monitoramento
|
||||
|
||||
O próprio sistema pode ser monitorado com:
|
||||
- Status HTTP endpoints
|
||||
- Logs estruturados
|
||||
- Prometheus metrics da app
|
||||
- Health checks do Docker
|
||||
Reference in New Issue
Block a user