Apache Superset介绍与安装

  • 1. 什么是Superset?
  • 2. 环境搭建
  • 2.1 Conda 安装
  • 2.2 虚拟环境安装
  • 2.3 Superset的安装
  • 3. 初始化数据库
  • 4. 创建管理员账户
  • 5. 初始化角色和权限
  • 6. 载入示例数据
  • 7. 启动服务
  • 8. Superset 简单汉化

1. 什么是Superset?

Apache Superset是一个现代的、企业级的商业智能(BI)WEB应用程序,我们可以简单的理解成它是一个开源的数据可视化工具。支持丰富的数据源连接,如:MySQL、DB2、SQL Server、Oracle等,支持多种可视化方式,并能够对用户实现细粒度的权限控制。该工具主要特点是可自助分析、自定义仪表盘、分析结果可视化、用户/角色权限控制,还集成了一个SQL编辑器,可以进行SQL编辑查询等。Superset的前端基于JavaScript,后端基于Python。

2. 环境搭建

2.1 Conda 安装

这里我们以Linux的操作系统为例,个人建议还是使用Linux系统,Windows系统可能坑比较多,由于Superset的后端是基于Python的,所以我们首先需要安装Python,为了方便我们对不同的Python版本进行管理,这里我们使用conda来搭建Python的环境,conda默认随miniconda或anaconda发行,因此要安装conda,只需要安装miniconda或anconda即可,我们这里使用miniconda,安装步骤如下,本部分参考了行路南文章:

  1. 首先从官网找到conda下载链接,然后使用wget命令下载,代码如下:
wget -c https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
  1. 文件下载完成后,使用chmod命令为文件赋权:
chmod 777 Miniconda3-latest-Linux-x86_64.sh #给执行权限
  1. 执行文件,一路安装即可
bash Miniconda3-latest-Linux-x86_64.sh #运行

安装完成后,我们可以通过conda -V,查看版本:

(base) [root@iZ8vb15btme7rdyvwu43dyZ bin]# conda -V
conda 4.10.3

下面我们开始创建python的环境,这里我们我们使用的python版本为3.6,常用的conda命令如下:

# 查看已有的虚拟环境
conda env list 
# 创建一个conda环境
conda create -n env_name python=x.x
# 删除一个conda环境
conda remove -n env_name --all
# 激活conda环境
conda activate env_name
# 退出conda环境
conda deactivate

当我们进入某一个虚拟环境后,我们可以使用如下的命令,进行包的安装、更新等操作:

# 查看已安装的package
conda list
# 安装某个package
conda install [package]
# 删除某个package
conda remove [package]
# 更新某个package
conda update [package]
# 更新conda,保持conda最新
conda update conda

2.2 虚拟环境安装

Python 应用有时需要依赖特定的包或者库的版本,所以不能有一个能适应所有 Python 应用的软件环境,很多时候不同的 Python 应用所依赖的版本是冲突的,通过虚拟环境可以解决这类问题。首先现将通过conda activate env_name命令的方式,切换到我们的Python3.5 的版本,然后通过pip install virtualenv命令安装virtualenv,最后我们通过virtualenv myvenv指令创建一个纯净的虚拟环境。这里的--no-site-packages参数,表示创建虚拟环境时,不复制主环境中安装的第三方包,也就是创建一个 “干净的” 虚拟环境。此部分参考简说Python。
创建完成后会在当前目录下生成一个目录,进入到/supersetEnv/bin目录里面,执行source ./activate命令激活环境即可。

2.3 Superset的安装

Python环境安装完成后,打开终端,在命令行中输入如下命令,安装Superset,安装成功即可。

pip install apache-superset

3. 初始化数据库

执行如下命令,初始化一下数据库

superset db upgrade

有的时候可能会遇到一些包不存在的报错,这个时候,我们可以手动的安装一下,我在安装的过程中,报了如下的错:

Traceback (most recent call last):
  File "superset", line 5, in <module>
    from superset.cli import superset
  File "/root/env/bigdataEnv/env_superset/lib/python3.6/site-packages/superset/__init__.py", line 21, in <module>
    from superset.app import create_app
  File "/root/env/bigdataEnv/env_superset/lib/python3.6/site-packages/superset/app.py", line 45, in <module>
    from superset.security import SupersetSecurityManager
  File "/root/env/bigdataEnv/env_superset/lib/python3.6/site-packages/superset/security/__init__.py", line 17, in <module>
    from superset.security.manager import SupersetSecurityManager  # noqa: F401
  File "/root/env/bigdataEnv/env_superset/lib/python3.6/site-packages/superset/security/manager.py", line 44, in <module>
    from superset import sql_parse
  File "/root/env/bigdataEnv/env_superset/lib/python3.6/site-packages/superset/sql_parse.py", line 18, in <module>
    from dataclasses import dataclass
ModuleNotFoundError: No module named 'dataclasses'

由于缺少了dataclasses模块,手动执行一下命令pip install dataclasses就可以了

4. 创建管理员账户

数据库初始化完成后,我们需要创建一个登录的账户,执行如下命令,创建一个账户superset fab create-admin,执行命令后,输入用户名、邮箱、密码即可创建成功,如下:

INFO:superset.utils.screenshots:No PIL installation found
Username [admin]: admin
User first name [admin]: admin
User last name [user]: admin
Email [admin@fab.org]: admin@fab.org
Password: 123456
Repeat for confirmation: 
Recognized Database Authentications.
Admin User admin created.

5. 初始化角色和权限

账户创建完成后,可以通过superset init命令,初始化角色和权限,执行结果如下:

INFO:superset.security.manager:Syncing role definition
Syncing Admin perms
INFO:superset.security.manager:Syncing Admin perms
Syncing Alpha perms
INFO:superset.security.manager:Syncing Alpha perms
Syncing Gamma perms
INFO:superset.security.manager:Syncing Gamma perms
Syncing granter perms
INFO:superset.security.manager:Syncing granter perms
Syncing sql_lab perms
INFO:superset.security.manager:Syncing sql_lab perms
Fetching a set of all perms to lookup which ones are missing
INFO:superset.security.manager:Fetching a set of all perms to lookup which ones are missing
Creating missing datasource permissions.
INFO:superset.security.manager:Creating missing datasource permissions.
Creating missing database permissions.
INFO:superset.security.manager:Creating missing database permissions.
Creating missing metrics permissions
INFO:superset.security.manager:Creating missing metrics permissions
Cleaning faulty perms
INFO:superset.security.manager:Cleaning faulty perms

6. 载入示例数据

Superset提供了一些实例数据,可以通过superset load_examples载入,不过由于服务器在国外,可能会出现导入失败的情况,导入不了也没事,影响不大。

7. 启动服务

当上面内容完成后,我们就可以执行如下命令superset run -p 8000 --with-threads --reload --debugger来启动Supserset了,我们可以通过-p的参数来改变端口,如果不指定的话,默认端口为5000。

值得注意的是,官方默认启动命令有坑,它启动的时候给的host是127.0.0.1,如果是本地安装,没有问题,但是如果是在服务器上安装,当你用 外网加端口的方式访问的时候,就无法访问,此时可以使用如下命令:superset run -h 0.0.0.0 -p 8000 --with-threads --reload --debugger

如果想要让superset在后台运行,可以使用如下命令启动:nohup superset runserver -d -p 8088

8. Superset 简单汉化

  1. 我们首先进入superset的安装目录,比如我的是这个目录:/BigDataEnv/bigdataEnv/lib/python3.8/site-packages/superset
  2. 找到这个config.py文件,将BABEL_DEFAULT_LOCALE = "en"中的en改为zh
  3. 从GitHub上下载汉化文件messages.po,并将其覆盖该目录的同名文件:/BigDataEnv/bigdataEnv/lib/python3.8/site-packages/flask_appbuilder/translations/zh/LC_MESSAGES/messages.po
  4. 执行如下命令,重新编译pybabel compile -d translations
  5. 重启superset即可。

值得注意的是,这种方式的汉化,其实只是汉化了一小部分的内容,大部分的东西都没有汉化完整,不过英文看着也还好,暂时先不管。