itgainis/s4dbs_collector

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

镜像概述和主要用途

Speedgain for Databases 是一款专为数据库监控设计的一体化解决方案，旨在通过集中化监控不同操作系统和数据库环境，帮助用户降低成本、节省时间并提升监控效率。该方案支持无代理监控多种主流数据库和Linux系统，提供自定义仪表板和基于策略的简化配置，适用于需要高效管理多数据库环境的企业级用户。

核心功能和特性

• 集中化监控解决方案，支持多种操作系统和数据库，有效降低监控成本
• 无代理监控Db2、PostgreSQL、SQL Server、Oracle、Azure SQL Database及Linux（更多类型即将支持）
• 自定义仪表板功能，满足不同监控需求，提升监控效率
• 基于策略的监控机制，最小化配置复杂度
• 专为时序数据设计的可扩展、高性能数据存储库，节省管理时间

前提条件

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

注意：本镜像无法单独运行，必须与其他4个镜像配合使用（均在Docker Hub可用）。所有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. 创建一个新文件夹，名称为您希望Speedgain服务运行的名称（例如"speedgain"）
3. 在该文件夹中创建名为"configuration"的子文件夹
4. 从官方网站复制nginx.conf文件到configuration文件夹中 (nginx.conf 下载地址)
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格式的SSL证书

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文件，找到以下行并启用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文件，找到以下行：

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

   将端口从"80"改为"443"，协议从"http"改为"https"。

   进一步向下，激活以下行：

   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步启动所有服务。

持久化存储

Speedgain for Databases有两个持久卷：

1. s4dbs_postgres - 用于timescale容器存储性能和配置数据
2. s4dbs_grafana - 用于存储Grafana的持久化对象

自定义选项

1. 日志配置默认每个文件10MB，每个容器最多5个文件，可根据需求调整
2. 所有容器在故障或系统重启后会自动重启（如果容器服务本身重启）
3. 端口可以调整，但可能需要修改相关配置 - 如需详细信息请联系支持团队
4. PostgreSQL端口转发是可选的，不影响服务正常运行

文档与支持

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

Docker Compose配置示例

使用以下docker-compose配置部署Speedgain for Databases：

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的自定义文件夹
    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部分使用自定义仪表板卷时需要