From a72531a5508323924fa981dc8a10ad562e6c9ae6 Mon Sep 17 00:00:00 2001 From: 3y Date: Thu, 27 Jul 2023 22:17:12 +0800 Subject: [PATCH] =?UTF-8?q?=E8=B0=83=E6=95=B4=E6=96=87=E6=A1=A3=E4=BD=8D?= =?UTF-8?q?=E7=BD=AE&README=E5=9B=BE=E7=89=87=E4=BF=9D=E7=95=99=E5=9C=A8?= =?UTF-8?q?=E6=9C=AC=E5=9C=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 37 +++++++++--------- INSTALL.md => doc/INSTALL.md | 0 .../docker-quick-start/docker-compose.yml | 0 .../docker-quick-start/sql/apolloconfigdb.sql | 0 .../docker-quick-start/sql/apolloportaldb.sql | 0 .../docker}/flink/docker-compose.yml | 0 .../docker}/graylog/docker-compose.yml | 0 .../docker}/hive/docker-compose.yml | 0 .../docker}/kafka/docker-compose.yml | 0 .../docker}/mysql/docker-compose.yml | 0 .../docker}/nacos/cluster/docker-compose.yml | 0 .../docker}/nacos/single/docker-compose.yml | 0 {docker => doc/docker}/nacos/sql/config.sql | 0 .../docker}/prometheus/docker-compose.yaml | 0 .../docker}/prometheus/prometheus.yml | 0 ...cker-compose-rabbitmq-3.7.8-management.yml | 0 .../docker-compose-rabbitmq-cluster.yml | 0 .../rabbitmq/docker-compose-rabbitmq.yml | 0 .../rabbitmq/rabbitmq-cluster/.erlang.cookie | 0 .../rabbitmq-cluster/init-rabbitmq.sh | 0 ...rabbitmq_delayed_message_exchange-3.9.0.ez | Bin .../rabbitmq-1/config/rabbitmq.conf | 0 .../rabbitmq-2/config/rabbitmq.conf | 0 .../config/10-default-guest-user.conf | 0 .../rabbitmq/rabbitmq/config/rabbitmq.conf | 0 .../rabbitmq/config/rabbitmq_bak.conf | 0 .../rabbitmq/config/rabbitmq_bak.config | 0 ...rabbitmq_delayed_message_exchange-3.9.0.ez | Bin .../docker}/redis/docker-compose.yaml | 0 {docker => doc/docker}/redis/redis.conf | 0 .../rocketmq/docker-compose-rocketmq.yml | 0 .../rocketmq/rocketmq_broker/conf/broker.conf | 0 .../docker}/xxljob/tables_xxl_job.sql | 0 {sql => doc/sql}/austin.sql | 0 docker-compose.yml | 2 +- 35 files changed, 19 insertions(+), 20 deletions(-) rename INSTALL.md => doc/INSTALL.md (100%) rename {docker => doc/docker}/apollo/docker-quick-start/docker-compose.yml (100%) rename {docker => doc/docker}/apollo/docker-quick-start/sql/apolloconfigdb.sql (100%) rename {docker => doc/docker}/apollo/docker-quick-start/sql/apolloportaldb.sql (100%) rename {docker => doc/docker}/flink/docker-compose.yml (100%) rename {docker => doc/docker}/graylog/docker-compose.yml (100%) rename {docker => doc/docker}/hive/docker-compose.yml (100%) rename {docker => doc/docker}/kafka/docker-compose.yml (100%) rename {docker => doc/docker}/mysql/docker-compose.yml (100%) rename {docker => doc/docker}/nacos/cluster/docker-compose.yml (100%) rename {docker => doc/docker}/nacos/single/docker-compose.yml (100%) rename {docker => doc/docker}/nacos/sql/config.sql (100%) rename {docker => doc/docker}/prometheus/docker-compose.yaml (100%) rename {docker => doc/docker}/prometheus/prometheus.yml (100%) rename {docker => doc/docker}/rabbitmq/docker-compose-rabbitmq-3.7.8-management.yml (100%) rename {docker => doc/docker}/rabbitmq/docker-compose-rabbitmq-cluster.yml (100%) rename {docker => doc/docker}/rabbitmq/docker-compose-rabbitmq.yml (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq-cluster/.erlang.cookie (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq-cluster/init-rabbitmq.sh (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq-cluster/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq-cluster/rabbitmq-1/config/rabbitmq.conf (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq-cluster/rabbitmq-2/config/rabbitmq.conf (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq/config/10-default-guest-user.conf (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq/config/rabbitmq.conf (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq/config/rabbitmq_bak.conf (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq/config/rabbitmq_bak.config (100%) rename {docker => doc/docker}/rabbitmq/rabbitmq/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez (100%) rename {docker => doc/docker}/redis/docker-compose.yaml (100%) rename {docker => doc/docker}/redis/redis.conf (100%) rename {docker => doc/docker}/rocketmq/docker-compose-rocketmq.yml (100%) rename {docker => doc/docker}/rocketmq/rocketmq/rocketmq_broker/conf/broker.conf (100%) rename {docker => doc/docker}/xxljob/tables_xxl_job.sql (100%) rename {sql => doc/sql}/austin.sql (100%) diff --git a/README.md b/README.md index 1e752fc..9ef72de 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/1992e010510f4930923869be65fb8241~tplv-k3u1fbpfcp-zoom-1.image) - +![](doc/images/titile.jpeg)

作者 项目群交流 @@ -44,35 +43,35 @@ **意义**：只要公司内部有发送消息的需求，都应该要有类似`austin`的项目。消息推送平台对各类消息进行统一发送处理，这有利于对功能的收拢，以及提高业务需求开发的效率。 -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/c267ebb2ff234243b8665312dbb46310~tplv-k3u1fbpfcp-zoom-1.image) +![](doc/images/1.jpeg) ## 使用姿势 **1**、创建需要发送的渠道账号 -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/1720f1e9c6b546a18b13a84fabe1f562~tplv-k3u1fbpfcp-zoom-1.image) +![](doc/images/2.jpeg) **2**、创建消息模板 -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/b387c53663d04796a20fda2d4ba925ac~tplv-k3u1fbpfcp-zoom-1.image) +![](doc/images/3.jpeg) **3**、测试发送消息是否正常 -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/e58637c9a00a482f91d1a84ab7a17c51~tplv-k3u1fbpfcp-zoom-1.image) +![](doc/images/4.jpeg) **4**、查看消息下发情况 -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/c2dd1369fa8a4f40abcbb5c02ed21893~tplv-k3u1fbpfcp-zoom-1.image) +![](doc/images/5.jpeg) -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/2b49be4a87f44621b5b916114b17bd28~tplv-k3u1fbpfcp-zoom-1.image) +![](doc/images/6.jpeg) **5**、亦可在新建模板时选择**定时任务**，通过上传[csv文件](https://www.yuque.com/office/yuque/0/2022/csv/1285871/1671865125068-b5385387-b4a4-41ac-a43e-bab54ee49d88.csv?from=https%3A%2F%2Fwww.yuque.com%2Fu1047901%2Fniffsu%2Fqqtese%2Fedit)和指定cron表达式实现下发消息 -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/42ecf9c743bd4e3493e092d525cbffe7~tplv-k3u1fbpfcp-zoom-1.image) +![](doc/images/7.jpeg) ## 部署姿势 -austin项目**强依赖**`MySQL`/`Redis`/(**大概需要2G内存**)，**弱依赖**`kafka`/`prometheus`/`graylog`/`flink`/`xxl-job`/`apollo`/`hive`(**完全部署所有的服务，大概16G内存**)。如果缺少相关的组件可戳：[安装相关组件教程](INSTALL.md)。 +austin项目**强依赖**`MySQL`/`Redis`/(**大概需要2G内存**)，**弱依赖**`kafka`/`prometheus`/`graylog`/`flink`/`xxl-job`/`apollo`/`hive`(**完全部署所有的服务，大概16G内存**)。如果缺少相关的组件可戳：[安装相关组件教程](doc/INSTALL.md)。 > 实在想要`clone`项目后不用自己部署环境直接在**本地**启动`debug`，我这提供了[股东服务](https://www.yuque.com/u1047901/eg5qvy/hh0gk5p4uwie8bva)，**直连**部署好的服务器。 @@ -80,7 +79,7 @@ austin项目**强依赖**`MySQL`/`Redis`/(**大概需要2G内存**)，**弱依 **2**、填写`application.properties`中`spring.datasource`对应的`ip/port/username/password`信息 -**3**、执行`sql`文件夹下的`austin.sql`创建对应的表 +**3**、执行`doc/sql`文件夹下的[austin.sql](doc/sql/austin.sql)创建对应的表 **4**、填写`application.properties`中`spring.redis`对应的`ip`/`port`/`password`信息 @@ -88,24 +87,24 @@ austin项目**强依赖**`MySQL`/`Redis`/(**大概需要2G内存**)，**弱依 **6**、**austin前端管理系统部署**，戳[GitHub](https://github.com/ZhongFuCheng3y/austin-admin)或[Gitee](https://gitee.com/zhongfucheng/austin-admin)跳转至对应的仓库 -**7**、（可选）正常使用**数据管理**(查看实时数据链路下发)需要将`austin-stream`的`jar`包上传至`Flink`，根据[部署文档](INSTALL.md)启动Flink。在打`jar`包前需要填写`com.java3y.austin.stream.constants.AustinFlinkConstant`中的`redis`和`kafka`的`ip/port`（注意：日志的topic在`application.properties`中的`austin.business.log.topic.name`。如果没有该topic，需要提前创建，并**使用Kafka**作为消息队列实现) +**7**、（可选）正常使用**数据管理**(查看实时数据链路下发)需要将`austin-stream`的`jar`包上传至`Flink`，根据[部署文档](doc/INSTALL.md)启动Flink。在打`jar`包前需要填写`com.java3y.austin.stream.constants.AustinFlinkConstant`中的`redis`和`kafka`的`ip/port`（注意：日志的topic在`application.properties`中的`austin.business.log.topic.name`。如果没有该topic，需要提前创建，并**使用Kafka**作为消息队列实现) -**8**、（可选）正常使用**定时任务**需要部署`xxl-job`，根据[部署文档](INSTALL.md)启动xxl的调度中心，并在`application.properteis`中填写 `austin.xxl.job.ip`和`austin.xxl.job.port` +**8**、（可选）正常使用**定时任务**需要部署`xxl-job`，根据[部署文档](doc/INSTALL.md)启动xxl的调度中心，并在`application.properteis`中填写 `austin.xxl.job.ip`和`austin.xxl.job.port` -**9**、（可选）正常使用**分布式日志采集**需要部署`graylog`，根据[部署文档](INSTALL.md)启动`graylog`，并在`application.properteis`中填写 `austin.graylog.ip`。 +**9**、（可选）正常使用**分布式日志采集**需要部署`graylog`，根据[部署文档](doc/INSTALL.md)启动`graylog`，并在`application.properteis`中填写 `austin.graylog.ip`。 -**10**、（可选）正常使用**系统监控**需要部署`promethus`和`grafana`，根据[部署文档](INSTALL.md)配置`grafana`图表。 +**10**、（可选）正常使用**系统监控**需要部署`promethus`和`grafana`，根据[部署文档](doc/INSTALL.md)配置`grafana`图表。 -**11**、（可选）正常使用**动态配置中心**需要部署`apollo`，根据[部署文档](INSTALL.md)启动`apollo`，通过docker-compose启动需要在AustinApplication注入对应的ip和port(可看注释)。 +**11**、（可选）正常使用**动态配置中心**需要部署`apollo`，根据[部署文档](doc/INSTALL.md)启动`apollo`，通过docker-compose启动需要在AustinApplication注入对应的ip和port(可看注释)。 -**12**、（可选）正常使用**数据仓库**需要部署`hive`，根据[部署文档](INSTALL.md)通过`flink`把数据写入到`hive`中（`flink`环境也要安装好），将`austin-data-house`的`jar`包提交到`flink`执行 +**12**、（可选）正常使用**数据仓库**需要部署`hive`，根据[部署文档](doc/INSTALL.md)通过`flink`把数据写入到`hive`中（`flink`环境也要安装好），将`austin-data-house`的`jar`包提交到`flink`执行 ## 官方项目交流群 austin项目官方交流群已经超过了两百人，添加我的个人微信 java3yyy 添加时备注：【**项目**】，我空的时候会拉进项目交流群里。 - + ## 项目文档 @@ -113,4 +112,4 @@ austin项目官方交流群已经超过了两百人，添加我的个人微信 j -![](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/e7e69fb77ee74fbe8073adfefbe9e54c~tplv-k3u1fbpfcp-watermark.image?) +![](doc/9.jpeg) diff --git a/INSTALL.md b/doc/INSTALL.md similarity index 100% rename from INSTALL.md rename to doc/INSTALL.md diff --git a/docker/apollo/docker-quick-start/docker-compose.yml b/doc/docker/apollo/docker-quick-start/docker-compose.yml similarity index 100% rename from docker/apollo/docker-quick-start/docker-compose.yml rename to doc/docker/apollo/docker-quick-start/docker-compose.yml diff --git a/docker/apollo/docker-quick-start/sql/apolloconfigdb.sql b/doc/docker/apollo/docker-quick-start/sql/apolloconfigdb.sql similarity index 100% rename from docker/apollo/docker-quick-start/sql/apolloconfigdb.sql rename to doc/docker/apollo/docker-quick-start/sql/apolloconfigdb.sql diff --git a/docker/apollo/docker-quick-start/sql/apolloportaldb.sql b/doc/docker/apollo/docker-quick-start/sql/apolloportaldb.sql similarity index 100% rename from docker/apollo/docker-quick-start/sql/apolloportaldb.sql rename to doc/docker/apollo/docker-quick-start/sql/apolloportaldb.sql diff --git a/docker/flink/docker-compose.yml b/doc/docker/flink/docker-compose.yml similarity index 100% rename from docker/flink/docker-compose.yml rename to doc/docker/flink/docker-compose.yml diff --git a/docker/graylog/docker-compose.yml b/doc/docker/graylog/docker-compose.yml similarity index 100% rename from docker/graylog/docker-compose.yml rename to doc/docker/graylog/docker-compose.yml diff --git a/docker/hive/docker-compose.yml b/doc/docker/hive/docker-compose.yml similarity index 100% rename from docker/hive/docker-compose.yml rename to doc/docker/hive/docker-compose.yml diff --git a/docker/kafka/docker-compose.yml b/doc/docker/kafka/docker-compose.yml similarity index 100% rename from docker/kafka/docker-compose.yml rename to doc/docker/kafka/docker-compose.yml diff --git a/docker/mysql/docker-compose.yml b/doc/docker/mysql/docker-compose.yml similarity index 100% rename from docker/mysql/docker-compose.yml rename to doc/docker/mysql/docker-compose.yml diff --git a/docker/nacos/cluster/docker-compose.yml b/doc/docker/nacos/cluster/docker-compose.yml similarity index 100% rename from docker/nacos/cluster/docker-compose.yml rename to doc/docker/nacos/cluster/docker-compose.yml diff --git a/docker/nacos/single/docker-compose.yml b/doc/docker/nacos/single/docker-compose.yml similarity index 100% rename from docker/nacos/single/docker-compose.yml rename to doc/docker/nacos/single/docker-compose.yml diff --git a/docker/nacos/sql/config.sql b/doc/docker/nacos/sql/config.sql similarity index 100% rename from docker/nacos/sql/config.sql rename to doc/docker/nacos/sql/config.sql diff --git a/docker/prometheus/docker-compose.yaml b/doc/docker/prometheus/docker-compose.yaml similarity index 100% rename from docker/prometheus/docker-compose.yaml rename to doc/docker/prometheus/docker-compose.yaml diff --git a/docker/prometheus/prometheus.yml b/doc/docker/prometheus/prometheus.yml similarity index 100% rename from docker/prometheus/prometheus.yml rename to doc/docker/prometheus/prometheus.yml diff --git a/docker/rabbitmq/docker-compose-rabbitmq-3.7.8-management.yml b/doc/docker/rabbitmq/docker-compose-rabbitmq-3.7.8-management.yml similarity index 100% rename from docker/rabbitmq/docker-compose-rabbitmq-3.7.8-management.yml rename to doc/docker/rabbitmq/docker-compose-rabbitmq-3.7.8-management.yml diff --git a/docker/rabbitmq/docker-compose-rabbitmq-cluster.yml b/doc/docker/rabbitmq/docker-compose-rabbitmq-cluster.yml similarity index 100% rename from docker/rabbitmq/docker-compose-rabbitmq-cluster.yml rename to doc/docker/rabbitmq/docker-compose-rabbitmq-cluster.yml diff --git a/docker/rabbitmq/docker-compose-rabbitmq.yml b/doc/docker/rabbitmq/docker-compose-rabbitmq.yml similarity index 100% rename from docker/rabbitmq/docker-compose-rabbitmq.yml rename to doc/docker/rabbitmq/docker-compose-rabbitmq.yml diff --git a/docker/rabbitmq/rabbitmq-cluster/.erlang.cookie b/doc/docker/rabbitmq/rabbitmq-cluster/.erlang.cookie similarity index 100% rename from docker/rabbitmq/rabbitmq-cluster/.erlang.cookie rename to doc/docker/rabbitmq/rabbitmq-cluster/.erlang.cookie diff --git a/docker/rabbitmq/rabbitmq-cluster/init-rabbitmq.sh b/doc/docker/rabbitmq/rabbitmq-cluster/init-rabbitmq.sh similarity index 100% rename from docker/rabbitmq/rabbitmq-cluster/init-rabbitmq.sh rename to doc/docker/rabbitmq/rabbitmq-cluster/init-rabbitmq.sh diff --git a/docker/rabbitmq/rabbitmq-cluster/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez b/doc/docker/rabbitmq/rabbitmq-cluster/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez similarity index 100% rename from docker/rabbitmq/rabbitmq-cluster/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez rename to doc/docker/rabbitmq/rabbitmq-cluster/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez diff --git a/docker/rabbitmq/rabbitmq-cluster/rabbitmq-1/config/rabbitmq.conf b/doc/docker/rabbitmq/rabbitmq-cluster/rabbitmq-1/config/rabbitmq.conf similarity index 100% rename from docker/rabbitmq/rabbitmq-cluster/rabbitmq-1/config/rabbitmq.conf rename to doc/docker/rabbitmq/rabbitmq-cluster/rabbitmq-1/config/rabbitmq.conf diff --git a/docker/rabbitmq/rabbitmq-cluster/rabbitmq-2/config/rabbitmq.conf b/doc/docker/rabbitmq/rabbitmq-cluster/rabbitmq-2/config/rabbitmq.conf similarity index 100% rename from docker/rabbitmq/rabbitmq-cluster/rabbitmq-2/config/rabbitmq.conf rename to doc/docker/rabbitmq/rabbitmq-cluster/rabbitmq-2/config/rabbitmq.conf diff --git a/docker/rabbitmq/rabbitmq/config/10-default-guest-user.conf b/doc/docker/rabbitmq/rabbitmq/config/10-default-guest-user.conf similarity index 100% rename from docker/rabbitmq/rabbitmq/config/10-default-guest-user.conf rename to doc/docker/rabbitmq/rabbitmq/config/10-default-guest-user.conf diff --git a/docker/rabbitmq/rabbitmq/config/rabbitmq.conf b/doc/docker/rabbitmq/rabbitmq/config/rabbitmq.conf similarity index 100% rename from docker/rabbitmq/rabbitmq/config/rabbitmq.conf rename to doc/docker/rabbitmq/rabbitmq/config/rabbitmq.conf diff --git a/docker/rabbitmq/rabbitmq/config/rabbitmq_bak.conf b/doc/docker/rabbitmq/rabbitmq/config/rabbitmq_bak.conf similarity index 100% rename from docker/rabbitmq/rabbitmq/config/rabbitmq_bak.conf rename to doc/docker/rabbitmq/rabbitmq/config/rabbitmq_bak.conf diff --git a/docker/rabbitmq/rabbitmq/config/rabbitmq_bak.config b/doc/docker/rabbitmq/rabbitmq/config/rabbitmq_bak.config similarity index 100% rename from docker/rabbitmq/rabbitmq/config/rabbitmq_bak.config rename to doc/docker/rabbitmq/rabbitmq/config/rabbitmq_bak.config diff --git a/docker/rabbitmq/rabbitmq/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez b/doc/docker/rabbitmq/rabbitmq/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez similarity index 100% rename from docker/rabbitmq/rabbitmq/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez rename to doc/docker/rabbitmq/rabbitmq/plugins/rabbitmq_delayed_message_exchange-3.9.0.ez diff --git a/docker/redis/docker-compose.yaml b/doc/docker/redis/docker-compose.yaml similarity index 100% rename from docker/redis/docker-compose.yaml rename to doc/docker/redis/docker-compose.yaml diff --git a/docker/redis/redis.conf b/doc/docker/redis/redis.conf similarity index 100% rename from docker/redis/redis.conf rename to doc/docker/redis/redis.conf diff --git a/docker/rocketmq/docker-compose-rocketmq.yml b/doc/docker/rocketmq/docker-compose-rocketmq.yml similarity index 100% rename from docker/rocketmq/docker-compose-rocketmq.yml rename to doc/docker/rocketmq/docker-compose-rocketmq.yml diff --git a/docker/rocketmq/rocketmq/rocketmq_broker/conf/broker.conf b/doc/docker/rocketmq/rocketmq/rocketmq_broker/conf/broker.conf similarity index 100% rename from docker/rocketmq/rocketmq/rocketmq_broker/conf/broker.conf rename to doc/docker/rocketmq/rocketmq/rocketmq_broker/conf/broker.conf diff --git a/docker/xxljob/tables_xxl_job.sql b/doc/docker/xxljob/tables_xxl_job.sql similarity index 100% rename from docker/xxljob/tables_xxl_job.sql rename to doc/docker/xxljob/tables_xxl_job.sql diff --git a/sql/austin.sql b/doc/sql/austin.sql similarity index 100% rename from sql/austin.sql rename to doc/sql/austin.sql diff --git a/docker-compose.yml b/docker-compose.yml index 30e658a..a833e84 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -12,7 +12,7 @@ services: hostname: mysql command: --init-file /docker-entrypoint-initdb.d/init.sql volumes: - - ./sql/austin.sql:/docker-entrypoint-initdb.d/init.sql + - ./doc/sql/austin.sql:/docker-entrypoint-initdb.d/init.sql ports: - "3306:3306" networks: