itgainis/s4dbs_grafana

Speedgain for Databases - 一站式数据库监控解决方案

镜像概述和主要用途

Speedgain for Databases 是一款全方位的数据库监控解决方案，旨在通过集中化监控不同操作系统和数据库，帮助用户节省成本和时间。它采用无代理架构，支持多种主流数据库，并提供自定义仪表板和策略式监控，满足各类监控需求，同时具备高效的时序数据存储能力，确保监控数据的可靠管理。

核心功能和特性

• 集中化监控：支持多种操作系统和数据库的集中监控，有效降低成本
• 无代理架构：无需安装代理即可监控 Db2、PostgreSQL、SQL Server、Oracle、Azure SQL Database 和 Linux（更多类型即将支持），节省部署时间
• 自定义仪表板：可根据需求定制仪表板，提升监控效率
• 策略式监控：通过策略化配置降低监控复杂度
• 高效数据存储：专为时序数据设计的可扩展、高性能数据存储库，确保数据高效管理

前提条件

1. 需要有效的许可证文件（可从 speedgain.com 获取）
2. 能够运行 docker-compose 文件的平台
3. 足够的 CPU 核心、内存和存储空间
4. 开放端口 80（如需使用 SSL 则开放 443）以访问 Web 服务（PostgreSQL/TimeScale 的 5432 端口为可选）
5. 现代 Web 浏览器

注意：本镜像无法单独运行，必须与其他 4 个镜像（均在 Docker Hub 可用）通过 docker-compose 一起执行。所有 5 个镜像列表如下：

1. Speedgain timescale - 用于存储所有性能指标的存储库
2. Speedgain Collector - 拉取指标的核心组件
3. Speedgain Service - REST API 服务
4. Speedgain Frontend - 配置 Web 前端
5. Speedgain Grafana - 提供所需的所有仪表板
6. NginX - 作为反向代理

快速开始

步骤 1：获取许可证

通过 speedgain.com 获取至少试用许可证

步骤 2：创建目录结构

1. 创建一个新文件夹，名称为您希望运行 Speedgain 服务的名称（例如 "speedgain"）
2. 在该文件夹中创建名为 "configuration" 的子文件夹

步骤 3：准备配置文件

将网站上的 nginx.conf 文件复制到 configuration 文件夹中 (nginx.conf 下载地址)

步骤 4：创建并调整 docker-compose 文件

创建 docker-compose 文件（见下方示例）并根据需求调整，至少需设置 PostgreSQL 密码

步骤 5：加载镜像（如无法直接访问 Docker Hub）

从下载门户下载镜像并传输到目标系统，通过以下命令加载：

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

步骤 6：启动服务

通过以下命令启动所有服务（将创建所有容器）：

bash
docker-compose up -d

步骤 7：访问 Web 界面

打开 Web 浏览器，导航至 http://<Docker主机名>:80/，使用默认用户名和密码 admin/admin 登录

启用 SSL 配置

在执行上述 "快速开始" 章节的步骤 7 之前，请完成以下步骤以启用 SSL。

步骤 1：准备 SSL 证书

获取包含 SSL 证书数据的 .crt 和 .key 文件

步骤 2：创建 SSL 目录

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

bash
mkdir ssl

步骤 3：复制证书文件

将 .crt 和 .key 文件复制到 "ssl" 目录：

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

步骤 4：修改 nginx.conf 配置

打开 configuration 文件夹中的 nginx.conf 文件，找到以下行并启用 4 行 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 配置

打开 docker-compose.yml 文件，找到以下部分并修改：

前端服务配置

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

反向代理服务配置

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 时取消此行注释

需将 SSL 证书文件挂载到 NginX 容器内，并暴露 443 端口，同时禁用 80 端口暴露。

步骤 6：启动服务

完成上述配置后，按照 "快速开始" 章节的步骤 7 启动所有服务。

文档、帮助与支持

• [***]
• X 平台 @s4dbs

镜像信息

持久化存储

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

1. s4dbs_postgres - 用于 timescale 容器存储性能和配置数据
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"
    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部分指定的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部分指定的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部分指定的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部分使用自定义仪表板卷时需要