itgainis/s4dbs_frontend

Speedgain for Databases - 一体化数据库监控解决方案

镜像概述与主要用途

Speedgain for Databases是一款集成化的数据库监控解决方案，旨在通过集中化平台实现对多种操作系统和数据库的高效监控。该方案无需部署代理即可监控主流数据库（如Db2、PostgreSQL、SQL Server、Oracle、Azure SQL Database）和Linux系统，通过自定义仪表板、策略化监控配置及高性能时序数据存储，帮助用户降低监控复杂度、节省时间成本并提升监控效率。

核心功能与特性

• 集中化监控：支持多操作系统和数据库的统一监控，降低管理成本
• 无代理架构：无需在目标数据库或服务器部署代理，简化部署流程，支持Db2、PostgreSQL、SQL Server、Oracle、Azure SQL Database及Linux（更多类型持续扩展）
• 自定义仪表板：可根据需求配置个性化监控仪表板，提升监控效率
• 策略化监控：通过基于策略的监控配置，最小化配置复杂度
• 高效数据存储：专为时序数据设计的可扩展高性能数据仓库，优化监控数据存储与查询

使用场景与适用范围

• 企业级多数据库环境集中监控
• 混合IT架构（本地与云数据库）统一管理
• 需要降低监控代理部署维护成本的场景
• 对监控数据可视化与自定义分析有需求的团队
• 要求监控系统具备可扩展性和高性能的中大型数据库环境

前置要求

1. 有效的许可证文件（可从 speedgain.com 获取）
2. 支持运行docker-compose文件的平台
3. 满足基本硬件要求（CPU、内存及存储空间）
4. 开放端口80（如使用SSL则需443端口）以访问Web服务（5432端口用于PostgreSQL/TimeScaleDB，可选）
5. 现代Web浏览器（用于访问Web界面）

注意：本镜像无法单独运行，需与其他4个镜像（均已在Docker Hub提供）配合使用。完整镜像组合包括：

• Speedgain timescale：存储所有性能指标的数据库
• Speedgain Collector：拉取指标的核心组件
• Speedgain Service：REST API服务
• Speedgain Frontend：配置Web前端
• Speedgain Grafana：提供监控仪表板
• NginX：反向代理

使用方法与配置说明

快速启动步骤

1. 通过speedgain.com获取至少试用许可证
2. 创建新文件夹（如"speedgain"）作为服务运行目录
3. 在该目录下创建"configuration"子文件夹
4. 从官网下载nginx.conf文件至configuration文件夹：(nginx.conf at speedgain.info)
5. 创建并调整docker-compose文件（见下文示例），至少需设置PostgreSQL密码
6. （可选，如无法直接访问Docker Hub）从下载门户获取镜像压缩包，传输至目标系统并加载：

   bash
   docker load --input s4dbs_v<version>_all_images.tar.gz
   

7. 启动所有服务：

   bash
   docker-compose up -d
   

8. 打开Web浏览器，访问 http://<Docker主机名>:80/
9. 使用默认账号密码登录：admin/admin

启用SSL配置

在执行上述"快速启动步骤"的第7步之前，按以下步骤配置SSL：

1. 准备SSL证书文件（.crt和.key格式）

2. 在speedgain服务目录（如"speedgain"）中创建"ssl"文件夹：

   bash
   mkdir ssl
   

3. 将证书文件复制到"ssl"文件夹：

   bash
   cp company_ssl.key ./ssl/ssl_cert.key
   cp company_ssl.crt ./ssl/ssl_cert.crt
   

4. 编辑configuration文件夹中的nginx.conf文件，启用SSL配置行：

   bash
   ...
     server {
   ...
   #SSL配置
   # 如需启用SSL，取消以下4行注释：
   #    listen 443 ssl http2;
   #    listen [::]:443 ssl http2;
   #    ssl_certificate_key /etc/ssl/ssl_cert.key;
   #    ssl_certificate     /etc/ssl/ssl_cert.crt;
   

   保存并关闭文件

5. 编辑docker-compose.yml文件，修改以下配置：

   • s4dbs_frontend服务：更新协议和端口为https/443

     bash
     ...
     s4dbs_frontend:
     ...
       environment:
         - FRONTEND_CONFIG_MODE=false
         - SERVICE_PROTOCOL=https                             # 改为https
         - SERVICE_HOST=<输入容器主机名>
         - SERVICE_PORT=443                                   # 改为443
         - GRAFANA_PROTOCOL=https                             # 改为https
         - GRAFANA_HOST=<输入容器主机名>
         - GRAFANA_PORT=443/grafana                           # 改为443
      ...
     

   • s4dbs_reverse服务：启用443端口，禁用80端口，挂载SSL证书

     bash
     ...
     s4dbs_reverse:
     ...
       ports:
         #- "80:80"      # 使用SSL时禁用此行
         - "443:443"   # 启用此行以激活SSL
       ...
       volumes:
         - ./configuration/nginx.conf:/etc/nginx/nginx.conf           # 在配置文件中启用SSL
         - ./ssl/ssl_cert.key:/etc/ssl/ssl_cert.key    # 启用此行挂载SSL密钥
         - ./ssl/ssl_cert.crt:/etc/ssl/ssl_cert.crt    # 启用此行挂载SSL证书
     

6. 完成上述配置后，按"快速启动步骤"第7步启动服务

镜像信息

持久化存储

Speedgain for Databases包含两个持久化卷：

1. s4dbs_postgres：用于TimeScaleDB容器存储性能指标和配置数据
2. s4dbs_grafana：用于存储Grafana的持久化对象（如仪表板配置）

自定义选项

1. 日志配置：默认每个容器日志文件大小为10MB，最多保留5个文件，可根据需求调整
2. 自动重启：所有容器在故障或系统重启后（若容器服务自身重启）将自动重启
3. 端口调整：支持端口自定义，但可能需要同步修改相关配置，建议调整前联系技术支持
4. PostgreSQL端口转发：可选配置，非服务运行必需

Docker Compose配置示例

compose
version: "3.9"

services:
  s4dbs_postgres:
    image: itgainis/s4dbs_timescaledb:<Version>
    restart: always
    logging:
      driver: "json-file"
      options:
        max-size: 10m
        max-file: "5"
    volumes: 
      - s4dbs_postgres:/var/lib/postgresql/data
    ports: 
      - "5432:5432"  # 可选，PostgreSQL端口转发
    environment: 
      - POSTGRES_PASSWORD=<Postgres用户密码>  # 需设置
    privileged: true

  s4dbs_collector:
    image: itgainis/s4dbs_collector:<Version>
    restart: always
    logging:
      driver: "json-file"
      options:
        max-size: 10m
        max-file: "5"
    environment:    
      - PDB_USER=postgres
      - PDB_PASS=<与s4dbs_postgres配置的密码一致>
      - PDB_HOST=s4dbs_postgres
      - PDB_PORT=5432
      - PDB_DB_NAME=speedgain
      - SPGLOGLEVEL=INFO
    privileged: true
    depends_on:
      - s4dbs_postgres

  s4dbs_service:
    image: itgainis/s4dbs_service:<Version>
    restart: always
    logging:
      driver: "json-file"
      options:
        max-size: 10m
        max-file: "5"
    environment: 
      - PDB_USER=postgres
      - PDB_PASS=<与s4dbs_postgres配置的密码一致>
      - PDB_HOST=s4dbs_postgres
      - PDB_PORT=5432
      - PDB_DB_NAME=speedgain
      - PDB_PROPERTIES=
      - SPGDB_SERVICE_HOME=/opt/spgdb_service_home/
    privileged: true
    depends_on:
      - s4dbs_postgres

  s4dbs_grafana:
    image: itgainis/s4dbs_grafana:<Version>
    restart: always
    logging:
      driver: "json-file"
      options:
        max-size: 10m
        max-file: "5"
    volumes: 
      - s4dbs_grafana:/var/lib/grafana
      #- <本地自定义仪表板路径>:/s4dbs_custom_boards # 自定义JSON格式仪表板将自动加载至S4DBs的Custom文件夹
    environment:
      - PDB_USER=postgres
      - PDB_PASS=<与s4dbs_postgres配置的密码一致>
      - PDB_HOST=s4dbs_postgres
      - PDB_PORT=5432
      - PDB_DB_NAME=speedgain
      - GF_SERVER_SERVE_FROM_SUB_PATH=true
      - GF_SERVER_ROOT_URL=%(protocol)s://%(domain)s:%(http_port)s/grafana/
    privileged: true
    depends_on:
      - s4dbs_postgres

  s4dbs_frontend:
    image: itgainis/s4dbs_frontend:<Version>
    restart: always
    logging:
      driver: "json-file"
      options:
        max-size: 10m
        max-file: "5"
    environment:
      - frontendConfigMode=false
    privileged: true
    depends_on:
      - s4dbs_postgres

  s4dbs_reverse:
    image: nginx:1.23
    restart: unless-stopped
    logging:
      driver: "json-file"
      options:
        max-size: 10m
        max-file: "5"
    ports:
      - "80:80"     # 使用SSL时禁用此行
      #- "443:443"   # 启用SSL时启用此行
    depends_on:
      - s4dbs_grafana
      - s4dbs_frontend
      - s4dbs_service
    volumes:
      - ./configuration/nginx.conf:/etc/nginx/nginx.conf           # 在配置文件中启用SSL
      #- ./ssl/ssl_cert.key:/etc/ssl/ssl_cert.key    # 启用SSL时挂载密钥
      #- ./ssl/ssl_cert.crt:/etc/ssl/ssl_cert.crt    # 启用SSL时挂载证书

volumes: 
  s4dbs_postgres:
  s4dbs_grafana:
  #s4dbs_grafana_custom_boards: # 仅在grafana服务中使用自定义仪表板卷时需要

文档与支持

• 官方文档：[***]
• X平台（原***）：@s4dbs