附录

1. 配置参数说明

WeBASE-Codegen-Monkey用于生成WeBASE-Collect-Bee组件实例,在WeBASE-Codegen-Monkey组件中配置文件只有一个:application.properties。该配置文件覆盖了数据导出组件所需的所有配置,并提供了详细的说明和样例,开发者可根据需求进行灵活配置。

1.1 Springboot服务配置

配置项是否必输说明举例默认值
server.portN启动WeBASE-Collect-Bee组件实例的服务端口80828080

1.2 FISCO-BCOS节点配置

FISCO-BCOS节点配置用于配置WeBASE-Collect-Bee服务连接的区块链节点,使得WeBASE-Collect-Bee服务能够访问连接节点,并通过该节点获取区块链网络上的数据。

配置项是否必输说明举例默认值
system.orgIdN组织机构ID,用于区分不同的机构10000FB001
system.nodeStrY连接区块链节点的nodeStr,nodeName@[IP]:[PORT], 其中prot为channel portnode1@106.12.31.123:8822-

1.3 数据库配置

数据导出组件最终会把区块链网络上的数据导出到数据存储介质中,目前版本仅支持MySQL,所以需要进行数据库配置。

配置项是否必输说明举例默认值
system.dbUrlY访问数据的URLjdbc:mysql://[IP]:[PORT]/[DB]?useSSL=false&serverTimezone=GMT%2b8&useUnicode=true&characterEncoding=UTF-8-
system.dbUserY数据库用户名admin-
system.dbPasswordY数据库密码123456-
system.contractName.[methodName or eventName].shardingNON合约数据分片数:数据库指定数据表的个数system.Rule.NewruleEvent.shardingNO = 31
system.sys.[sysTableName].shardingNON系统数据分片数system.sys.BlockTxDetailInfo.shardingNO=51
system.nameStyleN数据库表名和字段命名规则,支持下划线命名和原始数据命名system.nameStyle=rawCaseunderScoreCase
system.namePrefixN数据库表字段命名前缀,默认为空system.namePrefix=
system.namePostfixN数据库表字段命名后缀,默认为空system.namePostfix=

其中sysTableName对应区块数据表和账户数据表,详情见 数据存储模型 章节。

1.4 FISCO-WeBASE-Collect-Bee工程配置

配置项是否必输说明举例默认值
system.groupY同spring项目的groupcom.example-
system.contractPackNameY编译智能合约所输入的包名com.webank.blockchain.wecredit.contracts-
monitor.default.frequencyN所有method和event的抓取频率,默认几秒轮询一次105

1.5 线程池配置

在单机部署下,必须配置线程池参数。数据导出配置用于配置数据导出的频率、线程数及启动多线程条件等。当system.multiLiving=true时,配置文件不会生成线程池相关配置。

配置项是否必输说明举例默认值
system.multiLivingY关闭多活开关falsefalse
system.crawlBatchUnitN线程处理单元:多线程任务模式下单个线程一次任务执行完成的区块数100100

1.6 集群多活配置

在集群多活部署的方案中,必须设置集群多活的配置。集群必须通过zookeeper进行服务注册和任务分发。当system.multiLiving=false时,配置文件不会生成zookeeper相关配置。

配置项是否必输说明举例默认值
system.multiLivingY启动多活开关truefalse
regcenter.serverListN注册中心服务器列表[12.00.10.1:2181;12.00.10.2:2181]-
regcenter.namespaceN注册中心命名空间wecredit_bee-

1.7 其他高级配置

配置项是否必输说明举例默认值
monitor.[contractName].[methodName/eventName].generated=falseN是否抓取特定合约中特定method或event的数据on/offon
monitor.[contractName].[eventName].ignoreParam=XXX,XXXN忽略特定合约特定event的特定字段不进行抓取xxx,xxx
length.[contractName].[methodName or eventName].paraNameN指定特定字段在数据库表中的长度512

2. Java安装

Ubuntu环境安装Java

  1. # 安装默认Java版本(Java 8或以上)
  2. sudo apt install -y default-jdk
  3. # 查询Java版本
  4. java -version

CentOS环境安装Java

  1. # 查询centos原有的Java版本
  2. $ rpm -qa|grep java
  3. # 删除查询到的Java版本
  4. $ rpm -e --nodeps java版本
  5. # 查询Java版本,没有出现版本号则删除完毕
  6. $ java -version
  7. # 创建新的文件夹,安装Java 8或以上的版本,将下载的jdk放在software目录
  8. # 从openJDK官网(https://jdk.java.net/java-se-ri/8)或Oracle官网(https://www.oracle.com/technetwork/java/javase/downloads/index.html)选择Java 8或以上的版本下载,例如下载jdk-8u201-linux-x64.tar.gz
  9. $ mkdir /software
  10. # 解压jdk
  11. $ tar -zxvf jdk-8u201-linux-x64.tar.gz
  12. # 配置Java环境,编辑/etc/profile文件
  13. $ vim /etc/profile
  14. # 打开以后将下面三句输入到文件里面并退出
  15. export JAVA_HOME=/software/jdk-8u201-linux-x64.tar.gz
  16. export PATH=$JAVA_HOME/bin:$PATH
  17. export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar
  18. # 生效profile
  19. $ source /etc/profile
  20. # 查询Java版本,出现的版本是自己下载的版本,则安装成功。
  21. java -version

3. Git安装

git:用于拉取最新代码

centos:

  1. sudo yum -y install git

ubuntu:

  1. sudo apt install git

4. Mysql安装

此处以Centos/Fedora为例。

(1)切换到root

  1. sudo -s

(2)安装mysql

  1. yum install mysql*
  2. #某些版本的linux,需要安装mariadb,mariadb是mysql的一个分支
  3. yum install mariadb*

(3)启动mysql

  1. service mysqld start
  2. #若安装了mariadb,则使用下面的命令启动
  3. service mariadb start

(4)初始化root用户

  1. mysql -u root

注意,以下语句仅适用于开发环境,不能直接在实际生产中使用!!! 以下操作仅供参考,请勿直接拷贝,请自定义设置复杂密码。

  1. /*授权test用户本地访问数据库*/
  2. create user 'test'@'localhost' identified by 'test1234';

(5)用SQL语句给root分配密码

  1. GRANT ALL PRIVILEGES ON *.* TO 'test'@'%' IDENTIFIED BY 'test1234' WITH GRANT OPTION;

注意,以上语句仅适用于开发环境,不能直接在实际生产中使用!!!以上设置会使数据库在所有网络上都可以访问,请按具体的网络拓扑和权限控制情况,设置网络和权限帐号

(6)测试是否成功

另开一个ssh测试用户是否可以登陆,并成功授权,登陆数据库
  1. mysql -utest -ptest@2107 -h 127.0.0.1 -P 3306
登陆成功后,执行sql语句,若出现错误,则用户授权不成功
  1. show databases;
  2. use test;
  3. select * from tb_txnByDay;

5. zookeeper 安装

zookeeper 支持单机和集群部署,推荐使用集群部署的方式,请参考zookeeper官网的说明:

集群部署

单机部署

6. supervisor安装与部署

安装脚本

sudo yum -y install supervisor

会生成默认配置/etc/supervisord.conf和目录/etc/supervisord.d,如果没有则自行创建。

配置脚本

cd /etc/supervisord.d修改/etc/supervisord.conf的[include]部分:

  1. [include]
  2. files = supervisord.d/*.ini
  3. [supervisord]

在/etc/supervisord.d目录下配置以下启动配置文件webasebee_config1.ini(请注意配置文件里需要包含webasebee,否则会导致关闭任务命令失效),注意修改相关的路径。

  1. [program:supervisor_webasebee]
  2. directory =【你的程序路径】/WeBASE-Collect-Bee/dist ; 程序的启动目录
  3. command = nohup java -jar 【你的安装包名,如WeBASE-Collect-Bee0.3.0-SNAPSHOT.jar & ; 启动命令,与命令行启动的命令是一样的
  4. autostart = true ; supervisord 启动的时候也自动启动
  5. startsecs = 15 ; 启动 15 秒后没有异常退出,就当作已经正常启动了
  6. autorestart = true ; 程序异常退出后自动重启
  7. startretries = 3 ; 启动失败自动重试次数,默认是 3
  8. user = app ; 用哪个用户启动
  9. redirect_stderr = true ; stderr 重定向到 stdout,默认 false
  10. stdout_logfile_maxbytes = 150MB ; stdout 日志文件大小,默认 50MB
  11. stdout_logfile_backups = 20 ; stdout 日志文件备份数
  12. stderr_logfile=【你的日志路径】/WeBASE-Collect-Bee/dist/log/webase_bee_error.log
  13. stdout_logfile = 【你的日志路径】/WeBASE-Collect-Bee/dist/log/webase_bee_out.log ;日志统一放在log目录下
  14. [supervisord]

启动任务

supervisor支持supervisorctl和supervisord启动,可通过systemctl实现开机自启动。我们建议采用supervisord的方式启动:

  1. supervisord -c /etc/supervisord.d/webasebee_config1.ini

关闭任务

  1. ps -ef|grep supervisord|grep webasebee| awk '{print $2}'|xargs kill -9
  2. ps -ef|grep WeBASE-Collect-Bee|grep -v grep| awk '{print $2}'|xargs kill -9