itgainis/s4dbs_service

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可用）一起通过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. 创建一个新文件夹，名称为您希望Speedgain服务运行的名称（例如“speedgain”）
3. 在该文件夹中创建名为“configuration”的子文件夹
4. 将网站上的nginx.conf文件复制到configuration文件夹中 (nginx.conf 地址：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步之前完成以下步骤。

1. 如需启用SSL，首先需要包含SSL证书数据的.crt和.key文件。
2. 在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. 打开configuration文件夹中的nginx.conf文件，找到以下行并启用4行配置：

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

文档、帮助与支持

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

镜像信息

持久化存储

Speedgain for Databases有两个持久化卷：

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

自定义选项

1. 日志配置为每个容器每个文件10MB，最多5个文件，可根据需求调整
2. 所有容器在故障或系统重启后（如果容器服务本身重启）将自动重启
3. 端口可调整，但可能需要更改部分配置 - 详情请咨询支持
4. PostgreSQL端口转发为可选，服务正常运行不需要

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=<PasswordOfPostgresUser> 
    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=<PasswordOfPostgresUser_specified_in_s4dbs_postgres_section>
      - 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=<PasswordOfPostgresUser_specified_in_s4dbs_postgres_section>
      - 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=<PasswordOfPostgresUser_specified_in_s4dbs_postgres_section>
      - 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部分使用自定义仪表板卷时需要