208 lines
5.4 KiB
Markdown
208 lines
5.4 KiB
Markdown
# Monitoramento de Atendimento - Grafana Integration
|
|
|
|
Sistema de integração entre a plataforma PersonalizeIT e o Grafana para monitoramento em tempo real de tickets de atendimento.
|
|
|
|
## 📋 Funcionalidades
|
|
|
|
- ✅ Autenticação automática na API PersonalizeIT
|
|
- ✅ Coleta de tickets com nome da pessoa e tempo de atendimento
|
|
- ✅ Três formatos de dados disponíveis:
|
|
- **JSON** - Para Grafana JSON Datasource
|
|
- **Prometheus** - Para scraping com Prometheus
|
|
- **Time Series** - Para visualizações de série temporal
|
|
- ✅ Cache inteligente com refresh automático
|
|
- ✅ Endpoints de health check e resumo
|
|
- ✅ Docker Compose completo com Grafana e Prometheus
|
|
- ✅ Suporte a SSL/TLS
|
|
|
|
## 🚀 Início Rápido
|
|
|
|
### 1. Clonar/Preparar o projeto
|
|
```bash
|
|
cd /home/luis/monitoramento_atendimento
|
|
```
|
|
|
|
### 2. Configurar credenciais
|
|
```bash
|
|
cp config/.env.example .env
|
|
```
|
|
|
|
Edite o arquivo `.env` com suas credenciais:
|
|
```env
|
|
API_USERNAME=seu_email@exemplo.com
|
|
API_PASSWORD=sua_senha
|
|
```
|
|
|
|
### 3. Executar com Docker Compose
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
Isso irá iniciar:
|
|
- **Api (Flask)** em `http://localhost:5000`
|
|
- **Grafana** em `http://localhost:3000` (admin/admin)
|
|
- **Prometheus** em `http://localhost:9090`
|
|
|
|
### 4. Verificar saúde da API
|
|
```bash
|
|
curl http://localhost:5000/health
|
|
```
|
|
|
|
## 📊 Endpoints Disponíveis
|
|
|
|
### `/` - Status da aplicação
|
|
```bash
|
|
curl http://localhost:5000/
|
|
```
|
|
|
|
### `/health` - Health check
|
|
```bash
|
|
curl http://localhost:5000/health
|
|
```
|
|
|
|
### `/api/tickets` - JSON com tickets
|
|
```bash
|
|
curl http://localhost:5000/api/tickets
|
|
```
|
|
|
|
**Resposta:**
|
|
```json
|
|
{
|
|
"timestamp": "2026-02-09T12:30:00.000000",
|
|
"total_tickets": 10,
|
|
"tickets": [
|
|
{
|
|
"id": 26459,
|
|
"contact_name": "Júlia Donelli",
|
|
"duration_seconds": 56,
|
|
"duration_formatted": "00:00:56",
|
|
"status": "pending",
|
|
"queue": "EQUIPAMENTO EM MANUTENÇÃO",
|
|
"contact_number": "555199448030"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### `/metrics` - Prometheus metrics
|
|
```bash
|
|
curl http://localhost:5000/metrics
|
|
```
|
|
|
|
### `/api/timeseries` - Dados de série temporal
|
|
```bash
|
|
curl http://localhost:5000/api/timeseries
|
|
```
|
|
|
|
### `/api/summary` - Resumo estatístico
|
|
```bash
|
|
curl http://localhost:5000/api/summary
|
|
```
|
|
|
|
## 🔧 Configuração de Datasource no Grafana
|
|
|
|
### Opção 1: Usar JSON Datasource (Recomendado para tabelas)
|
|
|
|
1. Acesse Grafana em `http://localhost:3000`
|
|
2. Vá para **Configuration > Data Sources > Add data source**
|
|
3. Selecione **JSON API**
|
|
4. Configure:
|
|
- **URL**: `http://monitoring-api:5000/api/tickets`
|
|
- **Access**: Server
|
|
|
|
### Opção 2: Usar Prometheus (Recomendado para gráficos)
|
|
|
|
1. Acesse Grafana em `http://localhost:3000`
|
|
2. Vá para **Configuration > Data Sources > Add data source**
|
|
3. Selecione **Prometheus**
|
|
4. Configure:
|
|
- **URL**: `http://prometheus:9090`
|
|
- **Access**: Server
|
|
|
|
## 📈 Criar Dashboard no Grafana
|
|
|
|
### Painel com Tabela de Atendimentos
|
|
|
|
1. **Novo Dashboard** → **Add Panel**
|
|
2. **Query**: Use datasource JSON
|
|
3. **Transform**: Adicione transformação para selecionar campos `contact_name` e `duration_formatted`
|
|
4. **Visualization**: Selecione `Table`
|
|
|
|
### Painel com Gráfico de Duração
|
|
|
|
1. **Novo Dashboard** → **Add Panel**
|
|
2. **Query**: Use datasource Prometheus
|
|
3. **Metrics**: Selecione `ticket_duration_seconds`
|
|
4. **Visualization**: Selecione `Stat` ou `Time series`
|
|
|
|
## 🐛 Troubleshooting
|
|
|
|
### Erro: "Failed to authenticate with API"
|
|
- Verifique se `API_USERNAME` e `API_PASSWORD` estão corretos
|
|
- Confirme se a API está acessível: `curl https://api-personalizeit.zapplataforma.chat/auth/login`
|
|
|
|
### Erro: "Connection refused"
|
|
- Verifique se os containers estão em execução: `docker-compose ps`
|
|
- Reinicie os containers: `docker-compose restart`
|
|
|
|
### Sem dados no Grafana
|
|
- Verifique logs da API: `docker-compose logs monitoring-api`
|
|
- Teste endpoint diretamente: `curl http://localhost:5000/api/summary`
|
|
|
|
## 📝 Logs
|
|
|
|
Ver logs da aplicação:
|
|
```bash
|
|
docker-compose logs -f monitoring-api
|
|
```
|
|
|
|
Ver logs do Grafana:
|
|
```bash
|
|
docker-compose logs -f grafana
|
|
```
|
|
|
|
## 🛑 Parar os containers
|
|
```bash
|
|
docker-compose down
|
|
```
|
|
|
|
## 🗂️ Estrutura do Projeto
|
|
|
|
```
|
|
monitoramento_atendimento/
|
|
├── src/
|
|
│ ├── app.py # Aplicação Flask
|
|
│ ├── api_client.py # Cliente da API
|
|
│ ├── data_formatter.py # Formatação de dados
|
|
│ └── config.py # Configurações
|
|
├── config/
|
|
│ └── .env.example # Template de variáveis
|
|
├── docker-compose.yml # Orquestração Docker
|
|
├── Dockerfile # Build da aplicação
|
|
├── prometheus.yml # Configuração Prometheus
|
|
├── requirements.txt # Dependências Python
|
|
└── README.md # Este arquivo
|
|
```
|
|
|
|
## 🔐 Segurança
|
|
|
|
- As credenciais são gerenciadas via arquivo `.env` (não versionado)
|
|
- A API usa Bearer token para autenticação
|
|
- SSL/TLS é verificado por padrão
|
|
- Health checks garantem disponibilidade
|
|
|
|
## 🚀 Para Produção
|
|
|
|
1. Configure variáveis de ambiente adequadamente
|
|
2. Use `gunicorn` ao invés de servidor Flask padrão (já configurado no Dockerfile)
|
|
3. Configure HTTPS reverse proxy (nginx/caddy)
|
|
4. Use volume persistente para Grafana
|
|
5. Configure backup de datasources do Grafana
|
|
|
|
## 📞 Suporte
|
|
|
|
Para mais informações, consulte:
|
|
- [Documentação PersonalizeIT API](https://api-personalizeit.zapplataforma.chat)
|
|
- [Documentação Grafana](https://grafana.com/docs)
|
|
- [Documentação Prometheus](https://prometheus.io/docs)
|