在线安装

仅需两步快速安装 MeterSphere

  1. 准备一台不小于 8 G 内存且可以访问互联网的 64 位 Linux 主机；
  2. 以 root 用户执行如下命令一键安装 MeterSphere。
  1. curl -sSL https://github.com/metersphere/metersphere/releases/latest/download/quick_start.sh | sh

安装配置文件说明, 如果无特殊需求可以不进行修改采用默认参数安装

  1. # 基础配置
  2. ## 安装路径, MeterSphere 配置及数据文件默认将安装在 ${MS_BASE}/metersphere 目录下
  3. MS_BASE=/opt
  4. ## MeterSphere 使用的 docker 网络网段信息
  5. MS_DOCKER_SUBNET=172.30.10.0/24
  6. ## 镜像前缀, MeterSphere 相关组件使用的 Docker 镜像前缀, 例如 registry.cn-qingdao.aliyuncs.com/metersphere/
  7. MS_IMAGE_PREFIX='registry.cn-qingdao.aliyuncs.com/metersphere/'
  8. ## 镜像标签, MeterSphere 相关组件使用的 Docker 镜像标签
  9. MS_IMAGE_TAG=dev
  10. ## 性能测试使用的 JMeter 镜像
  11. MS_JMETER_IMAGE=${MS_IMAGE_PREFIX}/jmeter-master:5.4.1-ms3-jdk8
  12. ## 安装模式
  13. MS_INSTALL_MODE=allinone
  14. ## MeterSphere 主程序的 HTTP 服务监听端口
  15. MS_SERVER_PORT=8081
  16. ## MeterSphere Node-Controller 组件的 HTTP 服务监听端口
  17. MS_NODE_CONTROLLER_PORT=8082
  18. MS_NODEEXPORTER_PORT=9100
  20. # 数据库配置
  21. ## 是否使用外部数据库
  22. MS_EXTERNAL_MYSQL=false
  23. ## 数据库地址
  24. MS_MYSQL_HOST=mysql
  25. ## 数据库端口
  26. MS_MYSQL_PORT=3306
  27. ## 数据库库名
  28. MS_MYSQL_DB=metersphere
  29. ## 数据库用户名
  30. MS_MYSQL_USER=root
  31. ## 数据库密码
  32. MS_MYSQL_PASSWORD=Password123@mysql
  34. # Prometheus 配置
  35. ## 是否使用外部Prometheus
  36. MS_EXTERNAL_PROM=false
  37. MS_PROMETHEUS_PORT=9090
  39. # Kafka 配置
  40. ## 是否使用外部 Kafka
  41. MS_EXTERNAL_KAFKA=false
  42. ## Kafka 地址
  43. MS_KAFKA_EXT_HOST=$(hostname -I|cut -d" " -f 1)
  44. MS_KAFKA_HOST=kafka
  45. ## Kafka 端口
  46. MS_KAFKA_EXT_PORT=19092
  47. MS_KAFKA_PORT=9092
  48. ## 性能测试结果数据使用的 Kafka Topic
  49. MS_KAFKA_TOPIC=JMETER_METRICS
  50. ## 性能测试日志数据使用的 Kafka Topic
  51. MS_KAFKA_LOG_TOPIC=JMETER_LOGS
  52. ## 性能测试定时任务通知使用的 Kafka Topic
  53. MS_KAFKA_TEST_TOPIC=LOAD_TESTS
  54. ## 重构后性能测试结果数据使用的 Kafka Topic
  55. MS_KAFKA_REPORT_TOPIC=JMETER_REPORTS
  57. # TCP MOCK 端口范围
  58. MS_TCP_MOCK_PORT=10000-10010

注意

如果使用外部数据库进行安装，推荐使用 MySQL 5.7 版本。同时 MeterSphere 对数据库部分配置项有要求，请参考下附的数据库配置，修改环境中的数据库配置文件

  1. [mysqld]
  2. default-storage-engine=INNODB
  3. lower_case_table_names=1
  4. table_open_cache=128
  5. max_connections=2000
  6. max_connect_errors=6000
  7. innodb_file_per_table=1
  8. innodb_buffer_pool_size=1G
  9. max_allowed_packet=64M
  10. transaction_isolation=READ-COMMITTED
  11. innodb_flush_method=O_DIRECT
  12. innodb_lock_wait_timeout=1800
  13. innodb_flush_log_at_trx_commit=0
  14. sync_binlog=0
  15. sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION
  16. skip-name-resolve

请参考文档中的建库语句创建 MeterSphere 使用的数据库，metersphere-server 服务启动时会自动在配置的库中创建所需的表结构及初始化数据。

  1. CREATE DATABASE `metersphere` /*!40100 DEFAULT CHARACTER SET utf8mb4 */

安装脚本默认使用 /opt/metersphere 目录作为安装目录，MeterSphere 的配置文件、数据及日志等均存放在该安装目录

安装目录目录结构说明

  1. /opt/metersphere/
  2. ├── bin                                         #-- 安装过程中需要加载到容器中的脚本
  3. ├── compose_files                               #-- 根据不同的安装模式，保存需要使用到的 compose 文件信息
  4. ├── conf                                        #-- MeterSphere 各组件及数据库等中间件的配置文件
  5. ├── data                                        #-- MeterSphere 各组件及数据库等中间件的数据持久化目录
  6. ├── docker-compose-base.yml                     #-- MeterSphere 基础 Docker Compose 文件，定义了网络等基础信息 
  7. ├── docker-compose-kafka.yml                    #-- MeterSphere 自带的 Kafka 所需的 Docker Compose 文件
  8. ├── docker-compose-mysql.yml                    #-- MeterSphere 自带的 MySQL 所需的 Docker Compose 文件
  9. ├── docker-compose-node-controller.yml          #-- MeterSphere Node-Controller 组件所需的 Docker 文件
  10. ├── docker-compose-server.yml                   #-- MeterSphere Server 及 Data-Streaming 所需的 Docker Compose 文件
  11. ├── logs                                        #-- MeterSphere 各组件的日志文件持久化目录
  12. └── version                                     #-- 安装包对应的 MeterSphere 版本信息

执行安装脚本

  1. # 进入安装包目录
  2. cd metersphere-release-v1.0.3
  3. # 运行安装脚本
  4. /bin/bash install.sh
  5. # 等待安装脚本执行完成后，查看 MeterSphere 状态
  6. msctl status

安装成功后，通过浏览器访问如下页面登录 MeterSphere

  1. 地址: http://目标服务器IP地址:8081
  2. 用户名: admin
  3. 密码: metersphere

注意

如果需要使用 Nginx、Haproxy 等反向代理，需要配置反向代理对 websocket 的支持。以 Nginx 为例，参考的配置内容如下。

  1. server {
  2.     listen 80;
  3.     server_name demo.metersphere.com;
  4.     server_tokens off;
  5.     return 301 https://$host$request_uri;
  6. }
  7. server {
  8.     listen 443 ssl;
  9.     # RSA certificate
  10.     ssl_certificate /etc/nginx/ssl/metersphere.com/fullchain.cer; # managed by Certbot
  11.     ssl_certificate_key /etc/nginx/ssl/metersphere.com/metersphere.com.key; # managed by Certbot
  12.     server_name  demo.metersphere.com;
  13.     proxy_connect_timeout       300;
  14.     proxy_send_timeout          300;
  15.     proxy_read_timeout          300;
  16.     send_timeout                300;
  17.     proxy_set_header Host $host;
  18.     proxy_set_header X-Forwarded-For $remote_addr;
  19.     proxy_set_header X-Forwarded-Host $server_name;
  20.     proxy_set_header X-Real-IP $remote_addr;
  21.     proxy_set_header X-Forwarded-Proto $scheme;
  22.     proxy_redirect http:// $scheme://;
  23.     # 配置 websocket 支持
  24.     proxy_http_version 1.1;
  25.     proxy_set_header Upgrade $http_upgrade;
  26.     proxy_set_header Connection "upgrade";
  29.     location / {
  30.         proxy_pass http://ip:8081;
  31.         client_max_body_size 1000m;
  32.         #access_log off;
  33.     }
  34. }