From 02ebca02cca79a747a651a5d4412e9dcbca57c43 Mon Sep 17 00:00:00 2001 From: tomsun28 Date: Thu, 21 Apr 2022 22:04:15 +0800 Subject: [PATCH] [docs]api tags i18n, update readme (#103) --- README.md | 6 ++---- README_EN.md | 4 +--- .../com/usthe/alert/controller/AlertDefineController.java | 2 +- .../usthe/alert/controller/AlertDefinesController.java | 2 +- .../java/com/usthe/alert/controller/AlertsController.java | 2 +- home/docs/start/docker-deploy.md | 8 ++++---- home/docs/start/package-deploy.md | 4 ++-- .../current/start/quickstart.md | 6 +++--- home/static/img/docs/hertzbeat-stru.svg | 2 +- .../main/java/com/usthe/manager/config/SwaggerConfig.java | 4 ++-- .../com/usthe/manager/controller/AccountController.java | 2 +- .../java/com/usthe/manager/controller/AppController.java | 2 +- .../java/com/usthe/manager/controller/I18nController.java | 2 +- .../com/usthe/manager/controller/MonitorController.java | 2 +- .../com/usthe/manager/controller/MonitorsController.java | 2 +- .../usthe/manager/controller/NoticeConfigController.java | 2 +- .../com/usthe/manager/controller/SummaryController.java | 2 +- .../usthe/warehouse/controller/MetricsDataController.java | 2 +- 18 files changed, 26 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 1f10a9f..b09cf49 100644 --- a/README.md +++ b/README.md @@ -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)** 提供告警服务 diff --git a/README_EN.md b/README_EN.md index 9b0d833..020aaa3 100644 --- a/README_EN.md +++ b/README_EN.md @@ -47,9 +47,7 @@ Running HertzBeat in [OSCR.COM](https://osrc.com) Open Source Runtime Community - **[manager](https://github.com/dromara/hertzbeat/tree/master/manager)** Provide monitoring management, system management basic services. > 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. +> Use common protocols to remotely collect and obtain peer-to-peer metrics data. - **[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. diff --git a/alerter/src/main/java/com/usthe/alert/controller/AlertDefineController.java b/alerter/src/main/java/com/usthe/alert/controller/AlertDefineController.java index 200e23c..3963c86 100644 --- a/alerter/src/main/java/com/usthe/alert/controller/AlertDefineController.java +++ b/alerter/src/main/java/com/usthe/alert/controller/AlertDefineController.java @@ -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 { diff --git a/alerter/src/main/java/com/usthe/alert/controller/AlertDefinesController.java b/alerter/src/main/java/com/usthe/alert/controller/AlertDefinesController.java index 213752a..278ca83 100644 --- a/alerter/src/main/java/com/usthe/alert/controller/AlertDefinesController.java +++ b/alerter/src/main/java/com/usthe/alert/controller/AlertDefinesController.java @@ -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 { diff --git a/alerter/src/main/java/com/usthe/alert/controller/AlertsController.java b/alerter/src/main/java/com/usthe/alert/controller/AlertsController.java index 290fd74..3c4d6b0 100644 --- a/alerter/src/main/java/com/usthe/alert/controller/AlertsController.java +++ b/alerter/src/main/java/com/usthe/alert/controller/AlertsController.java @@ -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 { diff --git a/home/docs/start/docker-deploy.md b/home/docs/start/docker-deploy.md index cfab117..41e5f74 100644 --- a/home/docs/start/docker-deploy.md +++ b/home/docs/start/docker-deploy.md @@ -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容器 ``` diff --git a/home/docs/start/package-deploy.md b/home/docs/start/package-deploy.md index 9712236..e084afc 100644 --- a/home/docs/start/package-deploy.md +++ b/home/docs/start/package-deploy.md @@ -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 diff --git a/home/i18n/en/docusaurus-plugin-content-docs/current/start/quickstart.md b/home/i18n/en/docusaurus-plugin-content-docs/current/start/quickstart.md index 7a86338..c0338e7 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/current/start/quickstart.md +++ b/home/i18n/en/docusaurus-plugin-content-docs/current/start/quickstart.md @@ -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** diff --git a/home/static/img/docs/hertzbeat-stru.svg b/home/static/img/docs/hertzbeat-stru.svg index af43025..fba2305 100644 --- a/home/static/img/docs/hertzbeat-stru.svg +++ b/home/static/img/docs/hertzbeat-stru.svg @@ -1 +1 @@ -Angularwebappmanagerscheduler新增删除修改采集任务下发和调度采集任务collectorhttpsqlsshtelnetsdkWEB服务数据库应用服务中间件操作系统消息管道push采集数据warehousepull数据进一步处理TdEngine/Influxdb内存/Redis全量时序采集数据最新一次实时数据mysql监控信息，系统信息alertpull提供监控管理，用户，租户，系统等API告警计算，告警转发。提供告警信息API提供指标(实时历史)数据查询等API告警信息默认数据格式，jsonPath，prometheus解析 \ No newline at end of file +Angularwebappmanager新增删除修改采集任务collectorhttpsqlsshtelnetsdkWEB服务数据库应用服务中间件操作系统消息管道push采集数据warehousepullTdEngine内存全量时序采集数据最新一次实时数据mysql监控信息，系统信息alertpull提供监控管理，用户，租户，系统等API告警计算，告警转发。提供告警信息API提供指标(实时历史)数据查询等API告警信息默认数据格式，jsonPath，prometheus解析 \ No newline at end of file diff --git a/manager/src/main/java/com/usthe/manager/config/SwaggerConfig.java b/manager/src/main/java/com/usthe/manager/config/SwaggerConfig.java index 891b06e..1edb4ca 100644 --- a/manager/src/main/java/com/usthe/manager/config/SwaggerConfig.java +++ b/manager/src/main/java/com/usthe/manager/config/SwaggerConfig.java @@ -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, diff --git a/manager/src/main/java/com/usthe/manager/controller/AccountController.java b/manager/src/main/java/com/usthe/manager/controller/AccountController.java index 1fb94bf..f4644b6 100644 --- a/manager/src/main/java/com/usthe/manager/controller/AccountController.java +++ b/manager/src/main/java/com/usthe/manager/controller/AccountController.java @@ -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 diff --git a/manager/src/main/java/com/usthe/manager/controller/AppController.java b/manager/src/main/java/com/usthe/manager/controller/AppController.java index 5c8bddb..6f4f559 100644 --- a/manager/src/main/java/com/usthe/manager/controller/AppController.java +++ b/manager/src/main/java/com/usthe/manager/controller/AppController.java @@ -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 { diff --git a/manager/src/main/java/com/usthe/manager/controller/I18nController.java b/manager/src/main/java/com/usthe/manager/controller/I18nController.java index 6660ad8..072031a 100644 --- a/manager/src/main/java/com/usthe/manager/controller/I18nController.java +++ b/manager/src/main/java/com/usthe/manager/controller/I18nController.java @@ -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 { diff --git a/manager/src/main/java/com/usthe/manager/controller/MonitorController.java b/manager/src/main/java/com/usthe/manager/controller/MonitorController.java index d3f11df..3a18e3d 100644 --- a/manager/src/main/java/com/usthe/manager/controller/MonitorController.java +++ b/manager/src/main/java/com/usthe/manager/controller/MonitorController.java @@ -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 { diff --git a/manager/src/main/java/com/usthe/manager/controller/MonitorsController.java b/manager/src/main/java/com/usthe/manager/controller/MonitorsController.java index 7419e0c..7b07237 100644 --- a/manager/src/main/java/com/usthe/manager/controller/MonitorsController.java +++ b/manager/src/main/java/com/usthe/manager/controller/MonitorsController.java @@ -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 { diff --git a/manager/src/main/java/com/usthe/manager/controller/NoticeConfigController.java b/manager/src/main/java/com/usthe/manager/controller/NoticeConfigController.java index fdca14c..10f902e 100644 --- a/manager/src/main/java/com/usthe/manager/controller/NoticeConfigController.java +++ b/manager/src/main/java/com/usthe/manager/controller/NoticeConfigController.java @@ -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 { diff --git a/manager/src/main/java/com/usthe/manager/controller/SummaryController.java b/manager/src/main/java/com/usthe/manager/controller/SummaryController.java index 8de22fd..7c0b79e 100644 --- a/manager/src/main/java/com/usthe/manager/controller/SummaryController.java +++ b/manager/src/main/java/com/usthe/manager/controller/SummaryController.java @@ -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 { diff --git a/warehouse/src/main/java/com/usthe/warehouse/controller/MetricsDataController.java b/warehouse/src/main/java/com/usthe/warehouse/controller/MetricsDataController.java index d5122d9..c4fb988 100644 --- a/warehouse/src/main/java/com/usthe/warehouse/controller/MetricsDataController.java +++ b/warehouse/src/main/java/com/usthe/warehouse/controller/MetricsDataController.java @@ -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;