Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 4.38 KB

启动器使用说明.md

File metadata and controls

58 lines (39 loc) · 4.38 KB

launcher使用说明

查看帮助

使用 -h 或者 --help 参数可以查看启动器以及每个命令的使用说明和用法

  • launcher.sh -h
  • launcher.sh [start/stop/restart/status]-h

关于应用启动参数配置

应用启动参数有3种指定方式

通过参数指定

短参数 长参数 通过系统变量、环境变量(见表格下方备注) 说明 示例
-a --args 设置应用参数 -a server.port=80
-d --daemon LAUNCHER_START_IN_DAEMON 使用后台模式执行 -d
-e --app-environment LAUNCHER_APP_ENV 设置应用所处环境(prod/pre/stress/live/dev) -e dev
-r --app-region LAUNCHER_APP_REGION 设置应用所属的区域,例如IDC_CODE) -r beijing
-i --app-instance-id LAUNCHER_INSTANCE_ID 手动指定本实例ID
-jo --java-opts 设置jvm参数,允许设置多次(追加) -jo '-Xmx4g -Xms4g'
-ld --log-dir LAUNCHER_APP_LOG_DIR 设置日志目录,默认为./logs/$APP_NAME/$APP_INSTANCE_ID --ld /home/www/logs
-ldt --log-dir-type LAUNCHER_APP_LOG_DIR_TYPE 日志目录类型(见表格下方备注),base/app/instance
-mc --main-class 设置应用启动类 -mc org.gy.framework.sample.main
LAUNCHER_APP_ID 设置应用的ID
-n --app-name LAUNCHER_APP_NAME 设置应用名称 -n launcher-sample
--restart LAUNCHER_AUTORESTART 如果发现应用已经启动,则使用上次的参数自动重启
--dry-run 仅打印启动日志,不启动服务(调试用)
-h --help 打印参数说明

关于系统变量、环境变量的设置模式 : 该模式针对发布系统对接,不建议用户手动设置;环境变量设置模式只针对容器环境生效;

关于日志目录类型 : 启动器统一了日志目录层级规范,在目录层级中必须包含应用名/实例ID,所以当使用-ld设置了日志目录后需要使用 -ldt 指定日志目录的层级,默认为 base

  • base :指定日志目录类型为基础目录,启动器会在设置的日志目录中创建应用名/实例ID子目录;

  • -ldt app :指定日志目录类型为应用目录,启动器会在设置的日志目录中创建实例ID子目录;

  • -ldt instance :指定日志目录类型为实例目录,启动器不会创建子目录;

应用停止

参数请查看launcher.sh stop -h

应用重启

参数请查看launcher.sh restart -h

应用状态检查

参数请查看launcher.sh status -h

启动参数示例

./launcher.sh start -d -n my-service-name -jo '-Dfile.encoding=UTF-8 -Duser.timezone=Asia/Shanghai  -XX:InitialRAMPercentage=50.0 -XX:MaxRAMPercentage=75.0 -XX:+UseG1GC  -XX:MaxGCPauseMillis=150' -a '--server.port=8081'