first commit
This commit is contained in:
151
INSTALL.md
Normal file
151
INSTALL.md
Normal file
@@ -0,0 +1,151 @@
|
||||
# 📦 Guia de Instalação
|
||||
|
||||
## ⚙️ Pré-requisitos
|
||||
|
||||
- Docker Desktop (com Docker Compose incluído)
|
||||
- Linux, macOS ou Windows WSL2
|
||||
- Credenciais válidas para a API PersonalizeIT
|
||||
|
||||
## 🚀 Instalação Rápida (3 passos)
|
||||
|
||||
### Passo 1: Configurar Credenciais
|
||||
|
||||
```bash
|
||||
# Abra o arquivo .env
|
||||
nano .env
|
||||
```
|
||||
|
||||
Edite com suas credenciais:
|
||||
```env
|
||||
API_USERNAME=seu_email@exemplo.com
|
||||
API_PASSWORD=sua_senha
|
||||
```
|
||||
|
||||
### Passo 2: Iniciar os Serviços
|
||||
|
||||
```bash
|
||||
# Dar permissão de execução aos scripts
|
||||
chmod +x setup.sh test-api.sh
|
||||
|
||||
# Executar setup (opcional, mas recomendado)
|
||||
./setup.sh
|
||||
|
||||
# Ou iniciar diretamente
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Passo 3: Acessar os Serviços
|
||||
|
||||
- **Grafana**: http://localhost:3000 (admin/admin)
|
||||
- **API**: http://localhost:5000
|
||||
- **Prometheus**: http://localhost:9090
|
||||
|
||||
## 🧪 Verificar Funcionamento
|
||||
|
||||
```bash
|
||||
# Testar a API
|
||||
./test-api.sh
|
||||
|
||||
# Ou manualmente
|
||||
curl http://localhost:5000/health
|
||||
curl http://localhost:5000/api/summary
|
||||
```
|
||||
|
||||
## 🛑 Parar os Serviços
|
||||
|
||||
```bash
|
||||
docker-compose down
|
||||
```
|
||||
|
||||
## 🚪 Configurar Datasource no Grafana
|
||||
|
||||
### Opção A: JSON Datasource (Para Tabelas)
|
||||
|
||||
1. Grafana → Configuration → Data Sources → Add data source
|
||||
2. Selecione "JSON API"
|
||||
3. URL: `http://monitoring-api:5000`
|
||||
4. Click "Save & Test"
|
||||
|
||||
### Opção B: Prometheus (Para Gráficos)
|
||||
|
||||
1. Grafana → Configuration → Data Sources → Add data source
|
||||
2. Selecione "Prometheus"
|
||||
3. URL: `http://prometheus:9090`
|
||||
4. Click "Save & Test"
|
||||
|
||||
## 📊 Dashboard Pré-configurado
|
||||
|
||||
Um dashboard chamado "Monitoramento de Atendimento" já foi criado e deve aparecer automaticamente em Dashboards → Browse.
|
||||
|
||||
Se o dashboard não aparecer, você pode importá-lo manualmente:
|
||||
|
||||
1. Grafana → Create → Import
|
||||
2. Copie o conteúdo de `grafana/provisioning/dashboards/monitoring-dashboard.json`
|
||||
3. Click "Load"
|
||||
|
||||
## 🔧 Troubleshooting
|
||||
|
||||
### "Connection refused"
|
||||
```bash
|
||||
# Verificar status dos containers
|
||||
docker-compose ps
|
||||
|
||||
# Reiniciar tudo
|
||||
docker-compose restart
|
||||
```
|
||||
|
||||
### "Failed to authenticate"
|
||||
```bash
|
||||
# Verificar logs da API
|
||||
docker-compose logs monitoring-api
|
||||
|
||||
# Verificar credenciais em .env
|
||||
cat .env | grep API_
|
||||
```
|
||||
|
||||
### Sem dados no Grafana
|
||||
```bash
|
||||
# Testar endpoint diretamente
|
||||
curl http://localhost:5000/api/summary
|
||||
|
||||
# Se vazio, verificar logs
|
||||
docker-compose logs -f monitoring-api
|
||||
```
|
||||
|
||||
## 📱 Usar em Produção
|
||||
|
||||
1. **Configure HTTPS**: Use nginx/caddy como reverse proxy
|
||||
2. **Credenciais seguras**: Use secrets do Docker Compose
|
||||
3. **Volumes persistentes**: Configure para Grafana e Prometheus
|
||||
4. **Backups**: Configure backup automático do Grafana
|
||||
|
||||
### Exemplo docker-compose para produção:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
monitoring-api:
|
||||
# ... adicionar secrets
|
||||
restart: always
|
||||
|
||||
grafana:
|
||||
volumes:
|
||||
- grafana-storage:/var/lib/grafana
|
||||
restart: always
|
||||
|
||||
prometheus:
|
||||
volumes:
|
||||
- prometheus-storage:/prometheus
|
||||
restart: always
|
||||
```
|
||||
|
||||
## 📚 Documentação Adicional
|
||||
|
||||
- [README.md](README.md) - Documentação completa
|
||||
- [API Endpoints](README.md#-endpoints-disponíveis)
|
||||
- [Criação de Dashboards](README.md#-criar-dashboard-no-grafana)
|
||||
|
||||
## 💡 Dicas
|
||||
|
||||
- Atualize o refresh interval em `.env` para ajustar frequência de coleta
|
||||
- Configure alertas no Grafana baseado em limites de tempo de atendimento
|
||||
- Exporte dashboards para compartilhar com equipe
|
||||
Reference in New Issue
Block a user