OpenSource/hertzbeat
Public Access
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[docs]api tags i18n, update readme (#103)

Browse Source
This commit is contained in:
tomsun28
2022-04-21 22:04:15 +08:00
committed by GitHub
parent 1c31b3ff0c
commit 02ebca02cc
18 changed files with 26 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -8,7 +8,7 @@
## HertzBeat 赫兹跳动 | [English Documentation](README_EN.md)
> 易用友好的监控告警系统。
> 易用友好的云监控系统，无需Agent，强大自定义监控能力。
![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/web-monitor.svg)
![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/ping-connect.svg)
@@ -28,7 +28,7 @@
> [HertzBeat赫兹跳动](https://github.com/dromara/hertzbeat) 是由[Dromara](https://dromara.org)孵化，[TanCloud](https://tancloud.cn)开源的一个支持网站，API，PING，端口，数据库，操作系统等监控类型，拥有易用友好的可视化操作界面的开源监控告警项目。
> 我们也提供了对应的 **[SAAS版本监控云](https://console.tancloud.cn)**，中小团队和个人无需再为了监控自己的网站资源，而去部署一套繁琐的监控系统，**[登录即可免费开始](https://console.tancloud.cn)**。
> HertzBeat 支持[自定义监控](https://hertzbeat.com/docs/advanced/extend-point) ,只用通过配置YML文件我们就可以自定义需要的监控类型和指标，来满足常见的个性化需求。
> HertzBeat 模块化，`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。
> HertzBeat 模块化，`manager, collector, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。
> HertzBeat 支持更自由化的告警配置(计算表达式)，支持告警通知，告警模版，邮件钉钉微信飞书等及时通知送达
> 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。
> 我们正在快速迭代中，欢迎参与加入一起共建项目开源生态。
@@ -47,8 +47,6 @@
> 提供对监控的管理，监控应用配置的管理，系统用户租户后台管理等。
- **[collector](https://github.com/dromara/hertzbeat/tree/master/collector)** 提供监控数据采集服务
> 使用通用协议远程采集获取对端指标数据。
- **[scheduler](https://github.com/dromara/hertzbeat/tree/master/scheduler)** 提供监控任务调度服务
> 采集任务管理，一次性任务和周期性任务的调度分发。
- **[warehouse](https://github.com/dromara/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务
> 采集指标结果数据管理，数据落盘，查询，计算统计。
- **[alerter](https://github.com/dromara/hertzbeat/tree/master/alerter)** 提供告警服务

2
README_EN.md
View File

@@ -48,8 +48,6 @@ Running HertzBeat in [OSCR.COM](https://osrc.com) Open Source Runtime Community
> Provides monitoring management, monitoring configuration management, system user management, etc.
- **[collector](https://github.com/dromara/hertzbeat/tree/master/collector)** Provide metrics data collection services.
> Use common protocols to remotely collect and obtain peer-to-peer metrics data.
- **[scheduler](https://github.com/dromara/hertzbeat/tree/master/scheduler)** Provide monitoring task scheduling service.
> Collection task management, scheduling and distribution of one-time tasks and periodic tasks.
- **[warehouse](https://github.com/dromara/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services.
> Metrics data management, data query, calculation and statistics.
- **[alerter](https://github.com/dromara/hertzbeat/tree/master/alerter)** Provide alert service.

2
alerter/src/main/java/com/usthe/alert/controller/AlertDefineController.java
View File

@@ -31,7 +31,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tom
* @date 2021/12/9 10:32
*/
@Api(tags = "告警定义管理API")
@Api(tags = "Alert Define API | 告警定义管理API")
@RestController
@RequestMapping(path = "/alert/define", produces = {APPLICATION_JSON_VALUE})
public class AlertDefineController {

2
alerter/src/main/java/com/usthe/alert/controller/AlertDefinesController.java
View File

@@ -31,7 +31,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tom
* @date 2021/12/9 10:32
*/
@Api(tags = "告警定义管理API")
@Api(tags = "Alert Define Batch API | 告警定义管理API")
@RestController
@RequestMapping(path = "/alert/defines", produces = {APPLICATION_JSON_VALUE})
public class AlertDefinesController {

2
alerter/src/main/java/com/usthe/alert/controller/AlertsController.java
View File

@@ -35,7 +35,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tom
* @date 2021/12/9 10:32
*/
@Api(tags = "en: Alarm batch management API, zh:告警批量管理API")
@Api(tags = "Alarm Manage Batch API | 告警批量管理API")
@RestController
@RequestMapping(path = "/alerts", produces = {APPLICATION_JSON_VALUE})
public class AlertsController {

8
home/docs/start/docker-deploy.md
View File

@@ -47,7 +47,7 @@ sidebar_label: Docker方式部署
在主机目录下创建sureness.yml，eg:/opt/sureness.yml
配置文件内容参考 项目仓库[/script/sureness.yml](https://gitee.com/dromara/hertzbeat/blob/master/script/sureness.yml)
```yaml
```yaml
resourceRole:
- /account/auth/refresh===post===[admin,user,guest]
@@ -115,11 +115,11 @@ account:
salt: 123
role: [guest]
```
```
修改sureness.yml的如下**部分参数**：**[注意⚠️sureness配置的其它默认参数需保留]**
```yaml
```yaml
# 用户账户信息
# 下面有 admin tom lili 三个账户
@@ -144,7 +144,7 @@ account:
salt: 123
role: [guest]
```
```
6. 启动HertzBeat Docker容器
```

4
home/docs/start/package-deploy.md
View File

@@ -50,7 +50,7 @@ sidebar_label: 安装包方式部署
若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤
修改sureness.yml的如下**部分参数**：**[注意⚠️sureness配置的其它默认参数需保留]**
```yaml
```yaml
# 用户账户信息
# 下面有 admin tom lili 三个账户
@@ -75,7 +75,7 @@ account:
salt: 123
role: [guest]
```
```
5. 部署启动
执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh

6
home/i18n/en/docusaurus-plugin-content-docs/current/start/quickstart.md
View File

@@ -52,12 +52,12 @@ Detailed steps refer to [Install HertzBeat via package](https://hertzbeat.com/do
3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup.
4. Access `localhost:4200` to start, default account: `admin/admin`
Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md)
Detailed steps refer to [CONTRIBUTING](../others/contributing)
##### 4：Install All(mysql+tdengine+hertzbeat) via Docker-compose
Install and deploy the mysql database, tdengine database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose).
Install and deploy the mysql database, tdengine database and hertzbeat at one time through [docker-compose deployment script](https://github.com/dromara/hertzbeat/tree/master/script/docker-compose).
Detailed steps refer to [docker-compose install](script/docker-compose/README.md)
Detailed steps refer to [docker-compose install](https://github.com/dromara/hertzbeat/tree/master/script/docker-compose)
**HAVE FUN**

2
home/static/img/docs/hertzbeat-stru.svg
View File

File diff suppressed because one or more lines are too long
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 30 KiB

4
manager/src/main/java/com/usthe/manager/config/SwaggerConfig.java
View File

@@ -26,7 +26,7 @@ public class SwaggerConfig {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.enable(true)
.groupName("TanCloud")
.groupName("HertzBeat")
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.regex("(?!/error.*).*"))
@@ -35,7 +35,7 @@ public class SwaggerConfig {
private ApiInfo apiInfo(){
return new ApiInfo(
"TanCloud",
"HertzBeat",
null,
"v1.0",
null,

2
manager/src/main/java/com/usthe/manager/controller/AccountController.java
View File

@@ -35,7 +35,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tomsun28
* @date 13:11 2019-05-26
*/
@Api(tags = "en: Authentication registration TOKEN management API,zh: 认证注册TOKEN管理API")
@Api(tags = "Auth Manage API | 认证注册TOKEN管理API")
@RestController()
@RequestMapping(value = "/account/auth", produces = {APPLICATION_JSON_VALUE})
@Slf4j

2
manager/src/main/java/com/usthe/manager/controller/AppController.java
View File

@@ -27,7 +27,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tomsun28
* @date 2021/11/14 16:47
*/
@Api(tags = "en: Monitoring Type Management API,zh: 监控类型管理API")
@Api(tags = "Monitor Type Manage API | 监控类型管理API")
@RestController
@RequestMapping(path = "/apps", produces = {APPLICATION_JSON_VALUE})
public class AppController {

2
manager/src/main/java/com/usthe/manager/controller/I18nController.java
View File

@@ -21,7 +21,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tom
* @date 2021/12/4 21:40
*/
@Api(tags = "I18N国际化资源API")
@Api(tags = "I18N API | I18N国际化资源API")
@RestController
@RequestMapping(path = "/i18n", produces = {APPLICATION_JSON_VALUE})
public class I18nController {

2
manager/src/main/java/com/usthe/manager/controller/MonitorController.java
View File

@@ -30,7 +30,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tomsun28
* @date 2021/11/14 10:57
*/
@Api(tags = "en: Monitoring management API,zh: 监控管理API")
@Api(tags = "Monitor Manage API | 监控管理API")
@RestController
@RequestMapping(path = "/monitor", produces = {APPLICATION_JSON_VALUE})
public class MonitorController {

2
manager/src/main/java/com/usthe/manager/controller/MonitorsController.java
View File

@@ -35,7 +35,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tom
* @date 2021/12/1 20:43
*/
@Api(tags = "en: Monitor and manage batch API,zh: 监控列表API")
@Api(tags = "Monitor Manage Batch API | 监控列表API")
@RestController
@RequestMapping(path = "/monitors", produces = {APPLICATION_JSON_VALUE})
public class MonitorsController {

2
manager/src/main/java/com/usthe/manager/controller/NoticeConfigController.java
View File

@@ -34,7 +34,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tom
* @date 2021/12/16 16:18
*/
@Api(tags = "en: Message Notification Configuration API,zh: 消息通知配置API")
@Api(tags = "Notification Config API | 消息通知配置API")
@RestController()
@RequestMapping(value = "/notice", produces = {APPLICATION_JSON_VALUE})
public class NoticeConfigController {

2
manager/src/main/java/com/usthe/manager/controller/SummaryController.java
View File

@@ -24,7 +24,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
* @author tom
* @date 2021/12/7 15:57
*/
@Api(tags = "en: System Summary Statistics API,zh: 系统摘要统计API")
@Api(tags = "Summary Statistics API | 系统摘要统计API")
@RestController
@RequestMapping(path = "/summary", produces = {APPLICATION_JSON_VALUE})
public class SummaryController {

2
warehouse/src/main/java/com/usthe/warehouse/controller/MetricsDataController.java
View File

@@ -34,7 +34,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
*/
@RestController
@RequestMapping(produces = {APPLICATION_JSON_VALUE})
@Api(tags = "监控指标数据API")
@Api(tags = "Metrics Data API | 监控指标数据API")
public class MetricsDataController {
private static final Integer METRIC_FULL_LENGTH = 3;