From 754b18c9bad48d63490bda9d23ad55e0585d97b6 Mon Sep 17 00:00:00 2001 From: Logic Date: Tue, 26 Nov 2024 14:36:40 +0800 Subject: [PATCH 1/2] [doc] update sidebar category label and plugin documentation (#2837) --- home/docs/help/plugin.md | 8 +- .../current.json | 4 +- .../current.json | 6 +- .../current/help/plugin.md | 8 +- home/sidebars.json | 206 +++++++++--------- 5 files changed, 120 insertions(+), 112 deletions(-) diff --git a/home/docs/help/plugin.md b/home/docs/help/plugin.md index 7b397367e5d..4dabb13ebda 100644 --- a/home/docs/help/plugin.md +++ b/home/docs/help/plugin.md @@ -1,13 +1,17 @@ --- id: plugin -title: Custom plugin -sidebar_label: Custom plugin +title: Custom plugin(Beta) +sidebar_label: Custom plugin(Beta) --- ### Introduction In the current usage of `HertzBeat`, interaction with external systems only occurs after an alert through the notification feature. The plugin functionality allows users to add custom operations at various stages of the `HertzBeat` lifecycle, such as executing `SQL` or `shell` scripts after an alert, or sending collected monitoring data to other systems. Users can develop plugins following the custom plugin development process, package them, and then upload and enable them using the `Plugin Management` - `Upload Plugin` feature, thereby adding custom functionality without restarting `HertzBeat`. +:::warning +In the current version, custom plugins are a test feature and may have some limitations and instability. The plugin functionality might be restructured in future versions. +::: + ### Supported Plugin Types 1. `Post-Alert` Plugin diff --git a/home/i18n/en/docusaurus-plugin-content-docs/current.json b/home/i18n/en/docusaurus-plugin-content-docs/current.json index cba9a0fb8fe..c111a0d4aea 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/current.json +++ b/home/i18n/en/docusaurus-plugin-content-docs/current.json @@ -28,8 +28,8 @@ "description": "The label for category telnet in sidebar docs" }, "sidebar.docs.category.help": { - "message": "Help", - "description": "The label for category help in sidebar docs" + "message": "Guides", + "description": "The label for category guides in sidebar docs" }, "sidebar.docs.category.service": { "message": "Service Monitor", diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json index cf4e59a0470..2bac0e154f3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json @@ -27,9 +27,9 @@ "message": "TELNET协议", "description": "The label for category telnet in sidebar docs" }, - "sidebar.docs.category.help": { - "message": "帮助文档", - "description": "The label for category help in sidebar docs" + "sidebar.docs.category.guides": { + "message": "使用指南", + "description": "The label for category guides in sidebar docs" }, "sidebar.docs.category.service": { "message": "应用服务监控", diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md index eda39321341..20c4e141f29 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md @@ -1,7 +1,7 @@ --- id: plugin -title: 自定义插件 -sidebar_label: 自定义插件 +title: 自定义插件(Beta) +sidebar_label: 自定义插件(Beta) --- ### 简介 @@ -9,6 +9,10 @@ sidebar_label: 自定义插件 当前`HertzBeat`在使用中，只有在告警后通过通知功能与外部系统产生交互，插件功能支持让用户在 `HertzBeat` 生命周期的各个阶段增加自定义操作。如在告警后执行`sql`、`shell`脚本等操作，在采集到监控数据后发送到其他的系统等。 用户按照自定义插件的流程开发插件并打包后，将打包后的文件通过 `插件管理` - `上传插件` 功能，上传并启用插件即可在不重启`HertzBeat`的情况下增加自定义功能。 +:::warning +在当前版本中,自定义插件作为一个测试功能,可能会有一些限制和不稳定性,后续版本可能会重构插件功能。` +::: + ### 支持的插件类型 1. `Post-Alert`插件 diff --git a/home/sidebars.json b/home/sidebars.json index 25c730e05f4..23ea39c666c 100755 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -68,109 +68,7 @@ }, { "type": "category", - "label": "custom", - "items": [ - "advanced/extend-point", - "advanced/extend-tutorial", - { - "type": "category", - "label": "http", - "items": [ - "advanced/extend-http", - "advanced/extend-http-default", - "advanced/extend-http-jsonpath", - "advanced/extend-http-example-hertzbeat", - "advanced/extend-http-example-token" - ] - }, - { - "type": "category", - "label": "jdbc", - "items": [ - "advanced/extend-jdbc" - ] - }, - { - "type": "category", - "label": "ssh", - "items": [ - "advanced/extend-ssh" - ] - }, - { - "type": "category", - "label": "telnet", - "items": [ - "advanced/extend-telnet" - ] - }, - { - "type": "category", - "label": "jmx", - "items": [ - "advanced/extend-jmx" - ] - }, - { - "type": "category", - "label": "snmp", - "items": [ - "advanced/extend-snmp" - ] - }, - { - "type": "category", - "label": "NGQL", - "items": [ - "advanced/extend-ngql" - ] - } - ] - }, - { - "type": "doc", - "id": "template" - }, - { - "type": "category", - "label": "Community", - "items": [ - "community/contact", - "community/development", - { - "type": "category", - "label": "contribution", - "items": [ - "community/contribution", - "community/mailing_lists", - "community/become_committer", - "community/become_pmc_member", - "community/new_committer_process", - "community/new_pmc_ember_process" - ] - }, - { - "type": "category", - "label": "submit", - "items": [ - "community/document", - "community/submit_code", - "community/code_style_and_quality_guide" - ] - }, - { - "type": "category", - "label": "release", - "items": [ - "community/how_to_release", - "community/how_to_verify_release" - ] - } - ] - }, - { - "type": "category", - "label": "help", + "label": "guides", "items": [ "help/guide", "help/prometheus", @@ -384,6 +282,108 @@ "help/issue" ] }, + { + "type": "category", + "label": "custom", + "items": [ + "advanced/extend-point", + "advanced/extend-tutorial", + { + "type": "category", + "label": "http", + "items": [ + "advanced/extend-http", + "advanced/extend-http-default", + "advanced/extend-http-jsonpath", + "advanced/extend-http-example-hertzbeat", + "advanced/extend-http-example-token" + ] + }, + { + "type": "category", + "label": "jdbc", + "items": [ + "advanced/extend-jdbc" + ] + }, + { + "type": "category", + "label": "ssh", + "items": [ + "advanced/extend-ssh" + ] + }, + { + "type": "category", + "label": "telnet", + "items": [ + "advanced/extend-telnet" + ] + }, + { + "type": "category", + "label": "jmx", + "items": [ + "advanced/extend-jmx" + ] + }, + { + "type": "category", + "label": "snmp", + "items": [ + "advanced/extend-snmp" + ] + }, + { + "type": "category", + "label": "NGQL", + "items": [ + "advanced/extend-ngql" + ] + } + ] + }, + { + "type": "doc", + "id": "template" + }, + { + "type": "category", + "label": "Community", + "items": [ + "community/contact", + "community/development", + { + "type": "category", + "label": "contribution", + "items": [ + "community/contribution", + "community/mailing_lists", + "community/become_committer", + "community/become_pmc_member", + "community/new_committer_process", + "community/new_pmc_ember_process" + ] + }, + { + "type": "category", + "label": "submit", + "items": [ + "community/document", + "community/submit_code", + "community/code_style_and_quality_guide" + ] + }, + { + "type": "category", + "label": "release", + "items": [ + "community/how_to_release", + "community/how_to_verify_release" + ] + } + ] + }, { "type": "category", "label": "Template Marketplace", From 509a9c96517cb7789f77c8f4db51c042e901fe09 Mon Sep 17 00:00:00 2001 From: tomsun28 Date: Tue, 26 Nov 2024 19:28:39 +0800 Subject: [PATCH 2/2] [fix] bugfix flyway location can not auto detect vendor when not h2 (#2835) --- .../docker-compose/hertzbeat-mysql-iotdb/conf/application.yml | 2 +- .../hertzbeat-mysql-tdengine/conf/application.yml | 2 +- .../hertzbeat-mysql-victoria-metrics/conf/application.yml | 2 +- .../hertzbeat-postgresql-victoria-metrics/conf/application.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/script/docker-compose/hertzbeat-mysql-iotdb/conf/application.yml b/script/docker-compose/hertzbeat-mysql-iotdb/conf/application.yml index c0f58018a63..7f27eac2109 100644 --- a/script/docker-compose/hertzbeat-mysql-iotdb/conf/application.yml +++ b/script/docker-compose/hertzbeat-mysql-iotdb/conf/application.yml @@ -88,7 +88,7 @@ spring: baseline-on-migrate: true baseline-version: 1 locations: - - classpath:db/migration/{vendor} + - classpath:db/migration/mysql # Not Require, Please config if you need email notify # 非必填：不使用邮箱作为警告通知可以去掉spring.mail配置 diff --git a/script/docker-compose/hertzbeat-mysql-tdengine/conf/application.yml b/script/docker-compose/hertzbeat-mysql-tdengine/conf/application.yml index 459e0d2ca5c..8beb7f69828 100644 --- a/script/docker-compose/hertzbeat-mysql-tdengine/conf/application.yml +++ b/script/docker-compose/hertzbeat-mysql-tdengine/conf/application.yml @@ -88,7 +88,7 @@ spring: baseline-on-migrate: true baseline-version: 1 locations: - - classpath:db/migration/{vendor} + - classpath:db/migration/mysql # Not Require, Please config if you need email notify # 非必填：不使用邮箱作为警告通知可以去掉spring.mail配置 diff --git a/script/docker-compose/hertzbeat-mysql-victoria-metrics/conf/application.yml b/script/docker-compose/hertzbeat-mysql-victoria-metrics/conf/application.yml index 86132477c36..f006f39e08f 100644 --- a/script/docker-compose/hertzbeat-mysql-victoria-metrics/conf/application.yml +++ b/script/docker-compose/hertzbeat-mysql-victoria-metrics/conf/application.yml @@ -88,7 +88,7 @@ spring: baseline-on-migrate: true baseline-version: 1 locations: - - classpath:db/migration/{vendor} + - classpath:db/migration/mysql # Not Require, Please config if you need email notify # 非必填：不使用邮箱作为警告通知可以去掉spring.mail配置 diff --git a/script/docker-compose/hertzbeat-postgresql-victoria-metrics/conf/application.yml b/script/docker-compose/hertzbeat-postgresql-victoria-metrics/conf/application.yml index 86d662add16..a3a9180c720 100644 --- a/script/docker-compose/hertzbeat-postgresql-victoria-metrics/conf/application.yml +++ b/script/docker-compose/hertzbeat-postgresql-victoria-metrics/conf/application.yml @@ -87,7 +87,7 @@ spring: baseline-on-migrate: true baseline-version: 1 locations: - - classpath:db/migration/{vendor} + - classpath:db/migration/postgresql # Not Require, Please config if you need email notify # 非必填：不使用邮箱作为警告通知可以去掉spring.mail配置