Skip to content

Commit bbcd347

Browse files
committed
[doc]feature: update contributor guide and gif show (apache#155)
* Add @ChineseTony as a contributor * [doc]feature: update contributor guide and gif show
1 parent 63ee5ed commit bbcd347

File tree

10 files changed

+321
-84
lines changed

10 files changed

+321
-84
lines changed

Diff for: .all-contributorsrc

+9
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,15 @@
124124
"code",
125125
"bug"
126126
]
127+
},
128+
{
129+
"login": "ChineseTony",
130+
"name": "ChineseTony",
131+
"avatar_url": "https://avatars.githubusercontent.com/u/24618786?v=4",
132+
"profile": "https://github.com/ChineseTony",
133+
"contributions": [
134+
"code"
135+
]
127136
}
128137
],
129138
"contributorsPerLine": 7

Diff for: CONTRIBUTING.md

+269-45
Large diffs are not rendered by default.

Diff for: README.md

+12-21
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## HertzBeat | [中文文档](README_CN.md)
1010

11-
> Friendly cloud monitoring system. | 易用友好的云监控系统, 无需Agent, 强大自定义监控能力.
11+
> Friendly Cloud Monitoring System. | 易用友好的云监控系统, 无需Agent, 强大自定义监控能力.
1212
1313
[![Gitter](https://badges.gitter.im/hertzbeat/community.svg)](https://gitter.im/hertzbeat/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
1414
![tan-cloud](https://img.shields.io/badge/web-monitor-4EB1BA)
@@ -39,29 +39,18 @@ Running HertzBeat in [OSCR.COM](https://osrc.com) Open Source Runtime Community
3939
4040
----
4141

42-
[![tancloud](tancloud.gif)](https://www.bilibili.com/video/BV1DY4y1i7ts)
42+
[![hertzbeat](hertzbeat.gif)](https://www.bilibili.com/video/BV1DY4y1i7ts)
4343

4444
----
4545

4646
## 🥐 Architecture
4747

48-
- **[manager](https://github.com/dromara/hertzbeat/tree/master/manager)** Provide monitoring management, system management basic services.
49-
> Provides monitoring management, monitoring configuration management, system user management, etc.
50-
- **[collector](https://github.com/dromara/hertzbeat/tree/master/collector)** Provide metrics data collection services.
51-
> Use common protocols to remotely collect and obtain peer-to-peer metrics data.
52-
- **[warehouse](https://github.com/dromara/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services.
53-
> Metrics data management, data query, calculation and statistics.
54-
- **[alerter](https://github.com/dromara/hertzbeat/tree/master/alerter)** Provide alert service.
55-
> Alarm calculation trigger, monitoring status linkage, alarm configuration, and alarm notification.
56-
- **[web-app](https://github.com/dromara/hertzbeat/tree/master/web-app)** Provide web ui.
57-
> Angular Web UI.
58-
5948
![hertzBeat](home/static/img/docs/hertzbeat-stru-en.svg)
6049

6150

6251
## 🐕 Quick Start
6352

64-
- If you don’t want to deploy but use it directly, we provide [SAAS Monitoring Cloud-TanCloud](https://console.tancloud.cn), **[Log In And Register For Free](https://console.tancloud.cn) **.
53+
- If you don’t want to deploy but use it directly, we provide [SAAS Monitoring Cloud-TanCloud](https://console.tancloud.cn), **[Log In And Register For Free](https://console.tancloud.cn)**.
6554
- If you want to deploy HertzBeat local, please refer to the following [Deployment Documentation](https://hertzbeat.com/docs/start/quickstart) for operation.
6655

6756
### 🐵 Dependency Service Deployment
@@ -74,21 +63,21 @@ Running HertzBeat in [OSCR.COM](https://osrc.com) Open Source Runtime Community
7463
2. Create database names `hertzbeat`
7564
3. Run the database sql script [schema.sql](https://gitee.com/dromara/hertzbeat/raw/master/script/sql/schema.sql) located in the project repository `/script/sql/` directory.
7665

77-
For detailed steps, refer to [MYSQL Installation And Initialization](https://hertzbeat.com/docs/start/mysql-init)
66+
For detailed steps, refer to [MYSQL Install And Init](https://hertzbeat.com/docs/start/mysql-init)
7867

7968
##### Install TDengine
8069
1. Install TDengine with docker
8170
`docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:2.4.0.12`
8271
2. Create database names `hertzbeat`
8372

84-
For detailed steps, refer to [TDengine Installation And Initialization](https://hertzbeat.com/docs/start/tdengine-init).
73+
For detailed steps, refer to [TDengine Install And Init](https://hertzbeat.com/docs/start/tdengine-init).
8574

8675
### 🍞 Install HertzBeat
8776

8877
> HertzBeat supports installation through source code, docker or package.
8978
9079
##### 1:Install quickly via docker
91-
`docker run -d -p 1157:1157 -v /opt/application.yml:/opt/hertzbeat/config/application.yml --name hertzbeat tancloud/hertzbeat:[版本tag]`
80+
`docker run -d -p 1157:1157 -v /opt/application.yml:/opt/hertzbeat/config/application.yml --name hertzbeat tancloud/hertzbeat:[version]`
9281

9382
Detailed steps refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy)
9483

@@ -98,11 +87,11 @@ Detailed steps refer to [Install HertzBeat via Docker](https://hertzbeat.com/doc
9887
3. Run shell `$ ./startup.sh `
9988
4. Access `localhost:1157` to start, default account: `admin/hertzbeat`
10089

101-
Detailed steps refer to [Install HertzBeat via package](https://hertzbeat.com/docs/start/package-deploy)
90+
Detailed steps refer to [Install HertzBeat via Package](https://hertzbeat.com/docs/start/package-deploy)
10291

10392
##### 3:Start via source code
10493
1. Local source code debugging needs to start the back-end project manager and the front-end project web-app.
105-
2. Backend:need `maven3+`, `java8+`, start the manager service.
94+
2. Backend:need `maven3+`, `java8+`, `lombok`, start the manager service.
10695
3. Web:need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup.
10796
4. Access `localhost:4200` to start, default account: `admin/hertzbeat`
10897

@@ -112,13 +101,14 @@ Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md)
112101

113102
Install and deploy the mysql database, tdengine database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose).
114103

115-
Detailed steps refer to [docker-compose install](script/docker-compose/README.md)
104+
Detailed steps refer to [Install via Docker-Compose](script/docker-compose/README.md)
116105

117106
**HAVE FUN**
118107

119108
## ✨ Contributors
120109

121-
Thanks these wonderful people, welcome to join us:
110+
Thanks these wonderful people, welcome to join us:
111+
[CONTRIBUTING](CONTRIBUTING.md)
122112

123113
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
124114
<!-- prettier-ignore-start -->
@@ -138,6 +128,7 @@ Thanks these wonderful people, welcome to join us:
138128
<td align="center"><a href="https://github.com/brave4Time"><img src="https://avatars.githubusercontent.com/u/105094014?v=4?s=100" width="100px;" alt=""/><br /><sub><b>brave4Time</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=brave4Time" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Abrave4Time" title="Bug reports">🐛</a></td>
139129
<td align="center"><a href="https://github.com/walkerlee-lab"><img src="https://avatars.githubusercontent.com/u/8426753?v=4?s=100" width="100px;" alt=""/><br /><sub><b>WalkerLee</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=walkerlee-lab" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Awalkerlee-lab" title="Bug reports">🐛</a></td>
140130
<td align="center"><a href="https://github.com/fullofjoy"><img src="https://avatars.githubusercontent.com/u/30247571?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jianghang</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=fullofjoy" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Afullofjoy" title="Bug reports">🐛</a></td>
131+
<td align="center"><a href="https://github.com/ChineseTony"><img src="https://avatars.githubusercontent.com/u/24618786?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ChineseTony</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=ChineseTony" title="Code">💻</a></td>
141132
</tr>
142133
</table>
143134

Diff for: README_CN.md

+4-14
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,11 @@
3838
3939
----
4040

41-
[![tancloud](tancloud.gif)](https://www.bilibili.com/video/BV1DY4y1i7ts)
41+
[![hertzbeat](hertzbeat.gif)](https://www.bilibili.com/video/BV1DY4y1i7ts)
4242

4343
----
4444

45-
## 🥐 模块
46-
47-
- **[manager](https://github.com/dromara/hertzbeat/tree/master/manager)** 提供监控管理,系统管理基础服务
48-
> 提供对监控的管理,监控应用配置的管理,系统用户租户后台管理等。
49-
- **[collector](https://github.com/dromara/hertzbeat/tree/master/collector)** 提供监控数据采集服务
50-
> 使用通用协议远程采集获取对端指标数据。
51-
- **[warehouse](https://github.com/dromara/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务
52-
> 采集指标结果数据管理,数据落盘,查询,计算统计。
53-
- **[alerter](https://github.com/dromara/hertzbeat/tree/master/alerter)** 提供告警服务
54-
> 告警计算触发,监控状态联动,告警配置,告警通知。
55-
- **[web-app](https://github.com/dromara/hertzbeat/tree/master/web-app)** 提供可视化控制台页面
56-
> 监控告警系统可视化控制台前端
45+
## 🥐 模块
5746

5847
![hertzBeat](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/docs/hertzbeat-stru.svg)
5948

@@ -112,7 +101,7 @@
112101

113102
通过 [docker-compose部署脚本](script/docker-compose) 一次性把mysql数据库,tdengine数据库和hertzbeat安装部署。
114103

115-
详细步骤参考 [docker-compose安装](script/docker-compose/README.md)
104+
详细步骤参考 [通过Docker-Compose安装HertzBeat](script/docker-compose/README.md)
116105

117106
**HAVE FUN**
118107

@@ -138,6 +127,7 @@ Thanks these wonderful people, welcome to join us:
138127
<td align="center"><a href="https://github.com/brave4Time"><img src="https://avatars.githubusercontent.com/u/105094014?v=4?s=100" width="100px;" alt=""/><br /><sub><b>brave4Time</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=brave4Time" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Abrave4Time" title="Bug reports">🐛</a></td>
139128
<td align="center"><a href="https://github.com/walkerlee-lab"><img src="https://avatars.githubusercontent.com/u/8426753?v=4?s=100" width="100px;" alt=""/><br /><sub><b>WalkerLee</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=walkerlee-lab" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Awalkerlee-lab" title="Bug reports">🐛</a></td>
140129
<td align="center"><a href="https://github.com/fullofjoy"><img src="https://avatars.githubusercontent.com/u/30247571?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jianghang</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=fullofjoy" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Afullofjoy" title="Bug reports">🐛</a></td>
130+
<td align="center"><a href="https://github.com/ChineseTony"><img src="https://avatars.githubusercontent.com/u/24618786?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ChineseTony</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=ChineseTony" title="Code">💻</a></td>
141131
</tr>
142132
</table>
143133

Diff for: tancloud.gif renamed to hertzbeat.gif

15.4 MB
Loading

Diff for: home/src/pages/index.js

+19
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import { features, SetupExample, SurenessIntegration, friendLinks, mediaPartners
1919
function Home() {
2020
const context = useDocusaurusContext()
2121
const {siteConfig = {}} = context
22+
loadGitter();
2223
return (
2324
<Layout
2425
title={`${siteConfig.title} · ${siteConfig.tagline}`}
@@ -78,3 +79,21 @@ function Home() {
7879
}
7980

8081
export default Home
82+
83+
function loadGitter() {
84+
return new Promise(function (resolve, reject) {
85+
var script = document.createElement('script')
86+
script.type = 'text/javascript'
87+
script.async = true;
88+
script.src = 'https://sidecar.gitter.im/dist/sidecar.v1.js';
89+
((window.gitter = {}).chat = {}).options = {
90+
room: 'hertzbeat/community'
91+
};
92+
script.onload = function () {
93+
((window.gitter = {}).chat = {}).options = {
94+
room: 'hertzbeat/community'
95+
};
96+
}
97+
document.body.appendChild(script)
98+
})
99+
}

Diff for: manager/src/main/resources/application.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ spring:
5959
suffix: .html
6060
#encoding: UTF-8
6161
#content-type: text/html
62-
mode: LEGACYHTML5
62+
mode: HTML
6363

6464
warehouse:
6565
store:

Diff for: manager/src/main/resources/logback-spring.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@
5858
<logger name="org.slf4j" level="info"/>
5959
<logger name="ch.qos.logback" level="info"/>
6060
<logger name="org.apache.kafka.clients" level="info"/>
61+
<logger name="org.hibernate" level="info"/>
62+
<logger name="org.apache.http" level="info"/>
63+
<logger name="com.zaxxer" level="info"/>
64+
<logger name="springfox" level="info"/>
6165

6266
<!-- 生产环境配置 -->
6367
<springProfile name="prod">
@@ -70,7 +74,7 @@
7074

7175
<!-- 开发环境配置 -->
7276
<springProfile name="dev">
73-
<root level="INFO">
77+
<root level="DEBUG">
7478
<appender-ref ref="ConsoleAppender"/>
7579
<appender-ref ref="SystemOutFileAppender"/>
7680
<appender-ref ref="ErrOutFileAppender"/>

Diff for: script/application.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ spring:
5858
suffix: .html
5959
#encoding: UTF-8
6060
#content-type: text/html
61-
mode: LEGACYHTML5
61+
mode: HTML
6262

6363
warehouse:
6464
store:

Diff for: script/docker-compose/conf/application.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ spring:
5858
suffix: .html
5959
#encoding: UTF-8
6060
#content-type: text/html
61-
mode: LEGACYHTML5
61+
mode: HTML
6262

6363
warehouse:
6464
store:

0 commit comments

Comments
 (0)