diff --git a/build.sh b/build.sh deleted file mode 100644 index b07c6623..00000000 --- a/build.sh +++ /dev/null @@ -1,72 +0,0 @@ -#!/bin/bash -workspace=$(cd $(dirname $0) && pwd -P) -cd $workspace - -## constant -OUTPUT_DIR=./output -KM_VERSION=2.4.2 -APP_NAME=kafka-manager -APP_DIR=${APP_NAME}-${KM_VERSION} - -MYSQL_TABLE_SQL_FILE=./docs/install_guide/create_mysql_table.sql -CONFIG_FILE=./kafka-manager-web/src/main/resources/application.yml - -## function -function build() { - # 编译命令 - mvn -U clean package -Dmaven.test.skip=true - - local sc=$? - if [ $sc -ne 0 ];then - ## 编译失败, 退出码为 非0 - echo "$APP_NAME build error" - exit $sc - else - echo "$APP_NAME build ok" - fi -} - -function make_output() { - # 新建output目录 - rm -rf ${OUTPUT_DIR} &>/dev/null - mkdir -p ${OUTPUT_DIR}/${APP_DIR} &>/dev/null - - # 填充output目录, output内的内容 - ( - cp -rf ${MYSQL_TABLE_SQL_FILE} ${OUTPUT_DIR}/${APP_DIR} && # 拷贝 sql 初始化脚本 至output目录 - cp -rf ${CONFIG_FILE} ${OUTPUT_DIR}/${APP_DIR} && # 拷贝 application.yml 至output目录 - - # 拷贝程序包到output路径 - cp kafka-manager-web/target/kafka-manager-web-${KM_VERSION}-SNAPSHOT.jar ${OUTPUT_DIR}/${APP_DIR}/${APP_NAME}.jar - echo -e "make output ok." - ) || { echo -e "make output error"; exit 2; } # 填充output目录失败后, 退出码为 非0 -} - -function make_package() { - # 压缩output目录 - ( - cd ${OUTPUT_DIR} && tar cvzf ${APP_DIR}.tar.gz ${APP_DIR} - echo -e "make package ok." - ) || { echo -e "make package error"; exit 2; } # 压缩output目录失败后, 退出码为 非0 -} - -########################################## -## main -## 其中, -## 1.进行编译 -## 2.生成部署包output -## 3.生成tar.gz压缩包 -########################################## - -# 1.进行编译 -build - -# 2.生成部署包output -make_output - -# 3.生成tar.gz压缩包 -make_package - -# 编译成功 -echo -e "build done" -exit 0 \ No newline at end of file diff --git a/distribution/bin/shutdown.sh b/distribution/bin/shutdown.sh new file mode 100644 index 00000000..fdf2d01c --- /dev/null +++ b/distribution/bin/shutdown.sh @@ -0,0 +1,16 @@ +#!/bin/bash + +cd `dirname $0`/../target +target_dir=`pwd` + +pid=`ps ax | grep -i 'kafka-manager' | grep ${target_dir} | grep java | grep -v grep | awk '{print $1}'` +if [ -z "$pid" ] ; then + echo "No kafka-manager running." + exit -1; +fi + +echo "The kafka-manager (${pid}) is running..." + +kill ${pid} + +echo "Send shutdown request to kafka-manager (${pid}) OK" diff --git a/distribution/bin/startup.sh b/distribution/bin/startup.sh new file mode 100644 index 00000000..ead6cde9 --- /dev/null +++ b/distribution/bin/startup.sh @@ -0,0 +1,81 @@ +error_exit () +{ + echo "ERROR: $1 !!" + exit 1 +} + +[ ! -e "$JAVA_HOME/bin/java" ] && JAVA_HOME=$HOME/jdk/java +[ ! -e "$JAVA_HOME/bin/java" ] && JAVA_HOME=/usr/java +[ ! -e "$JAVA_HOME/bin/java" ] && unset JAVA_HOME + +if [ -z "$JAVA_HOME" ]; then + if $darwin; then + + if [ -x '/usr/libexec/java_home' ] ; then + export JAVA_HOME=`/usr/libexec/java_home` + + elif [ -d "/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home" ]; then + export JAVA_HOME="/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home" + fi + else + JAVA_PATH=`dirname $(readlink -f $(which javac))` + if [ "x$JAVA_PATH" != "x" ]; then + export JAVA_HOME=`dirname $JAVA_PATH 2>/dev/null` + fi + fi + if [ -z "$JAVA_HOME" ]; then + error_exit "Please set the JAVA_HOME variable in your environment, We need java(x64)! jdk8 or later is better!" + fi +fi + + + + +export WEB_SERVER="kafka-manager" +export JAVA_HOME +export JAVA="$JAVA_HOME/bin/java" +export BASE_DIR=`cd $(dirname $0)/..; pwd` +export CUSTOM_SEARCH_LOCATIONS=file:${BASE_DIR}/conf/ + + +#=========================================================================================== +# JVM Configuration +#=========================================================================================== + +JAVA_OPT="${JAVA_OPT} -server -Xms2g -Xmx2g -Xmn1g -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=320m" +JAVA_OPT="${JAVA_OPT} -XX:-OmitStackTraceInFastThrow -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=${BASE_DIR}/logs/java_heapdump.hprof" + +## jdk版本高的情况 有些 参数废弃了 +JAVA_MAJOR_VERSION=$($JAVA -version 2>&1 | sed -E -n 's/.* version "([0-9]*).*$/\1/p') +if [[ "$JAVA_MAJOR_VERSION" -ge "9" ]] ; then + JAVA_OPT="${JAVA_OPT} -Xlog:gc*:file=${BASE_DIR}/logs/km_gc.log:time,tags:filecount=10,filesize=102400" +else + JAVA_OPT="${JAVA_OPT} -Djava.ext.dirs=${JAVA_HOME}/jre/lib/ext:${JAVA_HOME}/lib/ext" + JAVA_OPT="${JAVA_OPT} -Xloggc:${BASE_DIR}/logs/km_gc.log -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+PrintGCTimeStamps -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=10 -XX:GCLogFileSize=100M" + +fi + +JAVA_OPT="${JAVA_OPT} -jar ${BASE_DIR}/target/${WEB_SERVER}.jar" +JAVA_OPT="${JAVA_OPT} --spring.config.additional-location=${CUSTOM_SEARCH_LOCATIONS}" +JAVA_OPT="${JAVA_OPT} --logging.config=${BASE_DIR}/conf/logback-spring.xml" +JAVA_OPT="${JAVA_OPT} --server.max-http-header-size=524288" + + + +if [ ! -d "${BASE_DIR}/logs" ]; then + mkdir ${BASE_DIR}/logs +fi + +echo "$JAVA ${JAVA_OPT}" + +# check the start.out log output file +if [ ! -f "${BASE_DIR}/logs/start.out" ]; then + touch "${BASE_DIR}/logs/start.out" +fi +# start +echo -e "---- 启动脚本 ------\n $JAVA ${JAVA_OPT}" > ${BASE_DIR}/logs/start.out 2>&1 & + + +nohup $JAVA ${JAVA_OPT} >> ${BASE_DIR}/logs/start.out 2>&1 & + +echo "${WEB_SERVER} is starting，you can check the ${BASE_DIR}/logs/start.out" diff --git a/distribution/conf/application.yml.example b/distribution/conf/application.yml.example new file mode 100644 index 00000000..12241f5c --- /dev/null +++ b/distribution/conf/application.yml.example @@ -0,0 +1,98 @@ +server: + port: 8080 + tomcat: + accept-count: 1000 + max-connections: 10000 + max-threads: 800 + min-spare-threads: 100 + +spring: + application: + name: kafkamanager + datasource: + kafka-manager: + jdbc-url: jdbc:mysql://localhost:3306/logi_kafka_manager?characterEncoding=UTF-8&useSSL=false&serverTimezone=GMT%2B8 + username: root + password: 123456 + driver-class-name: com.mysql.cj.jdbc.Driver + main: + allow-bean-definition-overriding: true + + profiles: + active: dev + servlet: + multipart: + max-file-size: 100MB + max-request-size: 100MB + +logging: + config: classpath:logback-spring.xml + +custom: + idc: cn + jmx: + max-conn: 10 # 2.3版本配置不在这个地方生效 + store-metrics-task: + community: + broker-metrics-enabled: true + topic-metrics-enabled: true + didi: + app-topic-metrics-enabled: false + topic-request-time-metrics-enabled: false + topic-throttled-metrics: false + save-days: 7 + +# 任务相关的开关 +task: + op: + sync-topic-enabled: false # 未落盘的Topic定期同步到DB中 + order-auto-exec: # 工单自动化审批线程的开关 + topic-enabled: false # Topic工单自动化审批开关, false:关闭自动化审批, true:开启 + app-enabled: false # App工单自动化审批开关, false:关闭自动化审批, true:开启 + +account: + ldap: + enabled: false + url: ldap://127.0.0.1:389/ + basedn: dc=tsign,dc=cn + factory: com.sun.jndi.ldap.LdapCtxFactory + filter: sAMAccountName + security: + authentication: simple + principal: cn=admin,dc=tsign,dc=cn + credentials: admin + auth-user-registration: true + auth-user-registration-role: normal + +kcm: + enabled: false + s3: + endpoint: s3.didiyunapi.com + access-key: 1234567890 + secret-key: 0987654321 + bucket: logi-kafka + n9e: + base-url: http://127.0.0.1:8004 + user-token: 12345678 + timeout: 300 + account: root + script-file: kcm_script.sh + +monitor: + enabled: false + n9e: + nid: 2 + user-token: 1234567890 + mon: + base-url: http://127.0.0.1:8032 + sink: + base-url: http://127.0.0.1:8006 + rdb: + base-url: http://127.0.0.1:80 + +notify: + kafka: + cluster-id: 95 + topic-name: didi-kafka-notify + order: + detail-url: http://127.0.0.1 diff --git a/docs/install_guide/create_mysql_table.sql b/distribution/conf/create_mysql_table.sql similarity index 100% rename from docs/install_guide/create_mysql_table.sql rename to distribution/conf/create_mysql_table.sql diff --git a/distribution/conf/logback-spring.xml b/distribution/conf/logback-spring.xml new file mode 100644 index 00000000..c1c16136 --- /dev/null +++ b/distribution/conf/logback-spring.xml @@ -0,0 +1,215 @@ + + + logback + + + + + + + + + + + + + + info + + + ${CONSOLE_LOG_PATTERN} + UTF-8 + + + + + + + + + ${log.path}/log_debug.log + + + %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n + UTF-8 + + + + + ${log.path}/log_debug_%d{yyyy-MM-dd}.%i.log + + 100MB + + + 7 + + + + debug + ACCEPT + DENY + + + + + + + ${log.path}/log_info.log + + + %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n + UTF-8 + + + + + ${log.path}/log_info_%d{yyyy-MM-dd}.%i.log + + 100MB + + + 7 + + + + info + ACCEPT + DENY + + + + + + + ${log.path}/log_warn.log + + + %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n + UTF-8 + + + + ${log.path}/log_warn_%d{yyyy-MM-dd}.%i.log + + 100MB + + + 7 + + + + warn + ACCEPT + DENY + + + + + + + + ${log.path}/log_error.log + + + %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n + UTF-8 + + + + ${log.path}/log_error_%d{yyyy-MM-dd}.%i.log + + 100MB + + + 7 + + + + ERROR + ACCEPT + DENY + + + + + + ${log.path}/metrics/collector_metrics.log + + %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n + UTF-8 + + + ${log.path}/metrics/collector_metrics_%d{yyyy-MM-dd}.%i.log + + 100MB + + 3 + + + + + + ${log.path}/metrics/api_metrics.log + + %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n + UTF-8 + + + ${log.path}/metrics/api_metrics_%d{yyyy-MM-dd}.%i.log + + 100MB + + 3 + + + + + + ${log.path}/metrics/scheduled_tasks.log + + %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n + UTF-8 + + + ${log.path}/metrics/scheduled_tasks_%d{yyyy-MM-dd}.%i.log + + 100MB + + 5 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/distribution/pom.xml b/distribution/pom.xml new file mode 100644 index 00000000..6b61525c --- /dev/null +++ b/distribution/pom.xml @@ -0,0 +1,64 @@ + + + + + + kafka-manager + com.xiaojukeji.kafka + ${kafka-manager.revision} + + + 4.0.0 + + distribution + distribution + pom + + + + ${project.groupId} + kafka-manager-web + ${kafka-manager.revision} + + + + + + + release-kafka-manager + + + ${project.groupId} + kafka-manager-web + ${kafka-manager.revision} + + + + + + org.apache.maven.plugins + maven-assembly-plugin + + + release-km.xml + + posix + + + + make-assembly + install + + single + + + + + + kafka-manager + + + + diff --git a/distribution/readme.md b/distribution/readme.md new file mode 100644 index 00000000..9d40efa4 --- /dev/null +++ b/distribution/readme.md @@ -0,0 +1,22 @@ +## 说明 + +### 1.创建mysql数据库文件 +> conf/create_mysql_table.sql + +### 2. 修改配置文件 +> conf/application.yml.example +> 请将application.yml.example 复制一份改名为application.yml； +> 并放在同级目录下(conf/); 并修改成自己的配置 +> 这里的优先级比jar包内配置文件的默认值高; +> + +### 3.启动/关闭kafka-manager +> sh bin/startup.sh 启动 +> +> sh shutdown.sh 关闭 +> + + +### 4.升级jar包 +> 如果是升级, 可以看看文件 `upgrade_config.md` 的配置变更历史; +> \ No newline at end of file diff --git a/distribution/release-km.xml b/distribution/release-km.xml new file mode 100755 index 00000000..d1b0db1c --- /dev/null +++ b/distribution/release-km.xml @@ -0,0 +1,51 @@ + + + + ${project.version} + true + + dir + tar.gz + zip + + + + + conf/** + + + + + + bin/* + + 0755 + + + + + + + readme.md + readme.md + + + upgrade_config.md + upgrade_config.md + + + + ../kafka-manager-web/target/kafka-manager.jar + target/ + + + + + + true + + com.xiaojukeji.kafka:kafka-manager-web + + + + diff --git a/distribution/upgrade_config.md b/distribution/upgrade_config.md new file mode 100644 index 00000000..65314cfb --- /dev/null +++ b/distribution/upgrade_config.md @@ -0,0 +1,43 @@ + +## 版本升级配置变更 +> 本文件 从 V2.2.0 开始记录; 如果配置有变更则会填写到下文中; 如果没有,则表示无变更; +> 当您从一个很低的版本升级时候,应该依次执行中间有过变更的sql脚本 + + +![kafka-manager-logo](../../assets/images/common/logo_name.png) + +**一站式`Apache Kafka`集群指标监控与运维管控平台** + +--- + +### 1.升级至`V2.2.0`版本 + +#### 1.mysql变更 + +`2.2.0`版本在`cluster`表及`logical_cluster`各增加了一个字段，因此需要执行下面的sql进行字段的增加。 + +```sql +# 往cluster表中增加jmx_properties字段, 这个字段会用于存储jmx相关的认证以及配置信息 +ALTER TABLE `cluster` ADD COLUMN `jmx_properties` TEXT NULL COMMENT 'JMX配置' AFTER `security_properties`; + +# 往logical_cluster中增加identification字段, 同时数据和原先name数据相同, 最后增加一个唯一键. +# 此后, name字段还是表示集群名称, 而identification字段表示的是集群标识, 只能是字母数字及下划线组成, +# 数据上报到监控系统时, 集群这个标识采用的字段就是identification字段, 之前使用的是name字段. +ALTER TABLE `logical_cluster` ADD COLUMN `identification` VARCHAR(192) NOT NULL DEFAULT '' COMMENT '逻辑集群标识' AFTER `name`; + +UPDATE `logical_cluster` SET `identification`=`name` WHERE id>=0; + +ALTER TABLE `logical_cluster` ADD INDEX `uniq_identification` (`identification` ASC); +``` + +### 升级至`2.3.0`版本 + +#### 1.mysql变更 +`2.3.0`版本在`gateway_config`表增加了一个描述说明的字段，因此需要执行下面的sql进行字段的增加。 + +```sql +ALTER TABLE `gateway_config` +ADD COLUMN `description` TEXT NULL COMMENT '描述信息' AFTER `version`; +``` + + diff --git a/docs/install_guide/install_guide_cn.md b/docs/install_guide/install_guide_cn.md index 9a4a415b..0130bd55 100644 --- a/docs/install_guide/install_guide_cn.md +++ b/docs/install_guide/install_guide_cn.md @@ -31,17 +31,23 @@ **2、源代码进行打包** -下载好代码之后，进入`Logi-KafkaManager`的主目录，执行`sh build.sh`命令即可，执行完成之后会在`output/kafka-manager-xxx`目录下面生成一个jar包。 +下载好代码之后，进入`Logi-KafkaManager`的主目录，执行`mvn -Prelease-kafka-manager -Dmaven.test.skip=true clean install -U `命令即可， +执行完成之后会在`distribution/target`目录下面生成一个`kafka-manager-*.tar.gz`。 +和一个`kafka-manager-*.zip` 文件,随便任意一个压缩包都可以; +当然此时同级目录有一个已经解压好的文件夹; -对于`windows`环境的用户，估计执行不了`sh build.sh`命令，因此可以直接执行`mvn install`，然后在`kafka-manager-web/target`目录下生成一个kafka-manager-web-xxx.jar的包。 -获取到jar包之后，我们继续下面的步骤。 --- -## 3、MySQL-DB初始化 +## 3. 解压安装包 +解压完成后; 在文件目录中可以看到有`kafka-manager/conf/create_mysql_table.sql` 有个mysql初始化文件 +先初始化DB -执行[create_mysql_table.sql](create_mysql_table.sql)中的SQL命令，从而创建所需的MySQL库及表，默认创建的库名是`logi_kafka_manager`。 + +## 4、MySQL-DB初始化 + +执行[create_mysql_table.sql](../../distribution/conf/create_mysql_table.sql)中的SQL命令，从而创建所需的MySQL库及表，默认创建的库名是`logi_kafka_manager`。 ``` # 示例： @@ -50,15 +56,38 @@ mysql -uXXXX -pXXX -h XXX.XXX.XXX.XXX -PXXXX < ./create_mysql_table.sql --- -## 4、启动 +## 5.修该配置 +请将`conf/application.yml.example` 文件复制一份出来命名为`application.yml` 放在同级目录:conf/application.yml ; +并且修改配置; 当然不修改的话 就会用默认的配置; +至少 mysql配置成自己的吧 -``` -# application.yml 是配置文件，最简单的是仅修改MySQL相关的配置即可启动 -nohup java -jar kafka-manager.jar --spring.config.location=./application.yml > /dev/null 2>&1 & -``` +## 6、启动/关闭 +解压包中有启动和关闭脚本 +`kafka-manager/bin/shutdown.sh` +`kafka-manager/bin/startup.sh` -### 5、使用 +执行 sh startup.sh 启动 +执行 sh shutdown.sh 关闭 + + + +### 6、使用 本地启动的话，访问`http://localhost:8080`，输入帐号及密码(默认`admin/admin`)进行登录。更多参考：[kafka-manager 用户使用手册](../user_guide/user_guide_cn.md) +### 7. 升级 + +如果是升级版本,请查看文件 [kafka-manager 升级手册](../../distribution/upgrade_config.md) + 在您下载的启动包(V2.5及其后)中也有记录,在 kafka-manager/upgrade_config.md 中 + + +### 8. 在IDE中启动 +> 如果想参与开发或者想在IDE中启动的话 +> 先执行 `mvn -Dmaven.test.skip=true clean install -U ` +> +> 然后这个时候可以选择去 [pom.xml](../../pom.xml) 中将`kafka-manager-console`模块注释掉; +> 注释是因为每次install的时候都会把前端文件`kafka-manager-console`重新打包进`kafka-manager-web` +> +> 完事之后,只需要直接用IDE启动运行`kafka-manager-web`模块中的 +> com.xiaojukeji.kafka.manager.web.MainApplication main方法就行了 \ No newline at end of file diff --git a/kafka-manager-console/package.json b/kafka-manager-console/package.json index 3be33c21..15e2b523 100644 --- a/kafka-manager-console/package.json +++ b/kafka-manager-console/package.json @@ -57,4 +57,4 @@ "dependencies": { "format-to-json": "^1.0.4" } -} \ No newline at end of file +} diff --git a/kafka-manager-web/pom.xml b/kafka-manager-web/pom.xml index 17504ca7..b3fd5b91 100644 --- a/kafka-manager-web/pom.xml +++ b/kafka-manager-web/pom.xml @@ -109,8 +109,10 @@ + kafka-manager + org.springframework.boot spring-boot-maven-plugin ${springframework.boot.version} @@ -121,6 +123,7 @@ + diff --git a/pom.xml b/pom.xml index 51fa20e0..7e9335c2 100644 --- a/pom.xml +++ b/pom.xml @@ -27,10 +27,14 @@ UTF-8 UTF-8 8.5.66 + 3.0.0 + + kafka-manager-common kafka-manager-dao kafka-manager-core @@ -42,6 +46,7 @@ kafka-manager-extends/kafka-manager-openapi kafka-manager-task kafka-manager-web + distribution @@ -231,4 +236,16 @@ + + + + + + + org.apache.maven.plugins + maven-assembly-plugin + ${maven-assembly-plugin.version} + + + \ No newline at end of file