From bfc98310403106e9041d370427bcef7dadd74346 Mon Sep 17 00:00:00 2001 From: Halbe Bruno Date: Fri, 2 Oct 2026 21:14:01 -0300 Subject: [PATCH] =?UTF-8?q?release:=20v1.0.0=20-=20Zabbix=20GPON=20API=20d?= =?UTF-8?q?istribui=C3=A7=C3=A3o=20cliente?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env.example | 66 ++ .gitignore | 4 + README.md | 49 ++ docker/docker-compose-grafana.yml | 36 + docker/docker-compose-mariadb.yml | 37 + docker/docker-compose-zabbix.yml | 58 ++ docker/docker-compose.yml | 30 + grafana/dashboards/gpon_noc_overview.json | 714 ++++++++++++++++++ .../dashboards/subscriber_optical_360.json | 509 +++++++++++++ .../provisioning/dashboards/dashboards.yml | 12 + .../provisioning/datasources/datasource.yml | 25 + scripts/backup.sh | 211 ++++++ scripts/restore.sh | 147 ++++ scripts/update.sh | 45 ++ 14 files changed, 1943 insertions(+) create mode 100644 .env.example create mode 100644 .gitignore create mode 100644 README.md create mode 100644 docker/docker-compose-grafana.yml create mode 100644 docker/docker-compose-mariadb.yml create mode 100644 docker/docker-compose-zabbix.yml create mode 100644 docker/docker-compose.yml create mode 100644 grafana/dashboards/gpon_noc_overview.json create mode 100644 grafana/dashboards/subscriber_optical_360.json create mode 100644 grafana/provisioning/dashboards/dashboards.yml create mode 100644 grafana/provisioning/datasources/datasource.yml create mode 100755 scripts/backup.sh create mode 100755 scripts/restore.sh create mode 100755 scripts/update.sh diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..ae55907 --- /dev/null +++ b/.env.example @@ -0,0 +1,66 @@ +# ============================================================================== +# PROJETO E STACK DOCKER (MODULAR VIA COMPOSE_FILE) +# ============================================================================== +COMPOSE_PROJECT_NAME=gpon-api + +# Padrão: Apenas a API (utiliza Zabbix e Banco de Dados externos) +COMPOSE_FILE=docker/docker-compose.yml + +## Database (Descomente a linha abaixo para rodar o MariaDB 11.4 dedicado na stack) +# COMPOSE_FILE=docker/docker-compose-mariadb.yml +MYSQL_HOST=db +MYSQL_PORT=3306 +MYSQL_ROOT_PASSWORD=sua_senha_root_forte +MYSQL_DATABASE=zabbix_gpon_api +MYSQL_USER=zabbix_gpon_api +MYSQL_PASSWORD=sua_senha_telemetria_forte + +## Zabbix (Descomente a linha abaixo para subir API + DB compartilhado + Zabbix Server e Web) +# COMPOSE_FILE=docker/docker-compose-zabbix.yml +ZABBIX_DB_NAME=zabbix +ZABBIX_DB_USER=zabbix +ZABBIX_DB_PASSWORD=zabbix +ZABBIX_SERVER_PORT=10051 +ZABBIX_WEB_PORT=8080 +PHP_TZ=America/Sao_Paulo + +## Grafana (Descomente a linha abaixo para subir a stack completa com Grafana) +# COMPOSE_FILE=docker/docker-compose-grafana.yml +GRAFANA_PORT=3000 +GRAFANA_ADMIN_USER=admin +GRAFANA_ADMIN_PASSWORD=admin + +# ============================================================================== +# Conexão com o Banco de Dados (Utilizado pela API) +# O .env aceita variáveis para montar a URL dinamicamente +# ============================================================================== +DATABASE_URL=mysql+aiomysql://${MYSQL_USER}:${MYSQL_PASSWORD}@${MYSQL_HOST}:${MYSQL_PORT}/${MYSQL_DATABASE} + +# Se for utilizar um banco MySQL/MariaDB externo existente, basta alterar MYSQL_HOST +# acima (ex: MYSQL_HOST=192.168.10.50) ou descomentar e definir a URL direta: +#DATABASE_URL=mysql+aiomysql://MYSQL_USER:MYSQL_PASSWORD@MYSQL_HOST:MYSQL_PORT/MYSQL_DATABASE + +# ============================================================================== +# Conexão Zabbix API (Utilizado pela API) +# ============================================================================== +# OPÇÃO A: Zabbix INTERNO na stack (quando descomentar docker-compose-zabbix.yml) +# Comunicação direta de container para container na mesma rede docker: +# ZABBIX_URL=http://zabbix-web:8080/api_jsonrpc.php +# ZABBIX_USER=Admin +# ZABBIX_PASSWORD=zabbix + +# OPÇÃO B: Zabbix EXTERNO existente no seu provedor: +ZABBIX_URL=http://zabbix.provedor.com.br/zabbix/api_jsonrpc.php +ZABBIX_USER=Admin +ZABBIX_PASSWORD=zabbix + +# ============================================================================== +# Configurações da API e Agendador de Coleta +# ============================================================================== +API_PORT=8000 +MAX_CONCURRENT_HOSTS=5 +FAST_STATUS_INTERVAL_MIN=5 +FULL_OPTICAL_INTERVAL_HOURS=1 +BNG_SESSIONS_INTERVAL_MIN=5 +RETENTION_DAYS=90 +CONNECTION_RETENTION_DAYS=90 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5e09155 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.env +data/ +backups/ +*.log diff --git a/README.md b/README.md new file mode 100644 index 0000000..675b83b --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# 🚀 Zabbix GPON API + +Sistema profissional de diagnóstico óptico unificado GPON, telemetria em tempo real e correlação OLT / BNG integrado nativamente ao Zabbix e Grafana. + +--- + +## ⚡ Instalação Rápida (Em 3 Passos) + +### 1. Clonar o repositório +```bash +git clone https://git.ipv0.com.br/zabbix/gpon-api.git /opt/zbx_gpon_api +cd /opt/zbx_gpon_api +``` + +### 2. Configurar o ambiente +```bash +cp .env.example .env +nano .env +``` +*(Preencha os dados do seu banco MariaDB e a URL do seu Zabbix)* + +### 3. Iniciar a aplicação +```bash +docker compose up -d +``` + +Acesse a API em: `http://IP_DO_SERVIDOR:8000/docs` +Acesse o Grafana em: `http://IP_DO_SERVIDOR:3000` + +--- + +## 🔑 Ativação de Licença + +Para ativar sua licença comercial fornecida pela equipe de suporte: + +```bash +curl -X POST http://localhost:8000/api/v1/license/activate \ + -H "Content-Type: application/json" \ + -d '{"license_key": "SUA-CHAVE-DE-LICENCA"}' +``` + +--- + +## 🔄 Atualização Segura + +Para atualizar o sistema com backup preventivo automático: +```bash +./scripts/update.sh +``` diff --git a/docker/docker-compose-grafana.yml b/docker/docker-compose-grafana.yml new file mode 100644 index 0000000..9f532e3 --- /dev/null +++ b/docker/docker-compose-grafana.yml @@ -0,0 +1,36 @@ +include: + - docker-compose-zabbix.yml + +services: + # ============================================================================== + # Grafana (Dashboards & Visualização) + # ============================================================================== + grafana: + image: grafana/grafana:latest + container_name: zbx_gpon_api_grafana + restart: unless-stopped + env_file: + - ../.env + ports: + - "${GRAFANA_PORT:-3000}:3000" + environment: + GF_SECURITY_ADMIN_USER: ${GRAFANA_ADMIN_USER:-admin} + GF_SECURITY_ADMIN_PASSWORD: ${GRAFANA_ADMIN_PASSWORD:-admin} + GF_INSTALL_PLUGINS: alexanderzobnin-zabbix-app + GF_USERS_ALLOW_SIGN_UP: "false" + MYSQL_DATABASE: ${MYSQL_DATABASE:-zabbix_gpon_api} + MYSQL_USER: ${MYSQL_USER:-zabbix_gpon_api} + MYSQL_PASSWORD: ${MYSQL_PASSWORD:-telemetria123} + volumes: + - grafana_data:/var/lib/grafana + - ../grafana/provisioning:/etc/grafana/provisioning:ro + - ../grafana/dashboards:/var/lib/grafana/dashboards:ro + depends_on: + db: + condition: service_healthy + zabbix-web: + condition: service_started + +volumes: + grafana_data: + name: ${COMPOSE_PROJECT_NAME:-gpon-api}_grafana_data diff --git a/docker/docker-compose-mariadb.yml b/docker/docker-compose-mariadb.yml new file mode 100644 index 0000000..480ef4f --- /dev/null +++ b/docker/docker-compose-mariadb.yml @@ -0,0 +1,37 @@ +include: + - docker-compose.yml + +services: + # Vincula dependência de saúde do banco na aplicação quando este compose é incluído + app: + depends_on: + db: + condition: service_healthy + + # ============================================================================== + # Banco de Dados MariaDB 11.4 (Dados persistentes em Named Volume) + # ============================================================================== + db: + image: mariadb:11.4 + container_name: zbx_gpon_api_db + restart: unless-stopped + environment: + MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD:-srcc2030} + MYSQL_DATABASE: ${MYSQL_DATABASE:-zabbix_gpon_api} + MYSQL_USER: ${MYSQL_USER:-zabbix_gpon_api} + MYSQL_PASSWORD: ${MYSQL_PASSWORD:-telemetria123} + ports: + - "${MYSQL_PORT:-3306}:3306" + volumes: + - mariadb_data:/var/lib/mysql + - ../scripts/init-mariadb:/docker-entrypoint-initdb.d:ro + healthcheck: + test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"] + interval: 5s + timeout: 5s + retries: 20 + start_period: 30s + +volumes: + mariadb_data: + name: ${COMPOSE_PROJECT_NAME:-gpon-api}_mariadb_data diff --git a/docker/docker-compose-zabbix.yml b/docker/docker-compose-zabbix.yml new file mode 100644 index 0000000..2dc1fec --- /dev/null +++ b/docker/docker-compose-zabbix.yml @@ -0,0 +1,58 @@ +include: + - docker-compose-mariadb.yml + +services: + # ============================================================================== + # Zabbix Server 7.0 LTS (Usa o mesmo MariaDB da aplicação) + # ============================================================================== + zabbix-server: + image: zabbix/zabbix-server-mysql:alpine-7.0-latest + container_name: zabbix_server + restart: unless-stopped + ports: + - "${ZABBIX_SERVER_PORT:-10051}:10051" + environment: + DB_SERVER_HOST: db + DB_SERVER_PORT: 3306 + MYSQL_DATABASE: ${ZABBIX_DB_NAME:-zabbix} + MYSQL_USER: ${ZABBIX_DB_USER:-zabbix} + MYSQL_PASSWORD: ${ZABBIX_DB_PASSWORD:-zabbix} + MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD:-srcc2030} + ZBX_STARTPOLLERS: ${ZBX_STARTPOLLERS:-5} + ZBX_STARTPINGERS: ${ZBX_STARTPINGERS:-3} + ZBX_STARTDISCOVERERS: ${ZBX_STARTDISCOVERERS:-1} + volumes: + - ../data/zabbix/alertscripts:/usr/lib/zabbix/alertscripts + - ../data/zabbix/externalscripts:/usr/lib/zabbix/externalscripts + - ../data/zabbix/export:/var/lib/zabbix/export + - ../data/zabbix/modules:/var/lib/zabbix/modules + - ../data/zabbix/enc:/var/lib/zabbix/enc + - ../data/zabbix/ssh_keys:/var/lib/zabbix/ssh_keys + - ../data/zabbix/mibs:/var/lib/zabbix/mibs + - ../data/zabbix/snmptraps:/var/lib/zabbix/snmptraps + depends_on: + db: + condition: service_healthy + + # ============================================================================== + # Zabbix Web Frontend (NGINX + PHP-FPM) + # ============================================================================== + zabbix-web: + image: zabbix/zabbix-web-nginx-mysql:alpine-7.0-latest + container_name: zabbix_web + restart: unless-stopped + ports: + - "${ZABBIX_WEB_PORT:-8080}:8080" + environment: + ZBX_SERVER_HOST: zabbix-server + DB_SERVER_HOST: db + DB_SERVER_PORT: 3306 + MYSQL_DATABASE: ${ZABBIX_DB_NAME:-zabbix} + MYSQL_USER: ${ZABBIX_DB_USER:-zabbix} + MYSQL_PASSWORD: ${ZABBIX_DB_PASSWORD:-zabbix} + PHP_TZ: ${PHP_TZ:-America/Sao_Paulo} + depends_on: + db: + condition: service_healthy + zabbix-server: + condition: service_started diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml new file mode 100644 index 0000000..0b66e86 --- /dev/null +++ b/docker/docker-compose.yml @@ -0,0 +1,30 @@ +services: + # ============================================================================== + # Zabbix GPON API - Executável Compilado e Protegido (Zero .py) + # ============================================================================== + app: + image: git.ipv0.com.br/zabbix/gpon-api:latest + container_name: zbx_gpon_api_app + hostname: zabbix-gpon-api + restart: unless-stopped + ports: + - "${API_PORT:-8000}:8000" + volumes: + - /etc/machine-id:/etc/machine-id:ro + - ../data:/app/data + env_file: + - ../.env + environment: + - DATABASE_URL=${DATABASE_URL:-mysql+aiomysql://root:${MYSQL_ROOT_PASSWORD:-srcc2030}@db:3306/${MYSQL_DATABASE:-zabbix_gpon_api}} + - ZABBIX_URL=${ZABBIX_URL} + - ZABBIX_USER=${ZABBIX_USER} + - ZABBIX_PASSWORD=${ZABBIX_PASSWORD} + - API_PORT=${API_PORT:-8000} + - FAST_STATUS_INTERVAL_MIN=${FAST_STATUS_INTERVAL_MIN:-5} + - FULL_OPTICAL_INTERVAL_HOURS=${FULL_OPTICAL_INTERVAL_HOURS:-1} + - BNG_SESSIONS_INTERVAL_MIN=${BNG_SESSIONS_INTERVAL_MIN:-5} + - RETENTION_DAYS=${RETENTION_DAYS:-90} + - CONNECTION_RETENTION_DAYS=${CONNECTION_RETENTION_DAYS:-90} + - MAX_CONCURRENT_HOSTS=${MAX_CONCURRENT_HOSTS:-5} + extra_hosts: + - "host.docker.internal:host-gateway" diff --git a/grafana/dashboards/gpon_noc_overview.json b/grafana/dashboards/gpon_noc_overview.json new file mode 100644 index 0000000..9dc2f4f --- /dev/null +++ b/grafana/dashboards/gpon_noc_overview.json @@ -0,0 +1,714 @@ +{ + "annotations": { + "list": [] + }, + "editable": true, + "fiscalYearStartMonth": 0, + "graphTooltip": 1, + "id": null, + "links": [], + "liveNow": false, + "panels": [ + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 24, + "x": 0, + "y": 0 + }, + "id": 100, + "title": "\ud83d\udcca Indicadores Operacionais de Rede GPON (NOC)", + "type": "row" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "blue", + "value": null + } + ] + } + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 0, + "y": 1 + }, + "id": 1, + "options": { + "colorMode": "value", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "pluginVersion": "10.0.0", + "targets": [ + { + "format": "table", + "rawSql": "SELECT COUNT(*) as value FROM onus_atual;", + "refId": "A" + } + ], + "title": "Total de ONUs", + "type": "stat" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + } + ] + } + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 4, + "y": 1 + }, + "id": 2, + "options": { + "colorMode": "value", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT COUNT(*) as value FROM onus_atual WHERE status = 'online';", + "refId": "A" + } + ], + "title": "ONUs Online", + "type": "stat" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + }, + { + "color": "red", + "value": 1 + } + ] + } + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 8, + "y": 1 + }, + "id": 3, + "options": { + "colorMode": "value", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT COUNT(*) as value FROM onus_atual WHERE status IN ('offline', 'los');", + "refId": "A" + } + ], + "title": "ONUs Offline / LOS", + "type": "stat" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + }, + { + "color": "orange", + "value": 1 + }, + { + "color": "red", + "value": 10 + } + ] + } + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 12, + "y": 1 + }, + "id": 4, + "options": { + "colorMode": "value", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT COUNT(*) as value FROM onus_atual WHERE status = 'online' AND rx_dbm IS NOT NULL AND (rx_dbm < -27.00 OR rx_dbm > -8.00);", + "refId": "A" + } + ], + "title": "Sinal Cr\u00edtico (< -27 dBm)", + "type": "stat" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + }, + { + "color": "yellow", + "value": 1 + } + ] + } + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 16, + "y": 1 + }, + "id": 5, + "options": { + "colorMode": "value", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT COUNT(*) as value FROM onus_atual WHERE status = 'online' AND rx_dbm IS NOT NULL AND rx_dbm BETWEEN -27.00 AND -25.01;", + "refId": "A" + } + ], + "title": "Sinal Alerta (-25 a -27 dBm)", + "type": "stat" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "purple", + "value": null + } + ] + } + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 20, + "y": 1 + }, + "id": 6, + "options": { + "colorMode": "value", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT COUNT(*) as value FROM bng_sessoes_atual;", + "refId": "A" + } + ], + "title": "Sess\u00f5es BNG Ativas", + "type": "stat" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 24, + "x": 0, + "y": 5 + }, + "id": 101, + "title": "\ud83d\udcc8 Distribui\u00e7\u00e3o e Sa\u00fade da Planta \u00d3ptica", + "type": "row" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "mappings": [] + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 0, + "y": 6 + }, + "id": 7, + "options": { + "legend": { + "displayMode": "table", + "placement": "right", + "values": [ + "value", + "percent" + ] + }, + "pieType": "donut", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "tooltip": { + "mode": "single" + } + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT status as metric, COUNT(*) as value FROM onus_atual GROUP BY status;", + "refId": "A" + } + ], + "title": "Status Operacional das ONUs", + "type": "piechart" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "mappings": [] + } + }, + "gridPos": { + "h": 8, + "w": 16, + "x": 8, + "y": 6 + }, + "id": 8, + "options": { + "displayLabels": [ + "value" + ], + "legend": { + "displayMode": "list", + "placement": "bottom" + }, + "orientation": "horizontal", + "tooltip": { + "mode": "single" + } + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT \n CASE \n WHEN rx_dbm IS NULL OR status != 'online' THEN 'Offline / Sem Leitura'\n WHEN rx_dbm > -15.00 THEN 'Sinal Excessivo (> -15 dBm)'\n WHEN rx_dbm BETWEEN -24.00 AND -15.00 THEN 'Excelente (-15 a -24 dBm)'\n WHEN rx_dbm BETWEEN -27.00 AND -24.01 THEN 'Atenuado / Alerta (-24 a -27 dBm)'\n WHEN rx_dbm < -27.00 THEN 'Cr\u00edtico (< -27 dBm)'\n END as metric,\n COUNT(*) as value\nFROM onus_atual\nGROUP BY metric\nORDER BY value DESC;", + "refId": "A" + } + ], + "title": "Faixas de Pot\u00eancia \u00d3ptica Rx das ONUs Online", + "type": "barchart" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 24, + "x": 0, + "y": 14 + }, + "id": 102, + "title": "\u26a0\ufe0f Fila de Atendimento NOC: ONUs com Sinal Atenuado / Cr\u00edtico", + "type": "row" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "custom": { + "align": "auto", + "cellOptions": { + "type": "auto" + }, + "inspect": false + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "red", + "value": null + }, + { + "color": "yellow", + "value": -27 + }, + { + "color": "green", + "value": -24 + }, + { + "color": "red", + "value": -8 + } + ] + } + }, + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "rx_dbm" + }, + "properties": [ + { + "id": "custom.cellOptions", + "value": { + "mode": "gradient", + "type": "color-background" + } + }, + { + "id": "unit", + "value": "dBm" + } + ] + }, + { + "matcher": { + "id": "byName", + "options": "distancia_metros" + }, + "properties": [ + { + "id": "unit", + "value": "lengthm" + } + ] + } + ] + }, + "gridPos": { + "h": 10, + "w": 24, + "x": 0, + "y": 15 + }, + "id": 9, + "options": { + "footer": { + "countRows": false, + "enablePagination": true, + "fields": "", + "reducer": [ + "sum" + ], + "show": true + }, + "showHeader": true, + "sortBy": [ + { + "desc": false, + "displayName": "rx_dbm" + } + ] + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT \n d.nome as olt,\n CONCAT(o.slot, '/', o.pon, ':', o.onu_id) as porta_pon,\n o.serial,\n o.onu_nome as cliente,\n o.modelo,\n o.status,\n o.rx_dbm,\n o.tx_dbm,\n o.distancia_metros,\n o.atualizado_em as ultima_leitura\nFROM onus_atual o\nJOIN dispositivos_rede d ON d.id = o.dispositivo_id\nWHERE o.status = 'online' AND o.rx_dbm IS NOT NULL\nORDER BY o.rx_dbm ASC\nLIMIT 50;", + "refId": "A" + } + ], + "title": "Top 50 ONUs com Pior Pot\u00eancia \u00d3ptica Rx (Ordem Cr\u00edtica)", + "type": "table" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 24, + "x": 0, + "y": 25 + }, + "id": 103, + "title": "\ud83d\udda5\ufe0f Capacidade e Sa\u00fade por OLT", + "type": "row" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "custom": { + "align": "auto", + "cellOptions": { + "type": "auto" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "red", + "value": null + }, + { + "color": "yellow", + "value": 85 + }, + { + "color": "green", + "value": 95 + } + ] + } + }, + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "taxa_online_pct" + }, + "properties": [ + { + "id": "custom.cellOptions", + "value": { + "mode": "basic", + "type": "color-background" + } + }, + { + "id": "unit", + "value": "percent" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 24, + "x": 0, + "y": 26 + }, + "id": 10, + "options": { + "footer": { + "enablePagination": true, + "show": true + }, + "showHeader": true, + "sortBy": [ + { + "desc": true, + "displayName": "total_onus" + } + ] + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT \n d.nome as olt,\n d.ip,\n d.fabricante,\n d.modelo,\n COUNT(o.id) as total_onus,\n SUM(CASE WHEN o.status = 'online' THEN 1 ELSE 0 END) as online,\n SUM(CASE WHEN o.status != 'online' THEN 1 ELSE 0 END) as offline,\n ROUND(SUM(CASE WHEN o.status = 'online' THEN 1 ELSE 0 END) / NULLIF(COUNT(o.id), 0) * 100, 1) as taxa_online_pct,\n d.ultima_coleta\nFROM dispositivos_rede d\nLEFT JOIN onus_atual o ON o.dispositivo_id = d.id\nWHERE d.tipo = 'OLT'\nGROUP BY d.id, d.nome, d.ip, d.fabricante, d.modelo, d.ultima_coleta\nORDER BY total_onus DESC;", + "refId": "A" + } + ], + "title": "Vis\u00e3o Geral das OLTs Monitoradas", + "type": "table" + } + ], + "refresh": "30s", + "schemaVersion": 38, + "style": "dark", + "tags": [ + "gpon", + "noc", + "telemetria", + "olt" + ], + "templating": { + "list": [] + }, + "time": { + "from": "now-24h", + "to": "now" + }, + "timepicker": { + "refresh_intervals": [ + "10s", + "30s", + "1m", + "5m" + ] + }, + "timezone": "browser", + "title": "GPON NOC Overview - Zabbix GPON API", + "uid": "gpon-noc-overview", + "version": 1 +} \ No newline at end of file diff --git a/grafana/dashboards/subscriber_optical_360.json b/grafana/dashboards/subscriber_optical_360.json new file mode 100644 index 0000000..5fa8ce3 --- /dev/null +++ b/grafana/dashboards/subscriber_optical_360.json @@ -0,0 +1,509 @@ +{ + "annotations": { + "list": [] + }, + "editable": true, + "fiscalYearStartMonth": 0, + "graphTooltip": 1, + "id": null, + "links": [], + "liveNow": false, + "panels": [ + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 24, + "x": 0, + "y": 0 + }, + "id": 200, + "title": "\ud83d\udc64 Diagn\u00f3stico 360\u00b0 do Assinante Selecionado", + "type": "row" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [ + { + "options": { + "online": { + "color": "green", + "text": "ONLINE" + }, + "offline": { + "color": "red", + "text": "OFFLINE" + }, + "los": { + "color": "red", + "text": "LOS (FIBRA ROMPIDA)" + }, + "power_off": { + "color": "orange", + "text": "DESLIGADO" + } + }, + "type": "value" + } + ], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "blue", + "value": null + } + ] + } + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 0, + "y": 1 + }, + "id": 21, + "options": { + "colorMode": "background", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT status as value FROM onus_atual WHERE serial = '$serial' OR onu_nome = '$serial' LIMIT 1;", + "refId": "A" + } + ], + "title": "Status \u00d3ptico da ONU", + "type": "stat" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "max": -10, + "min": -35, + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "red", + "value": null + }, + { + "color": "yellow", + "value": -27 + }, + { + "color": "green", + "value": -24 + }, + { + "color": "red", + "value": -14 + } + ] + }, + "unit": "dBm" + } + }, + "gridPos": { + "h": 4, + "w": 5, + "x": 4, + "y": 1 + }, + "id": 22, + "options": { + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "showThresholdLabels": true, + "showThresholdMarkers": true + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT rx_dbm as value FROM onus_atual WHERE serial = '$serial' OR onu_nome = '$serial' LIMIT 1;", + "refId": "A" + } + ], + "title": "Pot\u00eancia \u00d3ptica Rx Atual", + "type": "gauge" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "blue", + "value": null + } + ] + }, + "unit": "dBm" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 9, + "y": 1 + }, + "id": 23, + "options": { + "colorMode": "value", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT tx_dbm as value FROM onus_atual WHERE serial = '$serial' OR onu_nome = '$serial' LIMIT 1;", + "refId": "A" + } + ], + "title": "Pot\u00eancia \u00d3ptica Tx Atual", + "type": "stat" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "purple", + "value": null + } + ] + }, + "unit": "lengthm" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 13, + "y": 1 + }, + "id": 24, + "options": { + "colorMode": "value", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT distancia_metros as value FROM onus_atual WHERE serial = '$serial' OR onu_nome = '$serial' LIMIT 1;", + "refId": "A" + } + ], + "title": "Dist\u00e2ncia Estimada", + "type": "stat" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + } + ] + } + } + }, + "gridPos": { + "h": 4, + "w": 7, + "x": 17, + "y": 1 + }, + "id": 25, + "options": { + "colorMode": "value", + "graphMode": "none", + "justifyMode": "center", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT \n CONCAT(FLOOR(uptime_segundos / 86400), 'd ', FLOOR(MOD(uptime_segundos, 86400) / 3600), 'h ', FLOOR(MOD(uptime_segundos, 3600) / 60), 'm') as value\nFROM bng_sessoes_atual\nWHERE username = '$serial' OR username = (SELECT onu_nome FROM onus_atual WHERE serial = '$serial' LIMIT 1)\nLIMIT 1;", + "refId": "A" + } + ], + "title": "Tempo de Conex\u00e3o BNG (Uptime)", + "type": "stat" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 24, + "x": 0, + "y": 5 + }, + "id": 201, + "title": "\ud83d\udd17 Dados Correlacionados OLT & BNG", + "type": "row" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "custom": { + "align": "auto" + } + }, + "overrides": [] + }, + "gridPos": { + "h": 5, + "w": 24, + "x": 0, + "y": 6 + }, + "id": 26, + "options": { + "showHeader": true + }, + "targets": [ + { + "format": "table", + "rawSql": "SELECT \n d.nome as olt,\n CONCAT(o.slot, '/', o.pon, ':', o.onu_id) as pon,\n o.serial as onu_serial,\n o.onu_nome as login_identificado,\n o.modelo as onu_modelo,\n b.username as pppoe_login,\n b.ip_cliente,\n b.mac_cliente,\n b.vlan_id,\n b.interface as bng_interface,\n b_dev.nome as bng_equipamento\nFROM onus_atual o\nJOIN dispositivos_rede d ON d.id = o.dispositivo_id\nLEFT JOIN bng_sessoes_atual b ON (b.username = o.onu_nome OR b.username = o.serial)\nLEFT JOIN dispositivos_rede b_dev ON b_dev.id = b.bng_id\nWHERE o.serial = '$serial' OR o.onu_nome = '$serial'\nLIMIT 1;", + "refId": "A" + } + ], + "title": "Vis\u00e3o Correlacionada 360\u00b0 do Assinante", + "type": "table" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 24, + "x": 0, + "y": 11 + }, + "id": 202, + "title": "\ud83d\udcc8 Hist\u00f3rico de Estabilidade e Degrada\u00e7\u00e3o de Sinal (60-90 dias)", + "type": "row" + }, + { + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "Pot\u00eancia \u00d3ptica (dBm)", + "drawStyle": "line", + "fillOpacity": 15, + "lineInterpolation": "smooth", + "lineWidth": 2, + "pointSize": 5, + "showPoints": "auto", + "spanNulls": true, + "thresholdsStyle": { + "mode": "line+area" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "red", + "value": null + }, + { + "color": "yellow", + "value": -27 + }, + { + "color": "green", + "value": -24 + } + ] + }, + "unit": "dBm" + } + }, + "gridPos": { + "h": 10, + "w": 24, + "x": 0, + "y": 12 + }, + "id": 27, + "options": { + "legend": { + "displayMode": "list", + "placement": "bottom" + }, + "tooltip": { + "mode": "multi", + "sort": "none" + } + }, + "targets": [ + { + "format": "time_series", + "rawSql": "SELECT \n UNIX_TIMESTAMP(coletado_em) as time_sec,\n rx_dbm as value,\n 'Sinal \u00d3ptico Rx' as metric\nFROM onus_historico_sinal\nWHERE (serial_onu = '$serial' OR onu_nome = '$serial')\n AND $__timeFilter(coletado_em)\nORDER BY coletado_em ASC;", + "refId": "A" + } + ], + "title": "Evolu\u00e7\u00e3o do Sinal \u00d3ptico Rx (dBm) ao Longo do Tempo", + "type": "timeseries" + } + ], + "refresh": "1m", + "schemaVersion": 38, + "style": "dark", + "tags": [ + "gpon", + "diagnostico", + "assinante", + "sinal" + ], + "templating": { + "list": [ + { + "current": { + "selected": false, + "value": "" + }, + "datasource": { + "type": "mysql", + "uid": "zbx-gpon-api" + }, + "definition": "SELECT DISTINCT serial FROM onus_atual ORDER BY serial LIMIT 100;", + "hide": 0, + "includeAll": false, + "label": "Assinante / Serial da ONU", + "multi": false, + "name": "serial", + "options": [], + "query": "SELECT DISTINCT serial FROM onus_atual ORDER BY serial LIMIT 100;", + "refresh": 1, + "regex": "", + "skipUrlSync": false, + "sort": 1, + "type": "query" + } + ] + }, + "time": { + "from": "now-7d", + "to": "now" + }, + "timepicker": { + "refresh_intervals": [ + "30s", + "1m", + "5m" + ] + }, + "timezone": "browser", + "title": "Diagn\u00f3stico \u00d3ptico 360\u00b0 do Assinante - Zabbix GPON API", + "uid": "gpon-subscriber-360", + "version": 1 +} \ No newline at end of file diff --git a/grafana/provisioning/dashboards/dashboards.yml b/grafana/provisioning/dashboards/dashboards.yml new file mode 100644 index 0000000..e885733 --- /dev/null +++ b/grafana/provisioning/dashboards/dashboards.yml @@ -0,0 +1,12 @@ +apiVersion: 1 + +providers: + - name: 'Zabbix GPON Dashboards' + orgId: 1 + folder: 'GPON & Telemetria' + type: file + disableDeletion: false + updateIntervalSeconds: 30 + allowUiUpdates: true + options: + path: /var/lib/grafana/dashboards diff --git a/grafana/provisioning/datasources/datasource.yml b/grafana/provisioning/datasources/datasource.yml new file mode 100644 index 0000000..877b394 --- /dev/null +++ b/grafana/provisioning/datasources/datasource.yml @@ -0,0 +1,25 @@ +apiVersion: 1 + +deleteDatasources: + - name: MariaDB-GPON + orgId: 1 + - name: zbx-gpon-api + orgId: 1 + +datasources: + - name: zbx-gpon-api + type: mysql + uid: zbx-gpon-api + access: proxy + isDefault: true + url: db:3306 + user: ${MYSQL_USER} + database: ${MYSQL_DATABASE} + secureJsonData: + password: ${MYSQL_PASSWORD} + jsonData: + database: ${MYSQL_DATABASE} + maxOpenConns: 5 + maxIdleConns: 2 + connMaxLifetime: 14400 + editable: true diff --git a/scripts/backup.sh b/scripts/backup.sh new file mode 100755 index 0000000..5f78e80 --- /dev/null +++ b/scripts/backup.sh @@ -0,0 +1,211 @@ +#!/usr/bin/env bash +# ============================================================================== +# Script de Backup Automático e Completo - Zabbix GPON API +# Cobre: MariaDB (dados/tabelas), Grafana (grafana.db + dashboards), Licença e .env +# Executa 100% como usuário comum (sem necessidade de privilégios root) +# ============================================================================== +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)" +BACKUP_DIR="$PROJECT_ROOT/backups" +TIMESTAMP="$(date +%Y-%m-%d_%H%M%S)" +TARGET_DIR="$BACKUP_DIR/$TIMESTAMP" + +mkdir -p "$TARGET_DIR" +chmod 700 "$TARGET_DIR" + +echo "================================================================" +echo " Zabbix GPON API - Rotina de Backup Completo e Seguro" +echo "================================================================" +echo "Data/Hora : $TIMESTAMP" +echo "Destino : $TARGET_DIR" + +# 1. Carrega variáveis de ambiente se o .env existir +if [ -f "$PROJECT_ROOT/.env" ]; then + set -a + # shellcheck disable=SC1090 + . <(grep -E '^(MYSQL_|DB_|APP_|COMPOSE_|GRAFANA_)' "$PROJECT_ROOT/.env" | sed 's/ $//') 2>/dev/null || true + set +a +fi + +DB_USER="${MYSQL_USER:-zabbix_gpon_api}" +DB_PASS="${MYSQL_PASSWORD:-telemetria123}" +ROOT_PASS="${MYSQL_ROOT_PASSWORD:-srcc2030}" +DB_NAME="${MYSQL_DATABASE:-zabbix_gpon_api}" +DB_CONTAINER="${DB_CONTAINER:-zbx_gpon_api_db}" +APP_CONTAINER="${APP_CONTAINER:-zbx_gpon_api_app}" +GRAFANA_CONTAINER="${GRAFANA_CONTAINER:-zbx_gpon_api_grafana}" +PROJECT_NAME="${COMPOSE_PROJECT_NAME:-gpon-api}" + +BACKUP_ERRORS=0 + +# ------------------------------------------------------------------------------ +# 2. BACKUP DO BANCO DE DADOS (MariaDB / MySQL) +# ------------------------------------------------------------------------------ +echo "" +echo "[1/4] 📦 Realizando backup do Banco de Dados MariaDB..." + +# Detecta nome do container do banco se não for o padrão +if ! docker ps --format '{{.Names}}' | grep -q "^${DB_CONTAINER}$"; then + if docker ps --format '{{.Names}}' | grep -q "^zabbix_telemetry_db$"; then + DB_CONTAINER="zabbix_telemetry_db" + fi +fi + +if docker ps --format '{{.Names}}' | grep -q "^${DB_CONTAINER}$"; then + DUMP_FILE="$TARGET_DIR/dump_${DB_NAME}_${TIMESTAMP}.sql.gz" + echo " 👉 Extraindo banco '$DB_NAME' via container '$DB_CONTAINER'..." + + if docker exec -i "$DB_CONTAINER" mariadb-dump -u root -p"$ROOT_PASS" --single-transaction --quick --routines --triggers --databases "$DB_NAME" 2>/dev/null | gzip > "$DUMP_FILE"; then + DUMP_SIZE=$(du -h "$DUMP_FILE" | cut -f1) + echo " ✅ Dump do banco '$DB_NAME' concluído com sucesso ($DUMP_SIZE)." + else + echo " ⚠️ Tentativa com root falhou. Tentando com usuário '$DB_USER'..." + if docker exec -i "$DB_CONTAINER" mariadb-dump -u "$DB_USER" -p"$DB_PASS" --single-transaction --quick --routines --triggers --databases "$DB_NAME" 2>/dev/null | gzip > "$DUMP_FILE"; then + DUMP_SIZE=$(du -h "$DUMP_FILE" | cut -f1) + echo " ✅ Dump do banco '$DB_NAME' concluído com sucesso ($DUMP_SIZE)." + else + echo " ❌ ERRO CRÍTICO: Falha ao exportar banco '$DB_NAME'!" + BACKUP_ERRORS=$((BACKUP_ERRORS + 1)) + fi + fi + + # Se existir banco zabbix compartilhado, faz dump opcional também + if docker exec -i "$DB_CONTAINER" mariadb -u root -p"$ROOT_PASS" -e "USE zabbix;" 2>/dev/null; then + echo " 👉 Extraindo banco Zabbix Server ('zabbix')..." + ZBX_DUMP_FILE="$TARGET_DIR/dump_zabbix_server_${TIMESTAMP}.sql.gz" + docker exec -i "$DB_CONTAINER" mariadb-dump -u root -p"$ROOT_PASS" --single-transaction --quick --databases zabbix 2>/dev/null | gzip > "$ZBX_DUMP_FILE" || true + echo " ✅ Dump do banco Zabbix concluído." + fi +else + echo " ❌ ERRO: Container MariaDB '$DB_CONTAINER' não está rodando. O banco NÃO foi salvo!" + BACKUP_ERRORS=$((BACKUP_ERRORS + 1)) +fi + +# ------------------------------------------------------------------------------ +# 3. BACKUP DO GRAFANA (grafana.db + dashboards locais) +# ------------------------------------------------------------------------------ +echo "" +echo "[2/4] 📊 Realizando backup das configurações e dashboards do Grafana..." + +# Detecta se container do grafana está rodando +if ! docker ps --format '{{.Names}}' | grep -q "^${GRAFANA_CONTAINER}$"; then + if docker ps --format '{{.Names}}' | grep -q "^zabbix_telemetry_grafana$"; then + GRAFANA_CONTAINER="zabbix_telemetry_grafana" + fi +fi + +GRAFANA_SAVED=false +if docker ps --format '{{.Names}}' | grep -q "^${GRAFANA_CONTAINER}$"; then + echo " 👉 Copiando banco interno do Grafana (usuários, preferências, dashboards UI)..." + if docker cp "$GRAFANA_CONTAINER:/var/lib/grafana/grafana.db" "$TARGET_DIR/grafana.db" 2>/dev/null; then + GF_SIZE=$(du -h "$TARGET_DIR/grafana.db" | cut -f1) + echo " ✅ grafana.db copiado com sucesso ($GF_SIZE)." + GRAFANA_SAVED=true + fi +fi + +# Se não conseguiu pelo container ativo, tenta pelo volume nomeado +if [ "$GRAFANA_SAVED" = false ]; then + GF_VOLUME="${PROJECT_NAME}_grafana_data" + if docker volume inspect "$GF_VOLUME" >/dev/null 2>&1; then + echo " 👉 Container inativo. Extraindo grafana.db do volume '$GF_VOLUME'..." + docker run --rm -v "$GF_VOLUME:/from:ro" -v "$TARGET_DIR:/to" alpine cp /from/grafana.db /to/ 2>/dev/null || true + if [ -f "$TARGET_DIR/grafana.db" ]; then + echo " ✅ grafana.db extraído do volume com sucesso." + GRAFANA_SAVED=true + fi + fi +fi + +# Backup dos arquivos locais de dashboards se existirem +if [ -d "$PROJECT_ROOT/grafana/dashboards" ]; then + echo " 👉 Compactando arquivos de dashboards locais (grafana/dashboards/)..." + tar -czf "$TARGET_DIR/dashboards_backup_${TIMESTAMP}.tar.gz" -C "$PROJECT_ROOT/grafana" dashboards 2>/dev/null || true + echo " ✅ Dashboards locais arquivados com sucesso." +fi + +if [ "$GRAFANA_SAVED" = false ]; then + echo " ℹ️ Nenhum dado do Grafana encontrado para backup (Grafana pode não estar ativo nesta stack)." +fi + +# ------------------------------------------------------------------------------ +# 4. BACKUP DO ARQUIVO DE LICENÇA (.license.lic) +# ------------------------------------------------------------------------------ +echo "" +echo "[3/4] 🔑 Realizando backup da Licença Ativa (.license.lic)..." +LICENSE_SAVED=false + +# Tenta copiar do container da aplicação +if docker ps --format '{{.Names}}' | grep -q "^${APP_CONTAINER}$"; then + if docker exec -i "$APP_CONTAINER" test -f /app/data/.license.lic 2>/dev/null; then + docker exec -i "$APP_CONTAINER" cat /app/data/.license.lic > "$TARGET_DIR/.license.lic" 2>/dev/null || true + if [ -s "$TARGET_DIR/.license.lic" ]; then + echo " ✅ Licença copiada com sucesso do container '$APP_CONTAINER'." + LICENSE_SAVED=true + fi + fi +fi + +# Tenta copiar do host local se não copiou do container +if [ "$LICENSE_SAVED" = false ] && [ -f "$PROJECT_ROOT/data/.license.lic" ]; then + cp "$PROJECT_ROOT/data/.license.lic" "$TARGET_DIR/.license.lic" + echo " ✅ Licença copiada com sucesso da pasta local data/.license.lic." + LICENSE_SAVED=true +fi + +if [ "$LICENSE_SAVED" = false ]; then + echo " ℹ️ Nenhuma licença ativa encontrada no momento." +fi + +# ------------------------------------------------------------------------------ +# 5. BACKUP DAS CONFIGURAÇÕES DE AMBIENTE (.env) +# ------------------------------------------------------------------------------ +echo "" +echo "[4/4] ⚙️ Realizando backup das Configurações de Ambiente (.env)..." +if [ -f "$PROJECT_ROOT/.env" ]; then + cp "$PROJECT_ROOT/.env" "$TARGET_DIR/.env" + chmod 600 "$TARGET_DIR/.env" + echo " ✅ Arquivo .env arquivado com permissões protegidas (chmod 600)." +else + echo " ℹ️ Arquivo .env não encontrado no diretório raiz." +fi + +# ------------------------------------------------------------------------------ +# 6. CRIAÇÃO DO MANIFESTO DE BACKUP +# ------------------------------------------------------------------------------ +cat < "$TARGET_DIR/manifest.json" +{ + "timestamp": "$TIMESTAMP", + "database": "$DB_NAME", + "db_container": "$DB_CONTAINER", + "files": [ +$(find "$TARGET_DIR" -type f -printf ' {"file": "%f", "size": "%s"}, +' 2>/dev/null | sed '$ s/,$//') + ] +} +EOF + +# ------------------------------------------------------------------------------ +# 7. POLÍTICA DE RETENÇÃO (Remove backups com mais de 15 dias) +# ------------------------------------------------------------------------------ +echo "" +echo "🧹 Verificando retenção de backups (removendo pastas com mais de 15 dias)..." +find "$BACKUP_DIR" -mindepth 1 -maxdepth 1 -type d -mtime +15 -exec rm -rf {} + 2>/dev/null || true + +# ------------------------------------------------------------------------------ +# 8. VERIFICAÇÃO FINAL +# ------------------------------------------------------------------------------ +echo "" +echo "================================================================" +if [ $BACKUP_ERRORS -gt 0 ]; then + echo "❌ ATENÇÃO: O backup foi concluído com erros! Revise as mensagens acima." + exit 1 +else + echo "🎉 BACKUP COMPLETO CONCLUÍDO COM 100% DE SUCESSO!" + echo "📁 Arquivos salvos em: $TARGET_DIR" + ls -lh "$TARGET_DIR" + echo "================================================================" + exit 0 +fi diff --git a/scripts/restore.sh b/scripts/restore.sh new file mode 100755 index 0000000..708d24e --- /dev/null +++ b/scripts/restore.sh @@ -0,0 +1,147 @@ +#!/usr/bin/env bash +# ============================================================================== +# Script de Restauração de Backup Completo - Zabbix GPON API +# Restaura: MariaDB, Grafana (grafana.db + dashboards) e Licença +# ============================================================================== +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)" +BACKUP_DIR="$PROJECT_ROOT/backups" + +# 1. Carrega variáveis de ambiente se o .env existir +if [ -f "$PROJECT_ROOT/.env" ]; then + set -a + # shellcheck disable=SC1090 + . <(grep -E '^(MYSQL_|DB_|APP_|COMPOSE_|GRAFANA_)' "$PROJECT_ROOT/.env" | sed 's/ $//') 2>/dev/null || true + set +a +fi + +DB_USER="${MYSQL_USER:-zabbix_gpon_api}" +DB_PASS="${MYSQL_PASSWORD:-telemetria123}" +ROOT_PASS="${MYSQL_ROOT_PASSWORD:-srcc2030}" +DB_NAME="${MYSQL_DATABASE:-zabbix_gpon_api}" +DB_CONTAINER="${DB_CONTAINER:-zbx_gpon_api_db}" +APP_CONTAINER="${APP_CONTAINER:-zbx_gpon_api_app}" +GRAFANA_CONTAINER="${GRAFANA_CONTAINER:-zbx_gpon_api_grafana}" + +echo "================================================================" +echo " Zabbix GPON API - Restauração de Dados Completa" +echo "================================================================" + +# 2. Determina qual diretório de backup ou arquivo restaurar +TARGET_INPUT="${1:-}" +BACKUP_SUBDIR="" +RESTORE_FILE="" + +if [ -z "$TARGET_INPUT" ]; then + echo "Buscando backups disponíveis em '$BACKUP_DIR'..." + if [ ! -d "$BACKUP_DIR" ] || [ -z "$(ls -A "$BACKUP_DIR" 2>/dev/null)" ]; then + echo "❌ Nenhum backup encontrado em $BACKUP_DIR." + echo "Uso: ./scripts/restore.sh [caminho/para/pasta_ou_dump.sql.gz]" + exit 1 + fi + + # Pega o diretório de backup mais recente + LATEST_DIR=$(find "$BACKUP_DIR" -mindepth 1 -maxdepth 1 -type d -printf '%T+ %p +' 2>/dev/null | sort -r | head -n1 | cut -d' ' -f2-) + if [ -n "$LATEST_DIR" ]; then + BACKUP_SUBDIR="$LATEST_DIR" + RESTORE_FILE=$(find "$BACKUP_SUBDIR" -type f -name "dump_${DB_NAME}_*.sql.gz" | head -n1) + fi +else + if [ -d "$TARGET_INPUT" ]; then + BACKUP_SUBDIR="$TARGET_INPUT" + RESTORE_FILE=$(find "$BACKUP_SUBDIR" -type f -name "dump_${DB_NAME}_*.sql.gz" | head -n1) + elif [ -f "$TARGET_INPUT" ]; then + RESTORE_FILE="$TARGET_INPUT" + BACKUP_SUBDIR="$(dirname "$RESTORE_FILE")" + fi +fi + +if [ -z "$RESTORE_FILE" ] || [ ! -f "$RESTORE_FILE" ]; then + echo "❌ Nenhum dump SQL válido encontrado no caminho especificado." + exit 1 +fi + +echo "Pasta de Backup Selecionada: $BACKUP_SUBDIR" +echo "Arquivo de Dump MariaDB : $RESTORE_FILE" +echo "Tamanho do Dump : $(du -h "$RESTORE_FILE" | cut -f1)" +echo "" +read -p "⚠️ Deseja realmente iniciar a restauração dos dados? (s/N): " -r CONFIRM +if [[ ! "$CONFIRM" =~ ^[sS]$ ]]; then + echo "Operação cancelada pelo usuário." + exit 0 +fi + +# 3. Restauração do MariaDB +echo "" +echo "[1/3] 📥 Restaurando Banco de Dados MariaDB..." +if ! docker ps --format '{{.Names}}' | grep -q "^${DB_CONTAINER}$"; then + echo "❌ Container '$DB_CONTAINER' não está rodando. Suba a stack com 'docker compose up -d' primeiro." + exit 1 +fi + +echo " 👉 Garantindo banco de dados '$DB_NAME' e permissões..." +docker exec -i "$DB_CONTAINER" mariadb -u root -p"$ROOT_PASS" -e " +CREATE DATABASE IF NOT EXISTS \`$DB_NAME\` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; +CREATE USER IF NOT EXISTS '$DB_USER'@'%' IDENTIFIED BY '$DB_PASS'; +GRANT ALL PRIVILEGES ON \`$DB_NAME\`.* TO '$DB_USER'@'%'; +FLUSH PRIVILEGES; +" 2>/dev/null || true + +echo " 👉 Importando tabelas e registros no banco '$DB_NAME'..." +gunzip -c "$RESTORE_FILE" | docker exec -i "$DB_CONTAINER" mariadb -u root -p"$ROOT_PASS" "$DB_NAME" +echo " ✅ Banco de dados '$DB_NAME' restaurado com sucesso!" + +# Restauração opcional do Zabbix Server se existir no backup +ZBX_DUMP=$(find "$BACKUP_SUBDIR" -type f -name "dump_zabbix_server_*.sql.gz" | head -n1 || true) +if [ -n "$ZBX_DUMP" ] && [ -f "$ZBX_DUMP" ]; then + echo " 👉 Encontrado dump do Zabbix Server. Deseja restaurá-lo também? (s/N): " + read -p " Confirmar restauração do banco 'zabbix'? (s/N): " -r CONFIRM_ZBX + if [[ "$CONFIRM_ZBX" =~ ^[sS]$ ]]; then + gunzip -c "$ZBX_DUMP" | docker exec -i "$DB_CONTAINER" mariadb -u root -p"$ROOT_PASS" zabbix 2>/dev/null || true + echo " ✅ Banco do Zabbix Server restaurado!" + fi +fi + +# 4. Restauração do Grafana (grafana.db + dashboards) +echo "" +echo "[2/3] 📊 Verificando backup do Grafana..." +if [ -f "$BACKUP_SUBDIR/grafana.db" ]; then + if docker ps --format '{{.Names}}' | grep -q "^${GRAFANA_CONTAINER}$"; then + echo " 👉 Restaurando banco interno do Grafana (grafana.db)..." + docker cp "$BACKUP_SUBDIR/grafana.db" "$GRAFANA_CONTAINER:/var/lib/grafana/grafana.db" + docker restart "$GRAFANA_CONTAINER" >/dev/null + echo " ✅ grafana.db restaurado e container do Grafana reiniciado com sucesso!" + else + echo " ℹ️ Container do Grafana não está ativo no momento. grafana.db disponível em: $BACKUP_SUBDIR/grafana.db" + fi +fi + +DASHBOARDS_TAR=$(find "$BACKUP_SUBDIR" -type f -name "dashboards_backup_*.tar.gz" | head -n1 || true) +if [ -n "$DASHBOARDS_TAR" ] && [ -f "$DASHBOARDS_TAR" ]; then + echo " 👉 Restaurando arquivos de dashboards em grafana/dashboards/..." + tar -xzf "$DASHBOARDS_TAR" -C "$PROJECT_ROOT/grafana" 2>/dev/null || true + echo " ✅ Dashboards restaurados no host com sucesso." +fi + +# 5. Restauração da Licença Ativa +echo "" +echo "[3/3] 🔑 Verificando arquivo de licença..." +if [ -f "$BACKUP_SUBDIR/.license.lic" ]; then + if docker ps --format '{{.Names}}' | grep -q "^${APP_CONTAINER}$"; then + docker cp "$BACKUP_SUBDIR/.license.lic" "$APP_CONTAINER:/app/data/.license.lic" + echo " ✅ Licença restaurada no container '$APP_CONTAINER'." + fi + mkdir -p "$PROJECT_ROOT/data" + cp "$BACKUP_SUBDIR/.license.lic" "$PROJECT_ROOT/data/.license.lic" 2>/dev/null || true + echo " ✅ Licença arquivada em data/.license.lic." +fi + +echo "" +echo "================================================================" +echo "🎉 RESTAURAÇÃO FINALIZADA COM SUCESSO!" +echo "Verifique a integridade da aplicação com:" +echo "👉 curl http://localhost:8000/api/v1/health" +echo "================================================================" diff --git a/scripts/update.sh b/scripts/update.sh new file mode 100755 index 0000000..982ebea --- /dev/null +++ b/scripts/update.sh @@ -0,0 +1,45 @@ +#!/usr/bin/env bash +# ============================================================================== +# Script de Atualização do Cliente - Zabbix GPON API +# Executa backup prévio e baixa a nova versão da imagem Docker +# ============================================================================== +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)" + +cd "$PROJECT_ROOT" + +echo "================================================================" +echo " Zabbix GPON API - Atualização de Versão" +echo "================================================================" + +# 1. Backup Preventivo +echo "PASSO 1/4: Realizando backup preventivo..." +if [ -x "$SCRIPT_DIR/backup.sh" ]; then + "$SCRIPT_DIR/backup.sh" +else + echo "❌ Script de backup não encontrado." + exit 1 +fi + +# 2. Sincroniza arquivos de configuração (Git Pull) +echo "" +echo "PASSO 2/4: Baixando melhorias de scripts e dashboards..." +git pull origin main || true + +# 3. Baixa nova imagem Docker compilada +echo "" +echo "PASSO 3/4: Baixando imagem Docker mais recente..." +docker compose pull app + +# 4. Reinicia a aplicação +echo "" +echo "PASSO 4/4: Reiniciando containers..." +docker compose up -d + +echo "" +echo "================================================================" +echo "🎉 ATUALIZAÇÃO CONCLUÍDA COM SUCESSO!" +echo "Verifique a saúde da API em: curl http://localhost:8000/api/v1/health" +echo "================================================================"