Apache Superset 配置指南：从基础到高级设置

Apache Superset 配置指南：从基础到高级设置

superset Apache Superset is a Data Visualization and Data Exploration Platform 项目地址: https://gitcode.com/gh_mirrors/supers/superset

概述

Apache Superset 是一个现代化的企业级商业智能（BI）工具，它提供了强大的数据可视化和仪表板功能。本文将详细介绍如何配置 Superset，从基础设置到高级定制，帮助您根据实际需求优化 Superset 的运行环境。

基础配置

配置文件概述

Superset 通过 superset_config.py 文件提供数百个可配置参数，这些参数控制着 Superset 的各个方面。与直接修改核心配置文件不同，最佳实践是创建自己的配置文件来覆盖默认设置。

配置文件的加载方式

有两种主要方式让 Superset 加载您的自定义配置：

1. 环境变量方式：

export SUPERSET_CONFIG_PATH=/path/to/your/superset_config.py

2. Docker 部署方式：

COPY --chown=superset superset_config.py /app/
ENV SUPERSET_CONFIG_PATH /app/superset_config.py

关键配置项详解

安全密钥设置

SECRET_KEY 是 Superset 最重要的配置之一，用于安全地签名会话 cookie 和加密数据库中的敏感信息。必须为生产环境设置一个强密钥。

# 使用 openssl rand -base64 42 生成强密钥
SECRET_KEY = 'your-random-generated-secret-key-here'

如果需要更换密钥，可以添加旧密钥作为 PREVIOUS_SECRET_KEY，然后运行 superset re-encrypt-secrets 命令重新加密现有数据。

元数据数据库配置

Superset 需要一个数据库来存储其管理的元数据（如图表、仪表板定义等）。虽然默认使用 SQLite，但生产环境强烈建议使用更强大的数据库。

支持的数据库引擎

| 数据库类型 | 支持版本 | 连接字符串示例 | 所需驱动包 | |------------|--------------|---------------------------------------|----------------| | PostgreSQL | 10.X-15.X | postgresql://user:pass@host/dbname | pip install psycopg2 | | MySQL | 5.7, 8.X | mysql://user:pass@host/dbname | pip install mysqlclient |

示例配置：

SQLALCHEMY_DATABASE_URI = 'postgresql://superset:superset@localhost/superset'

生产环境部署建议

WSGI 服务器配置

对于生产环境，推荐使用 Gunicorn 作为 WSGI 服务器，特别是其异步工作模式：

gunicorn \
  -w 10 \
  -k gevent \
  --worker-connections 1000 \
  --timeout 120 \
  -b 0.0.0.0:8080 \
  --limit-request-line 0 \
  --limit-request-field_size 0 \
  "superset.app:create_app()"

HTTPS 配置

可以通过以下方式实现 HTTPS：

1. 在负载均衡器或反向代理（如 Nginx）上终止 SSL/TLS
2. 直接在 Gunicorn 中配置 SSL（如果使用官方 Docker 镜像）

负载均衡器配置

当 Superset 运行在负载均衡器后面时：

1. 启用健康检查端点 /health
2. 如果负载均衡器插入 X-Forwarded-For/X-Forwarded-Proto 头，设置：

ENABLE_PROXY_FIX = True

高级配置

自定义 OAuth2 集成

Superset 支持通过 Flask-AppBuilder 集成各种 OAuth2 提供程序。以下是自定义 OAuth2 配置示例：

from flask_appbuilder.security.manager import AUTH_OAUTH

AUTH_TYPE = AUTH_OAUTH

OAUTH_PROVIDERS = [
    {
        'name': 'myOAuth',
        'icon': 'fa-cloud',
        'remote_app': {
            'client_id': 'your-client-id',
            'client_secret': 'your-client-secret',
            'api_base_url': 'https://oauth.provider/api/',
            'access_token_url': 'https://oauth.provider/oauth/token',
            'authorize_url': 'https://oauth.provider/oauth/authorize',
            'client_kwargs': {'scope': 'read'}
        }
    }
]

AUTH_USER_REGISTRATION = True
AUTH_USER_REGISTRATION_ROLE = "Gamma"

对于 OpenID Connect 1.0 兼容的提供程序（如 Keycloak），可以使用更简单的配置：

OAUTH_PROVIDERS = [
    {
        'name': 'keycloak',
        'remote_app': {
            'client_id': 'your-client-id',
            'client_secret': 'your-client-secret',
            'server_metadata_url': 'https://keycloak/auth/realms/your-realm/.well-known/openid-configuration'
        }
    }
]

Keycloak 专用配置

对于 Keycloak 集成，可以使用 Flask-OIDC 替代方案。首先创建自定义安全管理器：

# keycloak_security_manager.py
from flask_appbuilder.security.manager import AUTH_OID
from superset.security import SupersetSecurityManager
from flask_oidc import OpenIDConnect

class OIDCSecurityManager(SupersetSecurityManager):
    def __init__(self, appbuilder):
        super().__init__(appbuilder)
        if self.auth_type == AUTH_OID:
            self.oid = OpenIDConnect(self.appbuilder.get_app)

然后在配置中启用：

from keycloak_security_manager import OIDCSecurityManager
CUSTOM_SECURITY_MANAGER = OIDCSecurityManager
AUTH_TYPE = AUTH_OID

性能调优

缓存配置

Superset 支持多种缓存后端，推荐使用 Redis 作为缓存：

from superset.typing import CacheConfig

CACHE_CONFIG: CacheConfig = {
    'CACHE_TYPE': 'RedisCache',
    'CACHE_DEFAULT_TIMEOUT': 86400,
    'CACHE_KEY_PREFIX': 'superset_',
    'CACHE_REDIS_URL': 'redis://localhost:6379/0'
}

查询结果限制

调整默认查询行数限制：

ROW_LIMIT = 10000
DEFAULT_SQLLAB_LIMIT = 1000

总结

本文详细介绍了 Apache Superset 的配置方法，从基础的安全设置到高级的 OAuth 集成。正确的配置不仅能确保 Superset 的安全运行，还能优化其性能和用户体验。根据您的具体环境和需求，可以选择性地实施这些配置选项，打造最适合您业务需求的 BI 平台。

superset Apache Superset is a Data Visualization and Data Exploration Platform 项目地址: https://gitcode.com/gh_mirrors/supers/superset