diff --git a/.all-contributorsrc b/.all-contributorsrc index eb295b4a8e1..6afe40153b2 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1889,6 +1889,33 @@ "contributions": [ "doc" ] + }, + { + "login": "yykaue", + "name": "Limbo", + "avatar_url": "https://avatars.githubusercontent.com/u/22905143?v=4", + "profile": "https://github.com/yykaue", + "contributions": [ + "code" + ] + }, + { + "login": "irenhongyan", + "name": "哈哈哈哈哈哈哈哈哈", + "avatar_url": "https://avatars.githubusercontent.com/u/53438321?v=4", + "profile": "https://github.com/irenhongyan", + "contributions": [ + "code" + ] + }, + { + "login": "ileonli", + "name": "Leon Li", + "avatar_url": "https://avatars.githubusercontent.com/u/45332412?v=4", + "profile": "https://github.com/ileonli", + "contributions": [ + "code" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index 96a502d8fcf..6b4f0cf243f 100644 --- a/README.md +++ b/README.md @@ -446,6 +446,11 @@ Thanks to these wonderful people, welcome to join us: Bill Lau
Bill Lau
💻 lwyang
lwyang
📖 xfl12345
xfl12345
📖 + Limbo
Limbo
💻 + 哈哈哈哈哈哈哈哈哈
哈哈哈哈哈哈哈哈哈
💻 + + + Leon Li
Leon Li
💻 diff --git a/README_CN.md b/README_CN.md index e42adc95171..44f1c0a76dc 100644 --- a/README_CN.md +++ b/README_CN.md @@ -445,6 +445,11 @@ Thanks these wonderful people, welcome to join us: Bill Lau
Bill Lau
💻 lwyang
lwyang
📖 xfl12345
xfl12345
📖 + Limbo
Limbo
💻 + 哈哈哈哈哈哈哈哈哈
哈哈哈哈哈哈哈哈哈
💻 + + + Leon Li
Leon Li
💻 diff --git a/home/blog/2024-06-15-hertzbeat-v1.6.0.md b/home/blog/2024-06-15-hertzbeat-v1.6.0.md new file mode 100644 index 00000000000..4678774f9e4 --- /dev/null +++ b/home/blog/2024-06-15-hertzbeat-v1.6.0.md @@ -0,0 +1,395 @@ +--- +title: HertzBeat First Apache version v1.6.0 released now! +author: tom +author_title: tom +author_url: https://github.com/tomsun28 +author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 +tags: [opensource, practice] +keywords: [open source, monitoring, alerting] +--- + +**Hi guys, We are excited to announce that Apache HertzBeat (incubating) has released its first Apache version v1.6.0! 🎉.** + +Through nearly five months of community development iteration and two months of Apache Incubator incubation process, Apache HertzBeat (incubating) v1.6.0 is finally out. +In this version, we added monitoring for OpenAi, Redfish protocol servers, plugin mechanism, and support for NebulaGraph, Apache Yarn, HDFS, Hbase, Storm, and more functional features. +Due to license compatibility issues, we replaced multiple dependencies at the bottom layer, Hibernate -> EclipseLink, which is also a rare migration pitfall practice in the JPA ecosystem. +At the same time, some bugs were fixed and some functions were optimized, and more complete documents. Welcome everyone to try to use, put forward valuable opinions and suggestions, and promote the development of HertzBeat together. + + +**Of course, the most important thing is to give the best thanks to the contributors in the community!** + +Download Page: https://hertzbeat.apache.org/docs/download/ + +Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-update/ + +## What is HertzBeat? + +[Apache HertzBeat](https://github.com/apache/hertzbeat) (incubating) is an easy-to-use, open source, real-time monitoring system with agentless, high performance cluster, prometheus-compatible, offers powerful custom monitoring and status page building capabilities. + +## Features + +* Combines **monitoring, alarm, and notification** features into one platform, and supports monitoring for web service, program, database, cache, os, webserver, middleware, bigdata, cloud-native, network, custom and more. +* Easy to use and agentless, web-based and with one-click monitoring and alerting, zero learning curve. +* Makes protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, allowing you to collect any metrics by simply configuring the template `YML` file online. Imagine being able to quickly adapt to a new monitoring type like K8s or Docker simply by configuring online with HertzBeat. +* Compatible with the `Prometheus` ecosystem and more, can monitoring what `Prometheus` can monitoring with few clicks on webui. +* High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration. +* Provides flexible alarm threshold rules and timely notifications delivered via `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`. +* Provides powerful status page building capabilities, easily communicate the real-time status of your service to users. + +> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system. + +![hertzBeat](/img/docs/hertzbeat-arch.png) + +**Github: https://github.com/apache/hertzbeat** + +## HertzBeat's 1.6.0 Version Release! + +## Highlights +- HertzBeat is donated to the Apache Incubator. +- migrate repo, clean up code, license, add more help doc and more +- add dependency license doc +- [feature]Hertzbeat custom plugin. by @zqr10159 in #1973 +- [feature] add apache hugegraph monitor by @zhangshenghang in #1972 +- [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in #1966 +- [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in #1947 +- [feature] add apache yarn monitor by @zhangshenghang in #1937 +- [featrue]add apache hdfs monitor by @zhangshenghang in #1920 +- [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in #1917 +- [feature] support random jwt secret when not custom by @tomsun28 in #1897 +- feat Support Time Type to Tengine Data Storage by @Clownsw in #1890 +- [feature] support the VictoriaMetrics cluster by @xuziyang in #1880 +- [feature] support flyway database migration by @tomsun28 in #1875 +- [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in #1867 +- [feature] add influxdb metrics monitoring by @TJxiaobao in #1730 +- [improve] use apache jexl replace of aviator by @tomsun28 in #1859 +- [feature] Add Linux process monitoring by @zhangshenghang in #1857 +- [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in #1833 +- [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in #1801 +- [feature]Add monitoring for Hbase Master by @zhangshenghang in #1820 +- [feature] Improve the import checkstyle by @crossoverJie in #1802 +- [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in #1797 +- [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in #1783 +- [feature:update-checkstyle] Limit the java file header by @YxYL6125 in #1799 +- monitor center add search type modal by @tomsun28 in #1699 +- mongodb monitoring support custom connection timeout param by @ZY945 in #1697 +- System config theme by @TJxiaobao in #1636 +- [feature] add storm monitor by @starmilkxin in #1673 +- add a online prometheus parser and a prometheus-like push style. by @vinci-897 in #1644 +- and more bugfix, doc, features power by our contributors, thanks to them. + +## What's Changed +* bugfix collector can not startup alone by @tomsun28 in https://github.com/apache/hertzbeat/pull/1633 +* translate some hertzbeat blog by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1635 +* Check class description by @ZY945 in https://github.com/apache/hertzbeat/pull/1638 +* translate class description to english by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1641 +* support monitor metrics name i18n: ClickHouse by @ZY945 in https://github.com/apache/hertzbeat/pull/1642 +* translate blog 20220601 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1646 +* add a online prometheus parser and a prometheus-like push style. by @vinci-897 in https://github.com/apache/hertzbeat/pull/1644 +* translate blog 20220320 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1647 +* support monitor metrics name i18n: DynamicTp by @ZY945 in https://github.com/apache/hertzbeat/pull/1649 +* translate blog 20220228 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1648 +* translate blog 20220310 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1651 +* translate blog 20220904 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1652 +* support monitor metrics name i18n: Airflow by @ZY945 in https://github.com/apache/hertzbeat/pull/1654 +* support monitor metrics name i18n: IoTDB by @ZY945 in https://github.com/apache/hertzbeat/pull/1659 +* Translate 2022-02-11-hertzbeat document by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1660 +* bugfix The annotation @Transactional specifies rollbackFor. by @handy-git in https://github.com/apache/hertzbeat/pull/1643 +* add handy-git as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1661 +* feature:Translate 2022-02-17-hertzbeat Document by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1662 +* support monitor metrics name i18n: rocketmq by @ZY945 in https://github.com/apache/hertzbeat/pull/1663 +* [doc] update relate doc and readme by @tomsun28 in https://github.com/apache/hertzbeat/pull/1667 +* bugfix monitoring mongodb not work in springboot3 by @ZY945 in https://github.com/apache/hertzbeat/pull/1668 +* [feature] add storm monitor by @starmilkxin in https://github.com/apache/hertzbeat/pull/1673 +* [bugfix] fixed the issue in http_sd where services were incorrectly reported as available when they were actually unavailable by @starmilkxin in https://github.com/apache/hertzbeat/pull/1678 +* remove mysql-oracle dependency jar from release package lib by @tomsun28 in https://github.com/apache/hertzbeat/pull/1680 +* System config theme by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1636 +* update webapp menu layout and doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1682 +* bugfix can not find mysql dependency when startup by @tomsun28 in https://github.com/apache/hertzbeat/pull/1686 +* support config common aes secret by @tomsun28 in https://github.com/apache/hertzbeat/pull/1683 +* [bugfix]fix the issue of add redis cluster node test error report(#1601) by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1684 +* add LiuTianyou as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1687 +* mongodb monitoring support custom connection timeout param by @ZY945 in https://github.com/apache/hertzbeat/pull/1697 +* bugfix old data decode error when use new common-secret by @tomsun28 in https://github.com/apache/hertzbeat/pull/1696 +* [bugfix] fix bug where reopening pop-up window still retained previously edited data after closing. by @starmilkxin in https://github.com/apache/hertzbeat/pull/1698 +* monitor center add search type modal by @tomsun28 in https://github.com/apache/hertzbeat/pull/1699 +* fix status page logo overflow by @tomsun28 in https://github.com/apache/hertzbeat/pull/1700 +* bugfix npe monitor jobid may be null by @tomsun28 in https://github.com/apache/hertzbeat/pull/1701 +* support custom main menus in monitor template by @tomsun28 in https://github.com/apache/hertzbeat/pull/1703 +* update home website doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1712 +* [Improve] change package group to org apache hertzbeat by @vinci-897 in https://github.com/apache/hertzbeat/pull/1724 +* [improve] initial license clean up by @tomsun28 in https://github.com/apache/hertzbeat/pull/1725 +* update manager and collector logback config(#1704) by @handy-git in https://github.com/apache/hertzbeat/pull/1723 +* fix(sec): upgrade com.h2database:h2 to by @WinterKi1ler in https://github.com/apache/hertzbeat/pull/1718 +* add WinterKi1ler as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1736 +* update asf branch protected check by @tomsun28 in https://github.com/apache/hertzbeat/pull/1738 +* [doc]Update star chart by @zqr10159 in https://github.com/apache/hertzbeat/pull/1737 +* [fixed] fixed click collector online offline button error by @miki-hmt in https://github.com/apache/hertzbeat/pull/1734 +* [improve] initial doc clean up by @tomsun28 in https://github.com/apache/hertzbeat/pull/1741 +* [Improvement]Support multiple receivers. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1731 +* [improvement]Add lisence. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1746 +* Backend LICENSE Initialize by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1744 +* Back-end dependency upgrade by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1743 +* [Improve] run hertzbeat in docker compose support dependen service condition by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1748 +* [bugfix] fix statuspage index exception by @makechoicenow in https://github.com/apache/hertzbeat/pull/1747 +* remove unlicensed dependency 'wolfy87 eventemitter' by @alpha951 in https://github.com/apache/hertzbeat/pull/1745 +* [improve] auto label when pr, update asf config by @tomsun28 in https://github.com/apache/hertzbeat/pull/1749 +* [improve] update asf config set required status checks context by @tomsun28 in https://github.com/apache/hertzbeat/pull/1751 +* [improve] home add apache info by @a-little-fool in https://github.com/apache/hertzbeat/pull/1740 +* [doc] Change e2e path by @crossoverJie in https://github.com/apache/hertzbeat/pull/1758 +* fix : ingress tls inoperative by @PeixyJ in https://github.com/apache/hertzbeat/pull/1760 +* [refactor] method improvement rationale by @dukbong in https://github.com/apache/hertzbeat/pull/1757 +* [improve] create disclaimer file, add incubating in describe by @tomsun28 in https://github.com/apache/hertzbeat/pull/1764 +* [improve] update new hertzbeat brand logo, update doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1761 +* Complete the code comment translation of the common module by @Hi-Mr-Wind in https://github.com/apache/hertzbeat/pull/1766 +* Remove unnecessary if-else statement. by @dukbong in https://github.com/apache/hertzbeat/pull/1770 +* [doc] remove and translate chinese to english in warehous by @xuziyang in https://github.com/apache/hertzbeat/pull/1773 +* Replace deprecated methods with builder pattern for RedisURI construction by @dukbong in https://github.com/apache/hertzbeat/pull/1772 +* remove and translate chinese to english in collector,script,push,remoting and manager module by @MananPoojara in https://github.com/apache/hertzbeat/pull/1774 +* Added the function of sending SMS messages through Alibaba Cloud. by @lwqzz in https://github.com/apache/hertzbeat/pull/1768 +* [improve]Add frontend license. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1776 +* [test] Add RedisSingleCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1784 +* [refactor] add override annotation by @handy-git in https://github.com/apache/hertzbeat/pull/1782 +* '[docs]bugfix: display syntax error of ipmi protocol' by @tomorrowshipyltm in https://github.com/apache/hertzbeat/pull/1793 +* [doc] translate alerter moudle code chinese to english by @tomsun28 in https://github.com/apache/hertzbeat/pull/1765 +* [refactor] database-related properties class, type changed to record by @xuziyang in https://github.com/apache/hertzbeat/pull/1786 +* Fix snmp template unit conversion problem by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1796 +* [doc] Add help documentation for clickhouse monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1798 +* [feature:update-checkstyle] Limit the java file header by @YxYL6125 in https://github.com/apache/hertzbeat/pull/1799 +* [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1783 +* [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in https://github.com/apache/hertzbeat/pull/1797 +* [doc] add team page in website by @alpha951 in https://github.com/apache/hertzbeat/pull/1800 +* [feature] Improve the import checkstyle by @crossoverJie in https://github.com/apache/hertzbeat/pull/1802 +* [doc] Add help document for dns monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1804 +* [improve] preventing NPE by @dukbong in https://github.com/apache/hertzbeat/pull/1808 +* [refactor] change the warehouse properties the type to record by @xuziyang in https://github.com/apache/hertzbeat/pull/1806 +* Refactor: upgrade syntax to jdk17(instanceof & switch) by @Calvin979 in https://github.com/apache/hertzbeat/pull/1807 +* [test] Add NginxCollect test by @crossoverJie in https://github.com/apache/hertzbeat/pull/1809 +* [website] update team page by @tomsun28 in https://github.com/apache/hertzbeat/pull/1803 +* [test] Add RedisClusterCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1789 +* [improve] Fix typo ReqStatusResponse by @crossoverJie in https://github.com/apache/hertzbeat/pull/1811 +* Comparing N objects for null with Assert.noNullElements(). by @dukbong in https://github.com/apache/hertzbeat/pull/1814 +* [doc] Add help document for elasticsearch monitoring and ftp monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1815 +* [doc] add help documentation for huawei switch monitoring by @Alanxtl in https://github.com/apache/hertzbeat/pull/1813 +* chore: upgrade the api-testing (e2e) to v0.0.16 by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1817 +* [Remove][Improve]Mail config by @zqr10159 in https://github.com/apache/hertzbeat/pull/1819 +* Remove and translate chinese to english in code by @dukbong in https://github.com/apache/hertzbeat/pull/1816 +* [feature]Add monitoring for Hbase Master by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1820 +* [doc] resolve code conflicts and coverage caused by pr(#1813) merge by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1821 +* [doc] Add help document for tidb and nacos monitoring by @Alanxtl in https://github.com/apache/hertzbeat/pull/1823 +* [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in https://github.com/apache/hertzbeat/pull/1801 +* [improve] Add whitespace checkstyle by @crossoverJie in https://github.com/apache/hertzbeat/pull/1824 +* [bugfix] dns monitoring template add query class parameter by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1825 +* [Refactor] Preventing Unnecessary Object Creation and Using Utility Methods by @dukbong in https://github.com/apache/hertzbeat/pull/1818 +* [doc]Add and modify Doris FE Chinese and English documentation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1828 +* [docs] Optimize: add help docs for UDP port & Springboot3 help doc by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1832 +* Code Simplification, Structure Changes, and Translation Work, Along with a Question by @dukbong in https://github.com/apache/hertzbeat/pull/1827 +* [doc] add help document for mongodb monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1834 +* [collector] fix: inverts the compareTo sort of MetricsCollect run queue by @Pzz-2021 in https://github.com/apache/hertzbeat/pull/1837 +* [doc]Doc add debian system by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1842 +* [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1833 +* [improve] Optimize websocket monitor by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1838 +* [refactor] Split the WarehouseProperties class by @xuziyang in https://github.com/apache/hertzbeat/pull/1830 +* [test] Add test for HttpsdImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1840 +* [fix] Fix the wrong comment by @xuziyang in https://github.com/apache/hertzbeat/pull/1843 +* [refactor] trans and use assert by @dukbong in https://github.com/apache/hertzbeat/pull/1841 +* [bugfix] modify the command in the mongodb monitoring template by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1844 +* [bigfix]Fix Debian system Top10 monitoring bug by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1846 +* [cleanup]Delete the corresponding Chinese comments by @hudongdong129 in https://github.com/apache/hertzbeat/pull/1847 +* [doc] translates chinese comment to english. by @dukbong in https://github.com/apache/hertzbeat/pull/1853 +* [doc] fix error and add help document for prometheus task by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1852 +* [feature] Add Linux process monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1857 +* [test] Add test for FtpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1856 +* [improve] use apache jexl replace of aviator by @tomsun28 in https://github.com/apache/hertzbeat/pull/1859 +* [bugfix] jpa data save logic repair by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1863 +* [feature] add influxdb metrics monitoring by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1730 +* [doc] add help document for rocketmq by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1874 +* [improve] Imporve checkstyle of test code. by @crossoverJie in https://github.com/apache/hertzbeat/pull/1864 +* [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1867 +* Fix debian monitoring template issue about process monitoring by @LLP2333 in https://github.com/apache/hertzbeat/pull/1868 +* [bugfix] centos Top10 shows missing one by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1870 +* [improve] add website apache incubator footer by @tomsun28 in https://github.com/apache/hertzbeat/pull/1860 +* [doc] update help document by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1861 +* [featurn] support flyway database migration by @tomsun28 in https://github.com/apache/hertzbeat/pull/1875 +* [improve] Delete the timestamp field in the class MetricFamily.Metric by @xuziyang in https://github.com/apache/hertzbeat/pull/1878 +* [improve] Use java.lang.AutoCloseable instead of CacheCloseable by @crossoverJie in https://github.com/apache/hertzbeat/pull/1879 +* [bugfix]Fix top10 process command. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1876 +* [feature] support the VictoriaMetrics cluster by @xuziyang in https://github.com/apache/hertzbeat/pull/1880 +* [improve] Refactor common cache code by @crossoverJie in https://github.com/apache/hertzbeat/pull/1881 +* Eliminate Unnecessary Unboxing and Generics by @handy-git in https://github.com/apache/hertzbeat/pull/1882 +* [bugfix][doc]Add kafka sidebar. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1883 +* [doc] I18n for monitoring template yml metrics by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1888 +* [refactor] StoreProperties is no longer useful, delete it by @xuziyang in https://github.com/apache/hertzbeat/pull/1887 +* bugfix statistical metrics data matching fails by @tomsun28 in https://github.com/apache/hertzbeat/pull/1884 +* [doc] add help doc for flink monitoring by @HeartLinked in https://github.com/apache/hertzbeat/pull/1893 +* [doc] add almalinux documentation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1892 +* [improve] Missing a generic by @crossoverJie in https://github.com/apache/hertzbeat/pull/1889 +* [bugfix] Fixed some metrics of Jexlespression not matching in Elasticsearch by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1894 +* feat(*): Support Time Type to Tengine Data Storage by @Clownsw in https://github.com/apache/hertzbeat/pull/1890 +* [feature] support random jwt secret when not custom by @tomsun28 in https://github.com/apache/hertzbeat/pull/1897 +* [doc] add opensuse doc by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1902 +* fix when manager restart, collect register error by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1896 +* [bugfix] fix can not use empty collection as query params in eclipselink by @tomsun28 in https://github.com/apache/hertzbeat/pull/1900 +* [doc] update doc add download page and pic by @tomsun28 in https://github.com/apache/hertzbeat/pull/1904 +* [test] Add test for UdpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1906 +* fix license by @yqxxgh in https://github.com/apache/hertzbeat/pull/1907 +* [improve] refactor code by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1901 +* [type:bugfix] fix customized menu invalid bug #1898 by @Aias00 in https://github.com/apache/hertzbeat/pull/1908 +* [type:bugfix] fix HTTP API bug #1895 by @Aias00 in https://github.com/apache/hertzbeat/pull/1909 +* [test] Add test for WebsocketCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1912 +* [doc] translates chinese comment to english. by @westboy in https://github.com/apache/hertzbeat/pull/1914 +* [doc] Add HIP document and template by @crossoverJie in https://github.com/apache/hertzbeat/pull/1913 +* [improve] clean up home webapp unused code by @tomsun28 in https://github.com/apache/hertzbeat/pull/1915 +* [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1917 +* [doc] Improve the Contribution Documentation. by @crossoverJie in https://github.com/apache/hertzbeat/pull/1918 +* [featrue]add apache hdfs monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1920 +* [doc] update hbase documentation description by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1921 +* [doc] Add documentation for nebulaGraph cluster monitoring and custom monitoring using NGQL, and clean up useless parameters by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1923 +* [test] Add test for TelnetCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1924 +* fix(*): fix TdEngine Init not found Database by @Clownsw in https://github.com/apache/hertzbeat/pull/1891 +* [doc] update contribution and add run-build guide by @tomsun28 in https://github.com/apache/hertzbeat/pull/1919 +* bugfix collector startup error can not find JdbcClient by @tomsun28 in https://github.com/apache/hertzbeat/pull/1925 +* [doc] add help document for freebsd monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1928 +* [refactoring] Split AbstractHistoryDataStorage class by @xuziyang in https://github.com/apache/hertzbeat/pull/1926 +* [fix] fixed name error in monitoring template and improve NGQL protocol by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1931 +* [refactoring] Split AbstractRealTimeDataStorage class by @xuziyang in https://github.com/apache/hertzbeat/pull/1935 +* [bugfix] fix ssl-cert days_remaining and npe by @tomsun28 in https://github.com/apache/hertzbeat/pull/1934 +* [feature] add apache yarn monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1937 +* [doc] add help document for redhat monitoring and rocky linux monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1939 +* [test] Add test for NtpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1940 +* [bugfix] fix alarm center tags display error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1938 +* [improve] prepare for release hertzbeat v1.6.0 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1929 +* add:Updated the Open Source Summer Project blog. by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1943 +* [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1947 +* [refactoring] Inject a single instance of the data store by @xuziyang in https://github.com/apache/hertzbeat/pull/1944 +* [refactoring] AbstractHistoryDataStorage implement the DisposableBean by @xuziyang in https://github.com/apache/hertzbeat/pull/1946 +* [doc] update iotdb init document by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1948 +* [improve] update build script by @tomsun28 in https://github.com/apache/hertzbeat/pull/1949 +* [test] add test for NgqlCollectImpl by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1953 +* [bugfix]Replace monitors to alert. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1954 +* [improve] add llm, server menu and update doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1955 +* [improve][HIP] HIP-01: Refactoring AbstractCollect by @crossoverJie in https://github.com/apache/hertzbeat/pull/1930 +* [bugfix] fix ConnectionCommonCache possible npe by @crossoverJie in https://github.com/apache/hertzbeat/pull/1959 +* [doc] add help document for eulerOS monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1960 +* [fixbug] Fix the problem of no data for springboot3 monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1961 +* commit：fix the front-end popup cannot exit by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/1957 +* [fixbug] expression rule adaptation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1963 +* [doc] add help doc for influxdb-promql and kafka-promql monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1965 +* [doc]: update readme-cn docs by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1964 +* [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in https://github.com/apache/hertzbeat/pull/1966 +* [chore] update .gitignore to save .idea/icon.png by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1971 +* [improve][bugfix]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1969 +* [feature] add apache hugegraph monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1972 +* [improve] Implement cascading parameter list for SNMP protocol by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1976 +* [improve] optimize DateUtil and add test case by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1974 +* [feature]Hertzbeat custom plugin. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1973 +* update login page and status page color by @lwjxy in https://github.com/apache/hertzbeat/pull/1977 +* [chore] update code style and add some comment by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1975 +* [doc]Hertzbeat plugin doc. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1980 +* [doc] update contributors and update status page style by @tomsun28 in https://github.com/apache/hertzbeat/pull/1981 +* [feature] Implement cascading parameter list by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1978 +* [doc]update threshold alarm doc by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1983 +* [chore] optimize code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1984 +* [fix] Compatible with MongoDB versions earlier than 3.6 by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1988 +* [chore] optimize manager code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1993 +* [doc] Translate part of documentation development.md under `zh-cn` directory from `en` to `zh-cn` by @Thespica in https://github.com/apache/hertzbeat/pull/1995 +* [improve] http protocol prometheus parsing optimization by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1996 +* [feature] add at function for wechat by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/1994 +* [improve] add common util test by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2001 +* [improve] update release license notice and package by @tomsun28 in https://github.com/apache/hertzbeat/pull/2003 +* [bugfix] fix collector startup error classpath by @tomsun28 in https://github.com/apache/hertzbeat/pull/2004 +* [chore] optimize code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2000 +* [improve] Bump up `eslint-plugin-jsdoc` to 48.2.5 to support node 20+ by @Thespica in https://github.com/apache/hertzbeat/pull/2005 +* [doc] fix doc highlighting by @boatrainlsz in https://github.com/apache/hertzbeat/pull/2006 +* [web-app]feature: case insensitive search by @JavaProgrammerLB in https://github.com/apache/hertzbeat/pull/2007 +* [feature] Support time calculation expressions. by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2009 +* [doc] add document for time expression by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2012 +* [feature] Add Apache Pulsar monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2013 +* [doc] home verify release doc update by @tomsun28 in https://github.com/apache/hertzbeat/pull/2014 +* [Improve] Improve clickhouse monitor And Improve Pulsar monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2015 +* [doc] translate help document for memcached monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2019 +* [improve] optimize collector httpsd discovery by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1991 +* [optimize] optimize code style and logic, add unit test by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2010 +* [fix] Fix possible potential thread safe bugs by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/2021 +* [improve] add ci for home by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2024 +* [bugfix]Tag with empty value Shouldn't transform to Tag: by @JavaProgrammerLB in https://github.com/apache/hertzbeat/pull/2025 +* [bugfix] modify popup confirm to clear cache and cancel popup save by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/2026 +* [improve] update monitor state desc by @tomsun28 in https://github.com/apache/hertzbeat/pull/2028 +* bugfix: fix overflow of integers by @Calvin979 in https://github.com/apache/hertzbeat/pull/2029 +* [improve] tips need update initial default password by @tomsun28 in https://github.com/apache/hertzbeat/pull/2030 +* [improve] deprecate support iotdb 0.* version by @Ceilzcx in https://github.com/apache/hertzbeat/pull/2032 +* [fixbug] required field check by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2022 +* [improve] add IcmpCollectImplTest by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2033 +* [improve] fix code style by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2034 +* [improve] increase the length limit of the username field by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2035 +* [improve] Checkstyle include testSource by @crossoverJie in https://github.com/apache/hertzbeat/pull/2036 +* [bugfix] fix collector and frontend dependent license error by @tomsun28 in https://github.com/apache/hertzbeat/pull/2037 +* [improve] Add test for MemcachedCollectImpl by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2044 +* [imprve] Remove duplicate indices by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2045 +* [docs]: fix several typos in docs by @lw-yang in https://github.com/apache/hertzbeat/pull/2047 +* Add the missing parts of docs, fix layout, sync the English version with the Chinese version by @xfl12345 in https://github.com/apache/hertzbeat/pull/2048 +* [improve] add filename check in home ci by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2049 +* [improve] update dependency licenses and remove the aliyun sms depend by @tomsun28 in https://github.com/apache/hertzbeat/pull/2058 + +## New Contributors + +* @handy-git made their first contribution in https://github.com/apache/hertzbeat/pull/1643 +* @LiuTianyou made their first contribution in https://github.com/apache/hertzbeat/pull/1684 +* @WinterKi1ler made their first contribution in https://github.com/apache/hertzbeat/pull/1718 +* @miki-hmt made their first contribution in https://github.com/apache/hertzbeat/pull/1734 +* @gjjjj0101 made their first contribution in https://github.com/apache/hertzbeat/pull/1748 +* @makechoicenow made their first contribution in https://github.com/apache/hertzbeat/pull/1747 +* @alpha951 made their first contribution in https://github.com/apache/hertzbeat/pull/1745 +* @crossoverJie made their first contribution in https://github.com/apache/hertzbeat/pull/1758 +* @PeixyJ made their first contribution in https://github.com/apache/hertzbeat/pull/1760 +* @dukbong made their first contribution in https://github.com/apache/hertzbeat/pull/1757 +* @xuziyang made their first contribution in https://github.com/apache/hertzbeat/pull/1773 +* @MananPoojara made their first contribution in https://github.com/apache/hertzbeat/pull/1774 +* @lwqzz made their first contribution in https://github.com/apache/hertzbeat/pull/1768 +* @tomorrowshipyltm made their first contribution in https://github.com/apache/hertzbeat/pull/1793 +* @YxYL6125 made their first contribution in https://github.com/apache/hertzbeat/pull/1799 +* @15613060203 made their first contribution in https://github.com/apache/hertzbeat/pull/1797 +* @Alanxtl made their first contribution in https://github.com/apache/hertzbeat/pull/1813 +* @zhangshenghang made their first contribution in https://github.com/apache/hertzbeat/pull/1820 +* @zuobiao-zhou made their first contribution in https://github.com/apache/hertzbeat/pull/1832 +* @Pzz-2021 made their first contribution in https://github.com/apache/hertzbeat/pull/1837 +* @LLP2333 made their first contribution in https://github.com/apache/hertzbeat/pull/1868 +* @HeartLinked made their first contribution in https://github.com/apache/hertzbeat/pull/1893 +* @Aias00 made their first contribution in https://github.com/apache/hertzbeat/pull/1908 +* @westboy made their first contribution in https://github.com/apache/hertzbeat/pull/1914 +* @Yanshuming1 made their first contribution in https://github.com/apache/hertzbeat/pull/1957 +* @yuluo-yx made their first contribution in https://github.com/apache/hertzbeat/pull/1964 +* @lwjxy made their first contribution in https://github.com/apache/hertzbeat/pull/1977 +* @Thespica made their first contribution in https://github.com/apache/hertzbeat/pull/1995 +* @boatrainlsz made their first contribution in https://github.com/apache/hertzbeat/pull/2006 +* @JavaProgrammerLB made their first contribution in https://github.com/apache/hertzbeat/pull/2007 +* @lw-yang made their first contribution in https://github.com/apache/hertzbeat/pull/2047 +* @xfl12345 made their first contribution in https://github.com/apache/hertzbeat/pull/2048 + + +## Just one command to get started + +```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` + +```or use quay.io (if dockerhub network connect timeout)``` + +```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` + + +Detailed refer to HertzBeat Document https://hertzbeat.com/docs + + +---- + +**Github: https://github.com/apache/hertzbeat** + +Download Page: https://hertzbeat.apache.org/docs/download/ + +Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-update/ + +Have Fun! + +---- + +HertzBeat, Make Monitoring Easier! + +Apache HertzBeat Team diff --git a/home/docs/advanced/extend-http-default.md b/home/docs/advanced/extend-http-default.md index cb8cec5b7aa..abc9921e9ce 100644 --- a/home/docs/advanced/extend-http-default.md +++ b/home/docs/advanced/extend-http-default.md @@ -79,70 +79,199 @@ If there are multiple virtual machines, the multilayer format is: : **The corresponding monitoring template yml can be configured as follows** ```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring category: custom -# Monitoring application type(consistent with the file name) eg: linux windows tomcat mysql aws... -app: example +# The monitoring type eg: linux windows tomcat mysql aws... +app: a_example +# The monitoring i18n name name: - zh-CN: 模拟应用类型 + zh-CN: 模拟应用 en-US: EXAMPLE APP +# The description and help of this monitoring type +help: + zh-CN: HertzBeat 支持自定义监控，您只需配置监控模版 YML 就能适配一款自定义的监控类型。
定义流程如下：HertzBeat 页面 -> 监控模版菜单 -> 新增监控类型 -> 配置自定义监控模版YML -> 点击保存应用 -> 使用新监控类型添加监控。 + en-US: "HertzBeat supports custom monitoring, and you only need to configure the monitoring template YML to adapt to a custom monitoring type.
Definition process as follow: HertzBeat Pages -> Main Menu -> Monitor Template -> edit and save -> apply this template." + zh-TW: HertzBeat支持自定義監控，您只需配寘監控模版YML就能適配一款自定義的監控類型。
定義流程如下：HertzBeat頁面->監控模版選單->新增監控類型->配寘自定義監控模版YML ->點擊保存應用->使用新監控類型添加監控。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/advanced/extend-point/ + en-US: https://hertzbeat.apache.org/docs/advanced/extend-point/ +# Input params define for monitoring(render web ui by the definition) params: - # field-field name identifier + # field-param field key - field: host - # name-parameter field display name + # name-param field display i18n name name: - zh-CN: 主机Host - en-US: Host - # type-field type, style(most mappings are input label type attribute) + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) type: host - # required or not true-required false-optional + # required-true or false required: true + # field-param field key - field: port + # name-param field display i18n name name: zh-CN: 端口 en-US: Port + # type-param field type(most mapping the html input type) type: number - # When type is number, range is used to represent the range. + # when type is number, range is required range: '[0,65535]' + # required-true or false required: true - # port default + # default value defaultValue: 80 - # Prompt information of parameter input box - placeholder: 'Please enter the port' -# Metric group list + # param field input placeholder + placeholder: 'Please Input Port' + # field-param field key + - field: username + # name-param field display i18n name + name: + zh-CN: 用户名 + en-US: Username + # type-param field type(most mapping the html input type) + type: text + # when type is text, use limit to limit string length + limit: 50 + # required-true or false + required: false + # hide param-true or false + hide: true + # field-param field key + - field: password + # name-param field display i18n name + name: + zh-CN: 用户密码 + en-US: Password + # type-param field type(most mapping the html input tag) + type: password + # required-true or false + required: false + # hide param-true or false + hide: true + # field-param field key + - field: ssl + # name-param field display i18n name + name: + zh-CN: 启动SSL + en-US: SSL + # type-param field type(boolean mapping the html switch tag) + type: boolean + # required-true or false + required: false + # field-param field key + - field: method + # name-param field display i18n name + name: + zh-CN: 请求方式 + en-US: Method + # type-param field type(radio mapping the html radio tag) + type: radio + # required-true or false + required: true + # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2} + options: + - label: GET + value: GET + - label: POST + value: POST + - label: PUT + value: PUT + - label: DELETE + value: DELETE + # field-param field key + - field: headers + # name-param field display i18n name + name: + zh-CN: 请求Headers + en-US: Headers + # type-param field type(key-value mapping the html key-value input tags) + type: key-value + # required-true or false + required: false + # when type is key-value, use keyAlias to config key alias name + keyAlias: Header Name + # when type is key-value, use valueAlias to config value alias name + valueAlias: Header Value +# collect metrics config list metrics: -# The first monitoring Metric group cpu -# Note：the built-in monitoring Metrics have (responseTime - response time) + # metrics - cpu - name: cpu - # The smaller Metric group scheduling priority(0-127), the higher the priority. After completion of the high priority Metric group collection,the low priority Metric group will then be scheduled. Metric groups with the same priority will be scheduled in parallel. - # Metric group with a priority of 0 is an availability group which will be scheduled first. If the collection succeeds, the scheduling will continue otherwise interrupt scheduling. + # metrics name i18n label + i18n: + zh-CN: CPU 信息 + en-US: CPU Info + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue priority: 0 - # metrics fields list + # collect metrics content fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit + # field-metric name, i18n-metric name i18n label, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field - field: hostname type: 1 label: true + i18n: + zh-CN: 主机名称 + en-US: Host Name - field: usage type: 0 unit: '%' - - field: core + i18n: + zh-CN: 使用率 + en-US: Usage + - field: cores + type: 0 + i18n: + zh-CN: 核数 + en-US: Cores + - field: waitTime type: 0 -# protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk + unit: s + i18n: + zh-CN: 主机名称 + en-US: Host Name + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field + aliasFields: + - hostname + - core1 + - core2 + - usage + - allTime + - runningTime + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + calculates: + - hostname=hostname + - cores=core1+core2 + - usage=usage + - waitTime=allTime-runningTime + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: http -# Specific collection configuration when the protocol is HTTP protocol + # the config content when protocol is http http: - # host: ipv4 ipv6 domain name + # http host: ipv4 ipv6 domain host: ^_^host^_^ - # port + # http port port: ^_^port^_^ - # url request interface path + # http url url: /metrics/cpu - # request mode: GET POST PUT DELETE PATCH + # http method: GET POST PUT DELETE PATCH method: GET - # enable ssl/tls or not, that is to say, HTTP or HTTPS. The default is false + # if enabled https ssl: false - # parsing method for reponse data: default-system rules, jsonPath-jsonPath script, website-website availability Metric monitoring - # Hertzbeat default parsing is used here - parseType: default + # http request header content + headers: + ^_^headers^_^: ^_^headers^_^ + # http request params + params: + param1: param1 + param2: param2 + # http auth + authorization: + # http auth type: Basic Auth, Digest Auth, Bearer Token + type: Basic Auth + basicAuthUsername: ^_^username^_^ + basicAuthPassword: ^_^password^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: jsonPath + parseScript: '$' ``` diff --git a/home/docs/advanced/extend-http-example-hertzbeat.md b/home/docs/advanced/extend-http-example-hertzbeat.md index 4c65e29b8da..80ddd938506 100644 --- a/home/docs/advanced/extend-http-example-hertzbeat.md +++ b/home/docs/advanced/extend-http-example-hertzbeat.md @@ -74,39 +74,34 @@ Here we define a custom monitoring type `app` named `hertzbeat` which use the HT ```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring category: custom # The monitoring type eg: linux windows tomcat mysql aws... app: hertzbeat -# The monitoring i18n name name: - zh-CN: HertzBeat监控系统 - en-US: HertzBeat Monitor -# Input params define for monitoring(render web ui by the definition) + zh-CN: HertzBeat + en-US: HertzBeat +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 Hertzbeat 监控系统的通用指标进行测量监控。
您可以点击 “新建 HertzBeat监控系统” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor through general performance metric. You could click the "New HertzBeat Monitor" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對Hertzbeat監控系統的通用名額進行量測監控。
您可以點擊“新建HertzBeat監控系統”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat params: - # field-param field key - field: host - # name-param field display i18n name name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) + zh-CN: 目标Host + en-US: Target Host type: host - # required-true or false required: true - # field-param field key - field: port - # name-param field display i18n name name: zh-CN: 端口 en-US: Port - # type-param field type(most mapping the html input type) type: number - # when type is number, range is required range: '[0,65535]' - # required-true or false required: true - # default value defaultValue: 1157 - field: ssl name: @@ -157,7 +152,7 @@ metrics: priority: 0 # collect metrics content fields: - # metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB') + # metrics content contains field-metric name, type-metric type:0-number,1-string, instance-if is metrics, unit-metric unit('%','ms','MB') - field: app type: 1 label: true @@ -173,7 +168,7 @@ metrics: protocol: http # the config content when protocol is http http: - # http host: ipv4 ipv6 domain + # host: ipv4 ipv6 domain host: ^_^host^_^ # http port port: ^_^port^_^ diff --git a/home/docs/advanced/extend-http-example-token.md b/home/docs/advanced/extend-http-example-token.md index b9bbb61e72d..6cc09b6065c 100644 --- a/home/docs/advanced/extend-http-example-token.md +++ b/home/docs/advanced/extend-http-example-token.md @@ -52,60 +52,66 @@ A monitoring configuration definition file named after the monitoring type - her We directly reuse the definition content in `hertzbeat` and modify it to our current monitoring type `hertzbeat_auth` configuration parameters, such as `app, category, etc`. ```yaml -# This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring category: custom -# Monitoring application type (consistent with the file name) eg: linux windows tomcat mysql aws... +# The monitoring type eg: linux windows tomcat mysql aws... app: hertzbeat_token +# The monitoring i18n name name: - en-GB: HertzBeat Monitoring (Token) - en-US: Hertz Beat Monitor (Token) + zh-CN: HertzBeat(Token) + en-US: HertzBeat(Token) +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 HertzBeat监控(Token)进行测量监控。
您可以点击 “新建 HertzBeat监控(Token)” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor(Token). You could click the "New HertzBeat Monitor(Token)" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對HertzBeat監控（Token）進行量測監控。
您可以點擊“新建HertzBeat監控（Token）”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat_token + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat_token +# Input params define for monitoring(render web ui by the definition) params: - # field - field name identifier - - field: host - # name - parameter field display name - name: - en-CN: Host Host - en-US: Host - # type-field type, style (mostly map input tag type attribute) - type: host - # Whether it is a required item true-required false-optional - required: true - - field: port - name: - en-CN: port - en-US: Port - type: number - # When the type is number, use range to represent the range - range: '[0,65535]' - required: true - # port default - defaultValue: 1157 - # Parameter input box prompt information - placeholder: 'Please enter the port' - - field: ssl - name: - en-CN: Enable SSL - en-US: SSL - # When the type is boolean, the front end uses switch to display the switch - type: boolean - required: false - - field: contentType - name: - en-CN: Content-Type - en-US: Content-Type - type: text - placeholder: 'Request Body Type' - required: false - - field: payload - name: - en-CN: request BODY - en-US: BODY - type: textarea - placeholder: 'Available When POST PUT' - required: false -# Index group list configuration under todo -metrics: .... - + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + - field: port + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,65535]' + required: true + defaultValue: 1157 + placeholder: 'Please input port' + - field: ssl + name: + zh-CN: 启动SSL + en-US: SSL + # type-param field type(boolean mapping the html switch tag) + type: boolean + required: false + - field: contentType + name: + zh-CN: Content-Type + en-US: Content-Type + type: text + placeholder: 'Request Body Type' + required: false + - field: payload + name: + zh-CN: 请求BODY + en-US: BODY + type: textarea + placeholder: 'Available When POST PUT' + required: false +# collect metrics config list ``` ### Define metrics `auth` login request to get `token` @@ -114,92 +120,105 @@ metrics: .... ```yaml -# This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring category: custom -# Monitoring application type (consistent with the file name) eg: linux windows tomcat mysql aws... +# The monitoring type eg: linux windows tomcat mysql aws... app: hertzbeat_token +# The monitoring i18n name name: - en-GB: HertzBeat Monitoring (Token) - en-US: Hertz Beat Monitor (Token) + zh-CN: HertzBeat(Token) + en-US: HertzBeat(Token) +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 HertzBeat监控(Token)进行测量监控。
您可以点击 “新建 HertzBeat监控(Token)” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor(Token). You could click the "New HertzBeat Monitor(Token)" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對HertzBeat監控（Token）進行量測監控。
您可以點擊“新建HertzBeat監控（Token）”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat_token + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat_token +# Input params define for monitoring(render web ui by the definition) params: - # field - field name identifier - - field: host - # name - parameter field display name - name: - en-CN: Host Host - en-US: Host - # type-field type, style (mostly map input tag type attribute) - type: host - # Whether it is a required item true-required false-optional - required: true - - field: port - name: - en-CN: port - en-US: Port - type: number - # When the type is number, use range to represent the range - range: '[0,65535]' - required: true - # port default - defaultValue: 1157 - # Parameter input box prompt information - placeholder: 'Please enter the port' - - field: ssl - name: - en-CN: Enable SSL - en-US: SSL - # When the type is boolean, the front end uses switch to display the switch - type: boolean - required: false - - field: contentType - name: - en-CN: Content-Type - en-US: Content-Type - type: text - placeholder: 'Request Body Type' - required: false - - field: payload - name: - en-CN: request BODY - en-US: BODY - type: textarea - placeholder: 'Available When POST PUT' - required: false -# List of metricss + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + - field: port + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,65535]' + required: true + defaultValue: 1157 + placeholder: 'Please input port' + - field: ssl + name: + zh-CN: 启动SSL + en-US: SSL + # type-param field type(boolean mapping the html switch tag) + type: boolean + required: false + - field: contentType + name: + zh-CN: Content-Type + en-US: Content-Type + type: text + placeholder: 'Request Body Type' + required: false + - field: payload + name: + zh-CN: 请求BODY + en-US: BODY + type: textarea + placeholder: 'Available When POST PUT' + required: false +# collect metrics config list metrics: - # The first monitoring index group auth - # Note: Built-in monitoring metrics have (responseTime - response time) - - name: auth - # The smaller the index group scheduling priority (0-127), the higher the priority, and the index group with low priority will not be scheduled until the collection of index groups with high priority is completed, and the index groups with the same priority will be scheduled and collected in parallel - # The metrics with priority 0 is the availability metrics, that is, it will be scheduled first, and other metricss will continue to be scheduled if the collection is successful, and the scheduling will be interrupted if the collection fails - priority: 0 - # Specific monitoring metrics in the metrics - fields: - # metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit - - field: token - type: 1 - - field: refreshToken - type: 1 - # Monitoring and collection protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http - # When the protocol is the http protocol, the specific collection configuration - http: - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /api/account/auth/form - # Request method GET POST PUT DELETE PATCH - method: POST - # Whether to enable ssl/tls, that is, http or https, default false - ssl: ^_^ssl^_^ - payload: ^_^payload^_^ - # request header content - headers: - content-type: ^_^contentType^_^ - # Response data analysis method: default-system rules, jsonPath-jsonPath script, website-website usability metric monitoring - parseType: jsonPath - parseScript: '$.data' + # metrics - auth + - name: auth + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + # collect metrics content + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field + - field: token + type: 1 + - field: refreshToken + type: 1 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url + url: /api/account/auth/form + # http method: GET POST PUT DELETE PATCH + method: POST + # if enabled https + ssl: ^_^ssl^_^ + payload: ^_^payload^_^ + # http request header content + headers: + content-type: ^_^contentType^_^ + ^_^headers^_^: ^_^headers^_^ + # http request params + params: + ^_^params^_^: ^_^params^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: jsonPath + parseScript: '$.data' + ``` @@ -244,134 +263,133 @@ metrics: ```yaml -# This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring category: custom -# Monitoring application type (consistent with the file name) eg: linux windows tomcat mysql aws... +# The monitoring type eg: linux windows tomcat mysql aws... app: hertzbeat_token +# The monitoring i18n name name: - en-GB: HertzBeat Monitoring (Token) - en-US: Hertz Beat Monitor (Token) + zh-CN: HertzBeat(Token) + en-US: HertzBeat(Token) +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 HertzBeat监控(Token)进行测量监控。
您可以点击 “新建 HertzBeat监控(Token)” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor(Token). You could click the "New HertzBeat Monitor(Token)" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對HertzBeat監控（Token）進行量測監控。
您可以點擊“新建HertzBeat監控（Token）”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat_token + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat_token +# Input params define for monitoring(render web ui by the definition) params: - # field - field name identifier - - field: host - # name - parameter field display name - name: - en-CN: Host Host - en-US: Host - # type-field type, style (mostly map input tag type attribute) - type: host - # Whether it is a required item true-required false-optional - required: true - - field: port - name: - en-CN: port - en-US: Port - type: number - # When the type is number, use range to represent the range - range: '[0,65535]' - required: true - # port default - defaultValue: 1157 - # Parameter input box prompt information - placeholder: 'Please enter the port' - - field: ssl - name: - en-CN: Enable SSL - en-US: SSL - # When the type is boolean, the front end uses switch to display the switch - type: boolean - required: false - - field: contentType - name: - en-CN: Content-Type - en-US: Content-Type - type: text - placeholder: 'Request Body Type' - required: false - - field: payload - name: - en-CN: request BODY - en-US: BODY - type: textarea - placeholder: 'Available When POST PUT' - required: false -# List of metricss + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + - field: port + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,65535]' + required: true + defaultValue: 1157 + placeholder: 'Please input port' + - field: ssl + name: + zh-CN: 启动SSL + en-US: SSL + # type-param field type(boolean mapping the html switch tag) + type: boolean + required: false + - field: contentType + name: + zh-CN: Content-Type + en-US: Content-Type + type: text + placeholder: 'Request Body Type' + required: false + - field: payload + name: + zh-CN: 请求BODY + en-US: BODY + type: textarea + placeholder: 'Available When POST PUT' + required: false +# collect metrics config list metrics: -# The first monitoring index group cpu -# Note: Built-in monitoring metrics have (responseTime - response time) - - name: auth - # The smaller the index group scheduling priority (0-127), the higher the priority, and the index group with low priority will not be scheduled until the collection of index groups with high priority is completed, and the index groups with the same priority will be scheduled and collected in parallel - # The metrics with priority 0 is the availability metrics, that is, it will be scheduled first, and other metricss will continue to be scheduled if the collection is successful, and the scheduling will be interrupted if the collection fails - priority: 0 - # Specific monitoring metrics in the metrics - fields: - # metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit - - field: token - type: 1 - - field: refreshToken - type: 1 - # Monitoring and collection protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http - # When the protocol is the http protocol, the specific collection configuration - http: - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /api/account/auth/form - # Request method GET POST PUT DELETE PATCH - method: POST - # Whether to enable ssl/tls, that is, http or https, default false - ssl: ^_^ssl^_^ - payload: ^_^payload^_^ - # request header content - headers: - content-type: ^_^contentType^_^ - ^_^headers^_^: ^_^headers^_^ - # Request parameter content - params: - ^_^params^_^: ^_^params^_^ - # Response data analysis method: default-system rules, jsonPath-jsonPath script, website-website usability metric monitoring - parseType: jsonPath - parseScript: '$.data' - - - - name: summary - # The smaller the index group scheduling priority (0-127), the higher the priority, and the index group with low priority will not be scheduled until the collection of index groups with high priority is completed, and the index groups with the same priority will be scheduled and collected in parallel - # The metrics with priority 0 is the availability metrics, that is, it will be scheduled first, and other metricss will continue to be scheduled if the collection is successful, and the scheduling will be interrupted if the collection fails - priority: 1 - # Specific monitoring metrics in the metrics - fields: - # metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit - - field: category - type: 1 - - field: app - type: 1 - - field: size - type: 0 - - field: status - type: 0 -# Monitoring and collection protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# When the protocol is the http protocol, the specific collection configuration - http: - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /api/summary - # Request method GET POST PUT DELETE PATCH - method: GET - # Whether to enable ssl/tls, that is, http or https, default false - ssl: ^_^ssl^_^ - # authentication - authorization: - # Authentication methods: Basic Auth, Digest Auth, Bearer Token - type: Bearer Token - bearerTokenToken: ^o^token^o^ - # Response data analysis method: default-system rules, jsonPath-jsonPath script, website-website usability metric monitoring - parseType: jsonPath - parseScript: '$.data.apps.*' + # metrics - auth + - name: auth + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + # collect metrics content + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field + - field: token + type: 1 + - field: refreshToken + type: 1 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url + url: /api/account/auth/form + # http method: GET POST PUT DELETE PATCH + method: POST + # if enabled https + ssl: ^_^ssl^_^ + payload: ^_^payload^_^ + # http request header content + headers: + content-type: ^_^contentType^_^ + ^_^headers^_^: ^_^headers^_^ + # http request params + params: + ^_^params^_^: ^_^params^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: jsonPath + parseScript: '$.data' + + + - name: summary + priority: 1 + fields: + - field: app + type: 1 + label: true + - field: category + type: 1 + - field: status + type: 0 + - field: size + type: 0 + - field: availableSize + type: 0 + protocol: http + http: + host: ^_^host^_^ + port: ^_^port^_^ + url: /api/summary + method: GET + ssl: ^_^ssl^_^ + authorization: + type: Bearer Token + # ^o^xxx^o^ ^o^ substitution represents the value of the acquisition metric xxx of the previous priority + bearerTokenToken: ^o^token^o^ + parseType: jsonPath + parseScript: '$.data.apps.*' ``` diff --git a/home/docs/advanced/extend-http.md b/home/docs/advanced/extend-http.md index 242b63e8cf0..4df5fce33b0 100644 --- a/home/docs/advanced/extend-http.md +++ b/home/docs/advanced/extend-http.md @@ -39,94 +39,156 @@ eg：Define a custom monitoring type `app` named `example_http` which use the HT ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring category: custom -# Monitoring application type(consistent with the file name) eg: linux windows tomcat mysql aws... -app: example_http +# The monitoring type eg: linux windows tomcat mysql aws... +app: a_example +# The monitoring i18n name name: - zh-CN: 模拟应用类型 + zh-CN: 模拟应用 en-US: EXAMPLE APP +# The description and help of this monitoring type +help: + zh-CN: HertzBeat 支持自定义监控，您只需配置监控模版 YML 就能适配一款自定义的监控类型。
定义流程如下：HertzBeat 页面 -> 监控模版菜单 -> 新增监控类型 -> 配置自定义监控模版YML -> 点击保存应用 -> 使用新监控类型添加监控。 + en-US: "HertzBeat supports custom monitoring, and you only need to configure the monitoring template YML to adapt to a custom monitoring type.
Definition process as follow: HertzBeat Pages -> Main Menu -> Monitor Template -> edit and save -> apply this template." + zh-TW: HertzBeat支持自定義監控，您只需配寘監控模版YML就能適配一款自定義的監控類型。
定義流程如下：HertzBeat頁面->監控模版選單->新增監控類型->配寘自定義監控模版YML ->點擊保存應用->使用新監控類型添加監控。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/advanced/extend-point/ + en-US: https://hertzbeat.apache.org/docs/advanced/extend-point/ +# Input params define for monitoring(render web ui by the definition) params: - # field-field name identifier + # field-param field key - field: host - # name-parameter field display name + # name-param field display i18n name name: - zh-CN: 主机Host - en-US: Host - # type-field type, style(most mappings are input label type attribute) + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) type: host - # required or not true-required false-optional + # required-true or false required: true + # field-param field key - field: port + # name-param field display i18n name name: zh-CN: 端口 en-US: Port + # type-param field type(most mapping the html input type) type: number - # When type is number, range is used to represent the range. + # when type is number, range is required range: '[0,65535]' + # required-true or false required: true - # port default + # default value defaultValue: 80 - # Prompt information of parameter input box - placeholder: 'Please enter the port' + # param field input placeholder + placeholder: 'Please Input Port' + # field-param field key - field: username + # name-param field display i18n name name: zh-CN: 用户名 en-US: Username + # type-param field type(most mapping the html input type) type: text - # When type is text, use limit to indicate the string limit size + # when type is text, use limit to limit string length limit: 50 + # required-true or false required: false + # hide param-true or false + hide: true + # field-param field key - field: password + # name-param field display i18n name name: - zh-CN: 密码 + zh-CN: 用户密码 en-US: Password + # type-param field type(most mapping the html input tag) type: password + # required-true or false required: false + # hide param-true or false + hide: true + # field-param field key - field: ssl + # name-param field display i18n name name: zh-CN: 启动SSL - en-US: Enable SSL - # When type is boolean, front end uses switch to show the switch + en-US: SSL + # type-param field type(boolean mapping the html switch tag) type: boolean + # required-true or false required: false + # field-param field key - field: method + # name-param field display i18n name name: zh-CN: 请求方式 en-US: Method + # type-param field type(radio mapping the html radio tag) type: radio + # required-true or false required: true - # When type is radio or checkbox, option indicates the list of selectable values {name1:value1,name2:value2} + # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2} options: - - label: GET request + - label: GET value: GET - - label: POST request + - label: POST value: POST - - label: PUT request + - label: PUT value: PUT - - label: DELETE request + - label: DELETE value: DELETE -# Metric group list + # field-param field key + - field: headers + # name-param field display i18n name + name: + zh-CN: 请求Headers + en-US: Headers + # type-param field type(key-value mapping the html key-value input tags) + type: key-value + # required-true or false + required: false + # when type is key-value, use keyAlias to config key alias name + keyAlias: Header Name + # when type is key-value, use valueAlias to config value alias name + valueAlias: Header Value +# collect metrics config list metrics: -# The first monitoring Metric group cpu -# Note：the built-in monitoring Metrics have (responseTime - response time) + # metrics - cpu - name: cpu - # The smaller Metric group scheduling priority(0-127), the higher the priority. After completion of the high priority Metric group collection,the low priority Metric group will then be scheduled. Metric groups with the same priority will be scheduled in parallel. - # Metric group with a priority of 0 is an availability group which will be scheduled first. If the collection succeeds, the scheduling will continue otherwise interrupt scheduling. + # metrics name i18n label + i18n: + zh-CN: CPU 信息 + en-US: CPU Info + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue priority: 0 - # metrics fields list + # collect metrics content fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit + # field-metric name, i18n-metric name i18n label, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field - field: hostname type: 1 label: true + i18n: + zh-CN: 主机名称 + en-US: Host Name - field: usage type: 0 unit: '%' + i18n: + zh-CN: 使用率 + en-US: Usage - field: cores type: 0 + i18n: + zh-CN: 核数 + en-US: Cores - field: waitTime type: 0 unit: s -# (optional)Monitoring Metric alias mapping to the Metric name above. The field used to collect interface data is not the final Metric name directly. This alias is required for mapping conversion. + i18n: + zh-CN: 主机名称 + en-US: Host Name + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field aliasFields: - hostname - core1 @@ -134,59 +196,73 @@ metrics: - usage - allTime - runningTime -# (optional)The Metric calculation expression works with the above alias to calculate the final required Metric value. -# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime calculates: - hostname=hostname - cores=core1+core2 - usage=usage - waitTime=allTime-runningTime -# protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: http -# Specific collection configuration when the protocol is HTTP protocol + # the config content when protocol is http http: - # host: ipv4 ipv6 domain name + # http host: ipv4 ipv6 domain host: ^_^host^_^ - # port + # http port port: ^_^port^_^ - # url request interface path + # http url url: /metrics/cpu - # request mode: GET POST PUT DELETE PATCH + # http method: GET POST PUT DELETE PATCH method: GET - # enable ssl/tls or not, that is to say, HTTP or HTTPS. The default is false + # if enabled https ssl: false - # request header content + # http request header content headers: - apiVersion: v1 - # request parameter content + ^_^headers^_^: ^_^headers^_^ + # http request params params: param1: param1 param2: param2 - # authorization + # http auth authorization: - # authorization method: Basic Auth, Digest Auth, Bearer Token + # http auth type: Basic Auth, Digest Auth, Bearer Token type: Basic Auth basicAuthUsername: ^_^username^_^ basicAuthPassword: ^_^password^_^ - # parsing method for reponse data: default-system rules, jsonPath-jsonPath script, website-website availability Metric monitoring - # todo xmlPath-xmlPath script, prometheus-Prometheus data rules + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule parseType: jsonPath parseScript: '$' - name: memory + i18n: + zh-CN: 内存信息 + en-US: Memory Info priority: 1 fields: - field: hostname type: 1 label: true + i18n: + zh-CN: 主机名称 + en-US: Hostname - field: total type: 0 unit: kb + i18n: + zh-CN: 总量 + en-US: Total - field: usage type: 0 unit: '%' + i18n: + zh-CN: 使用率 + en-US: Usage - field: speed type: 0 + i18n: + zh-CN: 速率 + en-US: Speed protocol: http http: host: ^_^host^_^ @@ -195,7 +271,6 @@ metrics: method: GET headers: apiVersion: v1 - # query params,support time expression params: param1: param1 param2: param2 @@ -204,4 +279,5 @@ metrics: basicAuthUsername: ^_^username^_^ basicAuthPassword: ^_^password^_^ parseType: default + ``` diff --git a/home/docs/advanced/extend-point.md b/home/docs/advanced/extend-point.md index eba1811e4fc..6fdbdd636b7 100644 --- a/home/docs/advanced/extend-point.md +++ b/home/docs/advanced/extend-point.md @@ -36,6 +36,14 @@ app: example2 name: zh-CN: 模拟网站监测 en-US: EXAMPLE WEBSITE +# The description and help of this monitoring type +help: + zh-CN: HertzBeat 支持自定义监控，您只需配置监控模版 YML 就能适配一款自定义的监控类型。
定义流程如下：HertzBeat 页面 -> 监控模版菜单 -> 新增监控类型 -> 配置自定义监控模版YML -> 点击保存应用 -> 使用新监控类型添加监控。 + en-US: "HertzBeat supports custom monitoring, and you only need to configure the monitoring template YML to adapt to a custom monitoring type.
Definition process as follow: HertzBeat Pages -> Main Menu -> Monitor Template -> edit and save -> apply this template." + zh-TW: HertzBeat支持自定義監控，您只需配寘監控模版YML就能適配一款自定義的監控類型。
定義流程如下：HertzBeat頁面->監控模版選單->新增監控類型->配寘自定義監控模版YML ->點擊保存應用->使用新監控類型添加監控。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/advanced/extend-point/ + en-US: https://hertzbeat.apache.org/docs/advanced/extend-point/ # Input params define for monitoring(render web ui by the definition) params: # field-param field key diff --git a/home/docs/advanced/extend-tutorial.md b/home/docs/advanced/extend-tutorial.md index 9f21219a29f..03b73707789 100644 --- a/home/docs/advanced/extend-tutorial.md +++ b/home/docs/advanced/extend-tutorial.md @@ -82,6 +82,14 @@ app: hertzbeat name: zh-CN: HertzBeat监控系统 en-US: HertzBeat Monitor +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 Hertzbeat 监控系统的通用指标进行测量监控。
您可以点击 “新建 HertzBeat监控系统” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor through general performance metric. You could click the "New HertzBeat Monitor" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對Hertzbeat監控系統的通用名額進行量測監控。
您可以點擊“新建HertzBeat監控系統”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat # Input params define for monitoring(render web ui by the definition) params: # field-param field key diff --git a/home/docs/community/new_committer_process.md b/home/docs/community/new_committer_process.md index b72ec6e30b7..c09b2cc63e8 100644 --- a/home/docs/community/new_committer_process.md +++ b/home/docs/community/new_committer_process.md @@ -73,11 +73,35 @@ Subject: [VOTE] New committer: ${NEW_COMMITTER_NAME} ```text Hi HertzBeat PPMC, -This is a formal vote about inviting ${NEW_COMMITTER_NAME} as our new committer. +This is a formal vote about inviting ${NEW_COMMITTER_NAME} as our community new committer. -${Work list}[1] +Work list: https://github.com/apache/hertzbeat/commits?author=${NEW_COMMITTER_NAME} -[1] https://github.com/apache/hertzbeat/commits?author=${NEW_COMMITTER_NAME} +Here is the list of ${NEW_COMMITTER_NAME}'s contributions in HertzBeat Community: + +> [27 commits](https://github.com/apache/hertzbeat/commits?author=xxx) +> +> 7,495 ++ 627 -- + +Submitted PR (27 commits) +- [ISSUE #4534] [feature] add new feature in hertzbeat #3445 +- xxx + +Submitted Issues (18 commits) + +- [bug] find some bugs in hertzbeat nodes #6565 +- xxx + +Please vote: + ++1: I support this proposal and will welcome ${NEW_COMMITTER_NAME} as a committer. ++0: I don't care. +-1: I object to this proposal and here are my reasons. + +This vote will be open for at least 7 days. + +Best Wishes, +ttt ``` Note that, Voting ends one week from today, i.e. diff --git a/home/i18n/en/code.json b/home/i18n/en/code.json index bdc5f8f778a..4acd764d488 100644 --- a/home/i18n/en/code.json +++ b/home/i18n/en/code.json @@ -263,7 +263,7 @@ "message": "Makes protocols such as Http, Jmx, Ssh, Snmp, Jdbc configurable, you can collect any metrics by simply configuring the yml online. {br} High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration. {br} Flexible threshold rules and timely notifications delivered via discord slack email webhook more." }, "opensource-content": { - "message": "Apache HertzBeat (incubating)'s stand-alone and cluster version code are all open source, unlimited and anyone who are interested in it are very welcome to contribute. No matter how small the contribution is, whether it is a document code or a typo, we respect everyone and learn and grow together. {br} Hope that the code we participate in can be deployed to thousands of machines in this world.{github}" + "message": "Apache HertzBeat (incubating)'s stand-alone and cluster version code are all open source, unlimited and anyone who are interested in it are very welcome to contribute. No matter how small the contribution is, whether it is a document code or a typo, we respect everyone and learn and grow together. {br} Look forward our code to be deployed on thousands of machines worldwide.{github}" }, "slogan": { "message": "Open Source Real-time Monitoring System" diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md new file mode 100644 index 00000000000..41267f8f964 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md @@ -0,0 +1,397 @@ +--- +title: HertzBeat 的第一个 Apache 版本 v1.6.0 发布！ +author: tom +author_title: tom +author_url: https://github.com/tomsun28 +author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 +tags: [opensource, practice] +keywords: [open source, monitoring, alerting] +--- + +**Hi 朋友们，我们很高兴地宣布，Apache HertzBeat (incubating) 的了第一个Apache版本 v1.6.0 发布啦！🎉.** + +经过近五个月的社区开发迭代贡献和两个月的Apache Incubator孵化过程，Apache HertzBeat (incubating) v1.6.0 终于出来了。 +这个版本我们增加了对OpenAi监控，Redfish协议服务器，插件机制，支持了NebulaGraph, Apache Yarn, HDFS, Hbase, Storm等更多功能特性。 +由于License兼容问题，我们在底层替换了ORM框架，计算框架等多个依赖，Hibernate -> EclipseLink, 这也算是JPA生态下为数不多的迁移踩坑实践。 +同时修复了一些bug和优化了一些功能，更完善的文档。欢迎大家尝试使用，提出宝贵意见和建议，共同推动HertzBeat的发展。🎉 + +**当然，最重要的是给在社区的贡献者们致以最好的感谢！** + +下载页面: https://hertzbeat.apache.org/docs/download/ + +升级指南: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-update/ + +## 什么是 HertzBeat? + +[Apache HertzBeat](https://github.com/apache/hertzbeat) （incubating）是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。 + +### 特点 + +- 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web 服务器，云原生，网络，自定义等监控阈值告警通知一步到位。 +- 易用友好，无需 `Agent`，全 `WEB` 页面操作，鼠标点一点就能监控告警，零上手学习成本。 +- 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化，只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？ +- 兼容 `Prometheus` 的系统生态并且更多，只需页面操作就可以监控 `Prometheus` 所能监控的。 +- 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 +- 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 +- 提供强大的状态页构建能力，轻松向用户传达您产品服务的实时状态。 + + +> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助用户快速搭建自有监控系统。 + +![hertzBeat](/img/docs/hertzbeat-arch.png) + +**Github: https://github.com/apache/hertzbeat** + +## HertzBeat's 1.6.0 Version Release! + +## 亮点更新 + +- HertzBeat is donated to the Apache Incubator. +- migrate repo, clean up code, license, add more help doc and more +- add dependency license doc +- [feature]Hertzbeat custom plugin. by @zqr10159 in #1973 +- [feature] add apache hugegraph monitor by @zhangshenghang in #1972 +- [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in #1966 +- [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in #1947 +- [feature] add apache yarn monitor by @zhangshenghang in #1937 +- [featrue]add apache hdfs monitor by @zhangshenghang in #1920 +- [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in #1917 +- [feature] support random jwt secret when not custom by @tomsun28 in #1897 +- feat Support Time Type to Tengine Data Storage by @Clownsw in #1890 +- [feature] support the VictoriaMetrics cluster by @xuziyang in #1880 +- [feature] support flyway database migration by @tomsun28 in #1875 +- [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in #1867 +- [feature] add influxdb metrics monitoring by @TJxiaobao in #1730 +- [improve] use apache jexl replace of aviator by @tomsun28 in #1859 +- [feature] Add Linux process monitoring by @zhangshenghang in #1857 +- [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in #1833 +- [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in #1801 +- [feature]Add monitoring for Hbase Master by @zhangshenghang in #1820 +- [feature] Improve the import checkstyle by @crossoverJie in #1802 +- [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in #1797 +- [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in #1783 +- [feature:update-checkstyle] Limit the java file header by @YxYL6125 in #1799 +- monitor center add search type modal by @tomsun28 in #1699 +- mongodb monitoring support custom connection timeout param by @ZY945 in #1697 +- System config theme by @TJxiaobao in #1636 +- [feature] add storm monitor by @starmilkxin in #1673 +- add a online prometheus parser and a prometheus-like push style. by @vinci-897 in #1644 +- and more bugfix, doc, features power by our contributors, thanks to them. + +## What's Changed + +* bugfix collector can not startup alone by @tomsun28 in https://github.com/apache/hertzbeat/pull/1633 +* translate some hertzbeat blog by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1635 +* Check class description by @ZY945 in https://github.com/apache/hertzbeat/pull/1638 +* translate class description to english by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1641 +* support monitor metrics name i18n: ClickHouse by @ZY945 in https://github.com/apache/hertzbeat/pull/1642 +* translate blog 20220601 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1646 +* add a online prometheus parser and a prometheus-like push style. by @vinci-897 in https://github.com/apache/hertzbeat/pull/1644 +* translate blog 20220320 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1647 +* support monitor metrics name i18n: DynamicTp by @ZY945 in https://github.com/apache/hertzbeat/pull/1649 +* translate blog 20220228 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1648 +* translate blog 20220310 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1651 +* translate blog 20220904 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1652 +* support monitor metrics name i18n: Airflow by @ZY945 in https://github.com/apache/hertzbeat/pull/1654 +* support monitor metrics name i18n: IoTDB by @ZY945 in https://github.com/apache/hertzbeat/pull/1659 +* Translate 2022-02-11-hertzbeat document by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1660 +* bugfix The annotation @Transactional specifies rollbackFor. by @handy-git in https://github.com/apache/hertzbeat/pull/1643 +* add handy-git as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1661 +* feature:Translate 2022-02-17-hertzbeat Document by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1662 +* support monitor metrics name i18n: rocketmq by @ZY945 in https://github.com/apache/hertzbeat/pull/1663 +* [doc] update relate doc and readme by @tomsun28 in https://github.com/apache/hertzbeat/pull/1667 +* bugfix monitoring mongodb not work in springboot3 by @ZY945 in https://github.com/apache/hertzbeat/pull/1668 +* [feature] add storm monitor by @starmilkxin in https://github.com/apache/hertzbeat/pull/1673 +* [bugfix] fixed the issue in http_sd where services were incorrectly reported as available when they were actually unavailable by @starmilkxin in https://github.com/apache/hertzbeat/pull/1678 +* remove mysql-oracle dependency jar from release package lib by @tomsun28 in https://github.com/apache/hertzbeat/pull/1680 +* System config theme by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1636 +* update webapp menu layout and doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1682 +* bugfix can not find mysql dependency when startup by @tomsun28 in https://github.com/apache/hertzbeat/pull/1686 +* support config common aes secret by @tomsun28 in https://github.com/apache/hertzbeat/pull/1683 +* [bugfix]fix the issue of add redis cluster node test error report(#1601) by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1684 +* add LiuTianyou as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1687 +* mongodb monitoring support custom connection timeout param by @ZY945 in https://github.com/apache/hertzbeat/pull/1697 +* bugfix old data decode error when use new common-secret by @tomsun28 in https://github.com/apache/hertzbeat/pull/1696 +* [bugfix] fix bug where reopening pop-up window still retained previously edited data after closing. by @starmilkxin in https://github.com/apache/hertzbeat/pull/1698 +* monitor center add search type modal by @tomsun28 in https://github.com/apache/hertzbeat/pull/1699 +* fix status page logo overflow by @tomsun28 in https://github.com/apache/hertzbeat/pull/1700 +* bugfix npe monitor jobid may be null by @tomsun28 in https://github.com/apache/hertzbeat/pull/1701 +* support custom main menus in monitor template by @tomsun28 in https://github.com/apache/hertzbeat/pull/1703 +* update home website doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1712 +* [Improve] change package group to org apache hertzbeat by @vinci-897 in https://github.com/apache/hertzbeat/pull/1724 +* [improve] initial license clean up by @tomsun28 in https://github.com/apache/hertzbeat/pull/1725 +* update manager and collector logback config(#1704) by @handy-git in https://github.com/apache/hertzbeat/pull/1723 +* fix(sec): upgrade com.h2database:h2 to by @WinterKi1ler in https://github.com/apache/hertzbeat/pull/1718 +* add WinterKi1ler as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1736 +* update asf branch protected check by @tomsun28 in https://github.com/apache/hertzbeat/pull/1738 +* [doc]Update star chart by @zqr10159 in https://github.com/apache/hertzbeat/pull/1737 +* [fixed] fixed click collector online offline button error by @miki-hmt in https://github.com/apache/hertzbeat/pull/1734 +* [improve] initial doc clean up by @tomsun28 in https://github.com/apache/hertzbeat/pull/1741 +* [Improvement]Support multiple receivers. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1731 +* [improvement]Add lisence. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1746 +* Backend LICENSE Initialize by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1744 +* Back-end dependency upgrade by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1743 +* [Improve] run hertzbeat in docker compose support dependen service condition by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1748 +* [bugfix] fix statuspage index exception by @makechoicenow in https://github.com/apache/hertzbeat/pull/1747 +* remove unlicensed dependency 'wolfy87 eventemitter' by @alpha951 in https://github.com/apache/hertzbeat/pull/1745 +* [improve] auto label when pr, update asf config by @tomsun28 in https://github.com/apache/hertzbeat/pull/1749 +* [improve] update asf config set required status checks context by @tomsun28 in https://github.com/apache/hertzbeat/pull/1751 +* [improve] home add apache info by @a-little-fool in https://github.com/apache/hertzbeat/pull/1740 +* [doc] Change e2e path by @crossoverJie in https://github.com/apache/hertzbeat/pull/1758 +* fix : ingress tls inoperative by @PeixyJ in https://github.com/apache/hertzbeat/pull/1760 +* [refactor] method improvement rationale by @dukbong in https://github.com/apache/hertzbeat/pull/1757 +* [improve] create disclaimer file, add incubating in describe by @tomsun28 in https://github.com/apache/hertzbeat/pull/1764 +* [improve] update new hertzbeat brand logo, update doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1761 +* Complete the code comment translation of the common module by @Hi-Mr-Wind in https://github.com/apache/hertzbeat/pull/1766 +* Remove unnecessary if-else statement. by @dukbong in https://github.com/apache/hertzbeat/pull/1770 +* [doc] remove and translate chinese to english in warehous by @xuziyang in https://github.com/apache/hertzbeat/pull/1773 +* Replace deprecated methods with builder pattern for RedisURI construction by @dukbong in https://github.com/apache/hertzbeat/pull/1772 +* remove and translate chinese to english in collector,script,push,remoting and manager module by @MananPoojara in https://github.com/apache/hertzbeat/pull/1774 +* Added the function of sending SMS messages through Alibaba Cloud. by @lwqzz in https://github.com/apache/hertzbeat/pull/1768 +* [improve]Add frontend license. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1776 +* [test] Add RedisSingleCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1784 +* [refactor] add override annotation by @handy-git in https://github.com/apache/hertzbeat/pull/1782 +* '[docs]bugfix: display syntax error of ipmi protocol' by @tomorrowshipyltm in https://github.com/apache/hertzbeat/pull/1793 +* [doc] translate alerter moudle code chinese to english by @tomsun28 in https://github.com/apache/hertzbeat/pull/1765 +* [refactor] database-related properties class, type changed to record by @xuziyang in https://github.com/apache/hertzbeat/pull/1786 +* Fix snmp template unit conversion problem by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1796 +* [doc] Add help documentation for clickhouse monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1798 +* [feature:update-checkstyle] Limit the java file header by @YxYL6125 in https://github.com/apache/hertzbeat/pull/1799 +* [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1783 +* [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in https://github.com/apache/hertzbeat/pull/1797 +* [doc] add team page in website by @alpha951 in https://github.com/apache/hertzbeat/pull/1800 +* [feature] Improve the import checkstyle by @crossoverJie in https://github.com/apache/hertzbeat/pull/1802 +* [doc] Add help document for dns monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1804 +* [improve] preventing NPE by @dukbong in https://github.com/apache/hertzbeat/pull/1808 +* [refactor] change the warehouse properties the type to record by @xuziyang in https://github.com/apache/hertzbeat/pull/1806 +* Refactor: upgrade syntax to jdk17(instanceof & switch) by @Calvin979 in https://github.com/apache/hertzbeat/pull/1807 +* [test] Add NginxCollect test by @crossoverJie in https://github.com/apache/hertzbeat/pull/1809 +* [website] update team page by @tomsun28 in https://github.com/apache/hertzbeat/pull/1803 +* [test] Add RedisClusterCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1789 +* [improve] Fix typo ReqStatusResponse by @crossoverJie in https://github.com/apache/hertzbeat/pull/1811 +* Comparing N objects for null with Assert.noNullElements(). by @dukbong in https://github.com/apache/hertzbeat/pull/1814 +* [doc] Add help document for elasticsearch monitoring and ftp monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1815 +* [doc] add help documentation for huawei switch monitoring by @Alanxtl in https://github.com/apache/hertzbeat/pull/1813 +* chore: upgrade the api-testing (e2e) to v0.0.16 by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1817 +* [Remove][Improve]Mail config by @zqr10159 in https://github.com/apache/hertzbeat/pull/1819 +* Remove and translate chinese to english in code by @dukbong in https://github.com/apache/hertzbeat/pull/1816 +* [feature]Add monitoring for Hbase Master by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1820 +* [doc] resolve code conflicts and coverage caused by pr(#1813) merge by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1821 +* [doc] Add help document for tidb and nacos monitoring by @Alanxtl in https://github.com/apache/hertzbeat/pull/1823 +* [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in https://github.com/apache/hertzbeat/pull/1801 +* [improve] Add whitespace checkstyle by @crossoverJie in https://github.com/apache/hertzbeat/pull/1824 +* [bugfix] dns monitoring template add query class parameter by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1825 +* [Refactor] Preventing Unnecessary Object Creation and Using Utility Methods by @dukbong in https://github.com/apache/hertzbeat/pull/1818 +* [doc]Add and modify Doris FE Chinese and English documentation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1828 +* [docs] Optimize: add help docs for UDP port & Springboot3 help doc by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1832 +* Code Simplification, Structure Changes, and Translation Work, Along with a Question by @dukbong in https://github.com/apache/hertzbeat/pull/1827 +* [doc] add help document for mongodb monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1834 +* [collector] fix: inverts the compareTo sort of MetricsCollect run queue by @Pzz-2021 in https://github.com/apache/hertzbeat/pull/1837 +* [doc]Doc add debian system by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1842 +* [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1833 +* [improve] Optimize websocket monitor by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1838 +* [refactor] Split the WarehouseProperties class by @xuziyang in https://github.com/apache/hertzbeat/pull/1830 +* [test] Add test for HttpsdImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1840 +* [fix] Fix the wrong comment by @xuziyang in https://github.com/apache/hertzbeat/pull/1843 +* [refactor] trans and use assert by @dukbong in https://github.com/apache/hertzbeat/pull/1841 +* [bugfix] modify the command in the mongodb monitoring template by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1844 +* [bigfix]Fix Debian system Top10 monitoring bug by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1846 +* [cleanup]Delete the corresponding Chinese comments by @hudongdong129 in https://github.com/apache/hertzbeat/pull/1847 +* [doc] translates chinese comment to english. by @dukbong in https://github.com/apache/hertzbeat/pull/1853 +* [doc] fix error and add help document for prometheus task by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1852 +* [feature] Add Linux process monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1857 +* [test] Add test for FtpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1856 +* [improve] use apache jexl replace of aviator by @tomsun28 in https://github.com/apache/hertzbeat/pull/1859 +* [bugfix] jpa data save logic repair by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1863 +* [feature] add influxdb metrics monitoring by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1730 +* [doc] add help document for rocketmq by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1874 +* [improve] Imporve checkstyle of test code. by @crossoverJie in https://github.com/apache/hertzbeat/pull/1864 +* [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1867 +* Fix debian monitoring template issue about process monitoring by @LLP2333 in https://github.com/apache/hertzbeat/pull/1868 +* [bugfix] centos Top10 shows missing one by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1870 +* [improve] add website apache incubator footer by @tomsun28 in https://github.com/apache/hertzbeat/pull/1860 +* [doc] update help document by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1861 +* [featurn] support flyway database migration by @tomsun28 in https://github.com/apache/hertzbeat/pull/1875 +* [improve] Delete the timestamp field in the class MetricFamily.Metric by @xuziyang in https://github.com/apache/hertzbeat/pull/1878 +* [improve] Use java.lang.AutoCloseable instead of CacheCloseable by @crossoverJie in https://github.com/apache/hertzbeat/pull/1879 +* [bugfix]Fix top10 process command. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1876 +* [feature] support the VictoriaMetrics cluster by @xuziyang in https://github.com/apache/hertzbeat/pull/1880 +* [improve] Refactor common cache code by @crossoverJie in https://github.com/apache/hertzbeat/pull/1881 +* Eliminate Unnecessary Unboxing and Generics by @handy-git in https://github.com/apache/hertzbeat/pull/1882 +* [bugfix][doc]Add kafka sidebar. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1883 +* [doc] I18n for monitoring template yml metrics by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1888 +* [refactor] StoreProperties is no longer useful, delete it by @xuziyang in https://github.com/apache/hertzbeat/pull/1887 +* bugfix statistical metrics data matching fails by @tomsun28 in https://github.com/apache/hertzbeat/pull/1884 +* [doc] add help doc for flink monitoring by @HeartLinked in https://github.com/apache/hertzbeat/pull/1893 +* [doc] add almalinux documentation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1892 +* [improve] Missing a generic by @crossoverJie in https://github.com/apache/hertzbeat/pull/1889 +* [bugfix] Fixed some metrics of Jexlespression not matching in Elasticsearch by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1894 +* feat(*): Support Time Type to Tengine Data Storage by @Clownsw in https://github.com/apache/hertzbeat/pull/1890 +* [feature] support random jwt secret when not custom by @tomsun28 in https://github.com/apache/hertzbeat/pull/1897 +* [doc] add opensuse doc by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1902 +* fix when manager restart, collect register error by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1896 +* [bugfix] fix can not use empty collection as query params in eclipselink by @tomsun28 in https://github.com/apache/hertzbeat/pull/1900 +* [doc] update doc add download page and pic by @tomsun28 in https://github.com/apache/hertzbeat/pull/1904 +* [test] Add test for UdpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1906 +* fix license by @yqxxgh in https://github.com/apache/hertzbeat/pull/1907 +* [improve] refactor code by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1901 +* [type:bugfix] fix customized menu invalid bug #1898 by @Aias00 in https://github.com/apache/hertzbeat/pull/1908 +* [type:bugfix] fix HTTP API bug #1895 by @Aias00 in https://github.com/apache/hertzbeat/pull/1909 +* [test] Add test for WebsocketCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1912 +* [doc] translates chinese comment to english. by @westboy in https://github.com/apache/hertzbeat/pull/1914 +* [doc] Add HIP document and template by @crossoverJie in https://github.com/apache/hertzbeat/pull/1913 +* [improve] clean up home webapp unused code by @tomsun28 in https://github.com/apache/hertzbeat/pull/1915 +* [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1917 +* [doc] Improve the Contribution Documentation. by @crossoverJie in https://github.com/apache/hertzbeat/pull/1918 +* [featrue]add apache hdfs monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1920 +* [doc] update hbase documentation description by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1921 +* [doc] Add documentation for nebulaGraph cluster monitoring and custom monitoring using NGQL, and clean up useless parameters by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1923 +* [test] Add test for TelnetCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1924 +* fix(*): fix TdEngine Init not found Database by @Clownsw in https://github.com/apache/hertzbeat/pull/1891 +* [doc] update contribution and add run-build guide by @tomsun28 in https://github.com/apache/hertzbeat/pull/1919 +* bugfix collector startup error can not find JdbcClient by @tomsun28 in https://github.com/apache/hertzbeat/pull/1925 +* [doc] add help document for freebsd monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1928 +* [refactoring] Split AbstractHistoryDataStorage class by @xuziyang in https://github.com/apache/hertzbeat/pull/1926 +* [fix] fixed name error in monitoring template and improve NGQL protocol by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1931 +* [refactoring] Split AbstractRealTimeDataStorage class by @xuziyang in https://github.com/apache/hertzbeat/pull/1935 +* [bugfix] fix ssl-cert days_remaining and npe by @tomsun28 in https://github.com/apache/hertzbeat/pull/1934 +* [feature] add apache yarn monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1937 +* [doc] add help document for redhat monitoring and rocky linux monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1939 +* [test] Add test for NtpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1940 +* [bugfix] fix alarm center tags display error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1938 +* [improve] prepare for release hertzbeat v1.6.0 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1929 +* add:Updated the Open Source Summer Project blog. by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1943 +* [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1947 +* [refactoring] Inject a single instance of the data store by @xuziyang in https://github.com/apache/hertzbeat/pull/1944 +* [refactoring] AbstractHistoryDataStorage implement the DisposableBean by @xuziyang in https://github.com/apache/hertzbeat/pull/1946 +* [doc] update iotdb init document by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1948 +* [improve] update build script by @tomsun28 in https://github.com/apache/hertzbeat/pull/1949 +* [test] add test for NgqlCollectImpl by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1953 +* [bugfix]Replace monitors to alert. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1954 +* [improve] add llm, server menu and update doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1955 +* [improve][HIP] HIP-01: Refactoring AbstractCollect by @crossoverJie in https://github.com/apache/hertzbeat/pull/1930 +* [bugfix] fix ConnectionCommonCache possible npe by @crossoverJie in https://github.com/apache/hertzbeat/pull/1959 +* [doc] add help document for eulerOS monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1960 +* [fixbug] Fix the problem of no data for springboot3 monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1961 +* commit：fix the front-end popup cannot exit by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/1957 +* [fixbug] expression rule adaptation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1963 +* [doc] add help doc for influxdb-promql and kafka-promql monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1965 +* [doc]: update readme-cn docs by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1964 +* [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in https://github.com/apache/hertzbeat/pull/1966 +* [chore] update .gitignore to save .idea/icon.png by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1971 +* [improve][bugfix]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1969 +* [feature] add apache hugegraph monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1972 +* [improve] Implement cascading parameter list for SNMP protocol by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1976 +* [improve] optimize DateUtil and add test case by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1974 +* [feature]Hertzbeat custom plugin. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1973 +* update login page and status page color by @lwjxy in https://github.com/apache/hertzbeat/pull/1977 +* [chore] update code style and add some comment by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1975 +* [doc]Hertzbeat plugin doc. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1980 +* [doc] update contributors and update status page style by @tomsun28 in https://github.com/apache/hertzbeat/pull/1981 +* [feature] Implement cascading parameter list by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1978 +* [doc]update threshold alarm doc by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1983 +* [chore] optimize code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1984 +* [fix] Compatible with MongoDB versions earlier than 3.6 by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1988 +* [chore] optimize manager code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1993 +* [doc] Translate part of documentation development.md under `zh-cn` directory from `en` to `zh-cn` by @Thespica in https://github.com/apache/hertzbeat/pull/1995 +* [improve] http protocol prometheus parsing optimization by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1996 +* [feature] add at function for wechat by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/1994 +* [improve] add common util test by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2001 +* [improve] update release license notice and package by @tomsun28 in https://github.com/apache/hertzbeat/pull/2003 +* [bugfix] fix collector startup error classpath by @tomsun28 in https://github.com/apache/hertzbeat/pull/2004 +* [chore] optimize code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2000 +* [improve] Bump up `eslint-plugin-jsdoc` to 48.2.5 to support node 20+ by @Thespica in https://github.com/apache/hertzbeat/pull/2005 +* [doc] fix doc highlighting by @boatrainlsz in https://github.com/apache/hertzbeat/pull/2006 +* [web-app]feature: case insensitive search by @JavaProgrammerLB in https://github.com/apache/hertzbeat/pull/2007 +* [feature] Support time calculation expressions. by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2009 +* [doc] add document for time expression by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2012 +* [feature] Add Apache Pulsar monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2013 +* [doc] home verify release doc update by @tomsun28 in https://github.com/apache/hertzbeat/pull/2014 +* [Improve] Improve clickhouse monitor And Improve Pulsar monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2015 +* [doc] translate help document for memcached monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2019 +* [improve] optimize collector httpsd discovery by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1991 +* [optimize] optimize code style and logic, add unit test by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2010 +* [fix] Fix possible potential thread safe bugs by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/2021 +* [improve] add ci for home by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2024 +* [bugfix]Tag with empty value Shouldn't transform to Tag: by @JavaProgrammerLB in https://github.com/apache/hertzbeat/pull/2025 +* [bugfix] modify popup confirm to clear cache and cancel popup save by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/2026 +* [improve] update monitor state desc by @tomsun28 in https://github.com/apache/hertzbeat/pull/2028 +* bugfix: fix overflow of integers by @Calvin979 in https://github.com/apache/hertzbeat/pull/2029 +* [improve] tips need update initial default password by @tomsun28 in https://github.com/apache/hertzbeat/pull/2030 +* [improve] deprecate support iotdb 0.* version by @Ceilzcx in https://github.com/apache/hertzbeat/pull/2032 +* [fixbug] required field check by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2022 +* [improve] add IcmpCollectImplTest by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2033 +* [improve] fix code style by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2034 +* [improve] increase the length limit of the username field by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2035 +* [improve] Checkstyle include testSource by @crossoverJie in https://github.com/apache/hertzbeat/pull/2036 +* [bugfix] fix collector and frontend dependent license error by @tomsun28 in https://github.com/apache/hertzbeat/pull/2037 +* [improve] Add test for MemcachedCollectImpl by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2044 +* [imprve] Remove duplicate indices by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2045 +* [docs]: fix several typos in docs by @lw-yang in https://github.com/apache/hertzbeat/pull/2047 +* Add the missing parts of docs, fix layout, sync the English version with the Chinese version by @xfl12345 in https://github.com/apache/hertzbeat/pull/2048 +* [improve] add filename check in home ci by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2049 +* [improve] update dependency licenses and remove the aliyun sms depend by @tomsun28 in https://github.com/apache/hertzbeat/pull/2058 + +## New Contributors + +* @handy-git made their first contribution in https://github.com/apache/hertzbeat/pull/1643 +* @LiuTianyou made their first contribution in https://github.com/apache/hertzbeat/pull/1684 +* @WinterKi1ler made their first contribution in https://github.com/apache/hertzbeat/pull/1718 +* @miki-hmt made their first contribution in https://github.com/apache/hertzbeat/pull/1734 +* @gjjjj0101 made their first contribution in https://github.com/apache/hertzbeat/pull/1748 +* @makechoicenow made their first contribution in https://github.com/apache/hertzbeat/pull/1747 +* @alpha951 made their first contribution in https://github.com/apache/hertzbeat/pull/1745 +* @crossoverJie made their first contribution in https://github.com/apache/hertzbeat/pull/1758 +* @PeixyJ made their first contribution in https://github.com/apache/hertzbeat/pull/1760 +* @dukbong made their first contribution in https://github.com/apache/hertzbeat/pull/1757 +* @xuziyang made their first contribution in https://github.com/apache/hertzbeat/pull/1773 +* @MananPoojara made their first contribution in https://github.com/apache/hertzbeat/pull/1774 +* @lwqzz made their first contribution in https://github.com/apache/hertzbeat/pull/1768 +* @tomorrowshipyltm made their first contribution in https://github.com/apache/hertzbeat/pull/1793 +* @YxYL6125 made their first contribution in https://github.com/apache/hertzbeat/pull/1799 +* @15613060203 made their first contribution in https://github.com/apache/hertzbeat/pull/1797 +* @Alanxtl made their first contribution in https://github.com/apache/hertzbeat/pull/1813 +* @zhangshenghang made their first contribution in https://github.com/apache/hertzbeat/pull/1820 +* @zuobiao-zhou made their first contribution in https://github.com/apache/hertzbeat/pull/1832 +* @Pzz-2021 made their first contribution in https://github.com/apache/hertzbeat/pull/1837 +* @LLP2333 made their first contribution in https://github.com/apache/hertzbeat/pull/1868 +* @HeartLinked made their first contribution in https://github.com/apache/hertzbeat/pull/1893 +* @Aias00 made their first contribution in https://github.com/apache/hertzbeat/pull/1908 +* @westboy made their first contribution in https://github.com/apache/hertzbeat/pull/1914 +* @Yanshuming1 made their first contribution in https://github.com/apache/hertzbeat/pull/1957 +* @yuluo-yx made their first contribution in https://github.com/apache/hertzbeat/pull/1964 +* @lwjxy made their first contribution in https://github.com/apache/hertzbeat/pull/1977 +* @Thespica made their first contribution in https://github.com/apache/hertzbeat/pull/1995 +* @boatrainlsz made their first contribution in https://github.com/apache/hertzbeat/pull/2006 +* @JavaProgrammerLB made their first contribution in https://github.com/apache/hertzbeat/pull/2007 +* @lw-yang made their first contribution in https://github.com/apache/hertzbeat/pull/2047 +* @xfl12345 made their first contribution in https://github.com/apache/hertzbeat/pull/2048 + + +## 一条命令即可开始 + +```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` + +```或者试用 quay.io (如果 DockerHub 网络超时)``` + +```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` + + +详细参考 HertzBeat 官网文档 https://hertzbeat.com/docs + + +---- + +**Github: https://github.com/apache/hertzbeat** + +下载页面: https://hertzbeat.apache.org/docs/download/ + +升级指南: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-update/ + +Have Fun! + +---- + +HertzBeat, Make Monitoring Easier! + +Apache HertzBeat Team diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md index 31fe0ac98f7..5f8db64d1be 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md @@ -78,73 +78,199 @@ sidebar_label: 系统默认解析方式 **对应的监控模版YML可以配置为如下** ```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: example +# The monitoring type eg: linux windows tomcat mysql aws... +app: a_example +# The monitoring i18n name name: - zh-CN: 模拟应用类型 + zh-CN: 模拟应用 en-US: EXAMPLE APP -# 监控参数定义. field 这些为输入参数变量，即可以用^_^host^_^的形式写到后面的配置中，系统自动变量值替换 -# 强制固定必须参数 - host +# The description and help of this monitoring type +help: + zh-CN: HertzBeat 支持自定义监控，您只需配置监控模版 YML 就能适配一款自定义的监控类型。
定义流程如下：HertzBeat 页面 -> 监控模版菜单 -> 新增监控类型 -> 配置自定义监控模版YML -> 点击保存应用 -> 使用新监控类型添加监控。 + en-US: "HertzBeat supports custom monitoring, and you only need to configure the monitoring template YML to adapt to a custom monitoring type.
Definition process as follow: HertzBeat Pages -> Main Menu -> Monitor Template -> edit and save -> apply this template." + zh-TW: HertzBeat支持自定義監控，您只需配寘監控模版YML就能適配一款自定義的監控類型。
定義流程如下：HertzBeat頁面->監控模版選單->新增監控類型->配寘自定義監控模版YML ->點擊保存應用->使用新監控類型添加監控。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/advanced/extend-point/ + en-US: https://hertzbeat.apache.org/docs/advanced/extend-point/ +# Input params define for monitoring(render web ui by the definition) params: - # field-字段名称标识符 + # field-param field key - field: host - # name-参数字段显示名称 + # name-param field display i18n name name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) type: host - # 是否是必输项 true-必填 false-可选 + # required-true or false required: true + # field-param field key - field: port + # name-param field display i18n name name: zh-CN: 端口 en-US: Port + # type-param field type(most mapping the html input type) type: number - # 当type为number时,用range表示范围 + # when type is number, range is required range: '[0,65535]' + # required-true or false required: true - # 端口默认值 + # default value defaultValue: 80 - # 参数输入框提示信息 - placeholder: '请输入端口' + # param field input placeholder + placeholder: 'Please Input Port' + # field-param field key + - field: username + # name-param field display i18n name + name: + zh-CN: 用户名 + en-US: Username + # type-param field type(most mapping the html input type) + type: text + # when type is text, use limit to limit string length + limit: 50 + # required-true or false + required: false + # hide param-true or false + hide: true + # field-param field key + - field: password + # name-param field display i18n name + name: + zh-CN: 用户密码 + en-US: Password + # type-param field type(most mapping the html input tag) + type: password + # required-true or false + required: false + # hide param-true or false + hide: true + # field-param field key + - field: ssl + # name-param field display i18n name + name: + zh-CN: 启动SSL + en-US: SSL + # type-param field type(boolean mapping the html switch tag) + type: boolean + # required-true or false + required: false + # field-param field key + - field: method + # name-param field display i18n name + name: + zh-CN: 请求方式 + en-US: Method + # type-param field type(radio mapping the html radio tag) + type: radio + # required-true or false + required: true + # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2} + options: + - label: GET + value: GET + - label: POST + value: POST + - label: PUT + value: PUT + - label: DELETE + value: DELETE + # field-param field key + - field: headers + # name-param field display i18n name + name: + zh-CN: 请求Headers + en-US: Headers + # type-param field type(key-value mapping the html key-value input tags) + type: key-value + # required-true or false + required: false + # when type is key-value, use keyAlias to config key alias name + keyAlias: Header Name + # when type is key-value, use valueAlias to config value alias name + valueAlias: Header Value # collect metrics config list -# 采集指标配置列表 metrics: - # First monitoring metric group cpu - # Note: The built-in monitoring metrics include (responseTime - response time) + # metrics - cpu - name: cpu - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 + # metrics name i18n label + i18n: + zh-CN: CPU 信息 + en-US: CPU Info + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue priority: 0 - # 具体监控指标列表 + # collect metrics content fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 + # field-metric name, i18n-metric name i18n label, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field - field: hostname type: 1 label: true + i18n: + zh-CN: 主机名称 + en-US: Host Name - field: usage type: 0 unit: '%' - - field: core + i18n: + zh-CN: 使用率 + en-US: Usage + - field: cores + type: 0 + i18n: + zh-CN: 核数 + en-US: Cores + - field: waitTime type: 0 -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk + unit: s + i18n: + zh-CN: 主机名称 + en-US: Host Name + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field + aliasFields: + - hostname + - core1 + - core2 + - usage + - allTime + - runningTime + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + calculates: + - hostname=hostname + - cores=core1+core2 + - usage=usage + - waitTime=allTime-runningTime + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: http -# 当protocol为http协议时具体的采集配置 + # the config content when protocol is http http: - # 主机host: ipv4 ipv6 域名 + # http host: ipv4 ipv6 domain host: ^_^host^_^ - # 端口 + # http port port: ^_^port^_^ - # url请求接口路径 + # http url url: /metrics/cpu - # 请求方式 GET POST PUT DELETE PATCH + # http method: GET POST PUT DELETE PATCH method: GET - # 是否启用ssl/tls,即是http还是https,默认false + # if enabled https ssl: false - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - # 这里使用HertzBeat默认解析 - parseType: default + # http request header content + headers: + ^_^headers^_^: ^_^headers^_^ + # http request params + params: + param1: param1 + param2: param2 + # http auth + authorization: + # http auth type: Basic Auth, Digest Auth, Bearer Token + type: Basic Auth + basicAuthUsername: ^_^username^_^ + basicAuthPassword: ^_^password^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: jsonPath + parseScript: '$' ``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md index 160adf031c9..357cbd133ca 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md @@ -69,18 +69,25 @@ sidebar_label: 教程一:适配一款HTTP协议监控 样例：自定义一个名称为`hertzbeat`的自定义监控类型，其使用HTTP协议采集指标数据。 ```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 category: custom -# 监控应用类型名称(与文件名保持一致) eg: linux windows tomcat mysql aws... +# The monitoring type eg: linux windows tomcat mysql aws... app: hertzbeat name: - zh-CN: HertzBeat监控系统 - en-US: HertzBeat Monitor + zh-CN: HertzBeat + en-US: HertzBeat +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 Hertzbeat 监控系统的通用指标进行测量监控。
您可以点击 “新建 HertzBeat监控系统” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor through general performance metric. You could click the "New HertzBeat Monitor" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對Hertzbeat監控系統的通用名額進行量測監控。
您可以點擊“新建HertzBeat監控系統”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat params: - field: host name: - zh-CN: 主机Host - en-US: Host + zh-CN: 目标Host + en-US: Target Host type: host required: true - field: port @@ -131,21 +138,16 @@ params: type: password required: false hide: true -# collect metrics config list -# 采集指标配置列表 metrics: - # metrics - summary - # 监控指标 - summary + # the first metrics summary + # attention: Built-in monitoring metrics contains (responseTime - Response time) - name: summary - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue priority: 0 - # 具体监控指标列表 + # collect metrics content fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: responseTime - type: 0 - unit: ms + # metrics content contains field-metric name, type-metric type:0-number,1-string, instance-if is metrics, unit-metric unit('%','ms','MB') - field: app type: 1 label: true @@ -156,33 +158,33 @@ metrics: - field: size type: 0 - field: availableSize - type: 0 -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk, 我们这里使用HTTP协议 + type: 0 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here protocol: http -# 当protocol为http协议时具体的采集配置 + # the config content when protocol is http http: - # 主机host: ipv4 ipv6 域名 + # host: ipv4 ipv6 domain host: ^_^host^_^ - # 端口 + # http port port: ^_^port^_^ - # url请求接口路径，我们这里不需要输入传参，写死为 /api/summary + # http url, we don't need to enter a parameter here, just set the fixed value to /api/summary url: /api/summary timeout: ^_^timeout^_^ - # 请求方式 GET POST PUT DELETE PATCH，写死为 + # http method: GET POST PUT DELETE PATCH, default fixed value is GET method: GET - # 是否启用ssl/tls,即是http还是https,默认false + # if enabled https, default value is false ssl: ^_^ssl^_^ - # 认证 + # http auth authorization: - # 认证方式: Basic Auth, Digest Auth, Bearer Token + # http auth type: Basic Auth, Digest Auth, Bearer Token type: ^_^authType^_^ basicAuthUsername: ^_^username^_^ basicAuthPassword: ^_^password^_^ digestAuthUsername: ^_^username^_^ digestAuthPassword: ^_^password^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控，我们这里使用jsonpath来解析响应数据 + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, we use jsonpath to parse response data here parseType: jsonPath - parseScript: '$.data.apps.*' + parseScript: '$.data.apps.*' ``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md index 94f49c01f61..b7a665a60b9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md @@ -43,41 +43,49 @@ sidebar_label: 教程二:获取TOKEN后续认证使用 我们直接复用 app-hertzbeat.yml 里面的定义内容,修改为我们当前的监控类型`hertzbeat_auth`配置参数, 比如 `app, category等`。 ```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... +# The monitoring type eg: linux windows tomcat mysql aws... app: hertzbeat_token +# The monitoring i18n name name: - zh-CN: HertzBeat监控(Token) - en-US: HertzBeat Monitor(Token) + zh-CN: HertzBeat(Token) + en-US: HertzBeat(Token) +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 HertzBeat监控(Token)进行测量监控。
您可以点击 “新建 HertzBeat监控(Token)” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor(Token). You could click the "New HertzBeat Monitor(Token)" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對HertzBeat監控（Token）進行量測監控。
您可以點擊“新建HertzBeat監控（Token）”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat_token + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat_token +# Input params define for monitoring(render web ui by the definition) params: - # field-字段名称标识符 + # field-param field key - field: host - # name-参数字段显示名称 + # name-param field display i18n name name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) type: host - # 是否是必输项 true-必填 false-可选 + # required-true or false required: true - field: port name: zh-CN: 端口 en-US: Port + # type-param field type(most mapping the html input type) type: number - # 当type为number时,用range表示范围 + # when type is number, range is required range: '[0,65535]' required: true - # 端口默认值 defaultValue: 1157 - # 参数输入框提示信息 - placeholder: '请输入端口' + placeholder: 'Please input port' - field: ssl name: zh-CN: 启动SSL en-US: SSL - # 当type为boolean时,前端用switch展示开关 + # type-param field type(boolean mapping the html switch tag) type: boolean required: false - field: contentType @@ -94,9 +102,6 @@ params: type: textarea placeholder: 'Available When POST PUT' required: false -# 采集指标配置列表 todo 下方配置 -metrics: ...... - ``` ### 定义监控指标`auth`登录请求获取`token` @@ -105,41 +110,49 @@ metrics: ...... ```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... +# The monitoring type eg: linux windows tomcat mysql aws... app: hertzbeat_token +# The monitoring i18n name name: - zh-CN: HertzBeat监控(Token) - en-US: HertzBeat Monitor(Token) + zh-CN: HertzBeat(Token) + en-US: HertzBeat(Token) +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 HertzBeat监控(Token)进行测量监控。
您可以点击 “新建 HertzBeat监控(Token)” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor(Token). You could click the "New HertzBeat Monitor(Token)" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對HertzBeat監控（Token）進行量測監控。
您可以點擊“新建HertzBeat監控（Token）”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat_token + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat_token +# Input params define for monitoring(render web ui by the definition) params: - # field-字段名称标识符 + # field-param field key - field: host - # name-参数字段显示名称 + # name-param field display i18n name name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) type: host - # 是否是必输项 true-必填 false-可选 + # required-true or false required: true - field: port name: zh-CN: 端口 en-US: Port + # type-param field type(most mapping the html input type) type: number - # 当type为number时,用range表示范围 + # when type is number, range is required range: '[0,65535]' required: true - # 端口默认值 defaultValue: 1157 - # 参数输入框提示信息 - placeholder: '请输入端口' + placeholder: 'Please input port' - field: ssl name: zh-CN: 启动SSL en-US: SSL - # 当type为boolean时,前端用switch展示开关 + # type-param field type(boolean mapping the html switch tag) type: boolean required: false - field: contentType @@ -156,40 +169,43 @@ params: type: textarea placeholder: 'Available When POST PUT' required: false -# 采集指标配置列表 +# collect metrics config list metrics: - # 第一个监控指标 auth - # 注意：内置监控指标有 (responseTime - 响应时间) + # metrics - auth - name: auth - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue priority: 0 - # 具体监控指标列表 + # collect metrics content fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field - field: token type: 1 - field: refreshToken type: 1 - # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: http - # 当protocol为http协议时具体的采集配置 + # the config content when protocol is http http: - # 主机host: ipv4 ipv6 域名 + # http host: ipv4 ipv6 domain host: ^_^host^_^ - # 端口 + # http port port: ^_^port^_^ - # url请求接口路径 + # http url url: /api/account/auth/form - # 请求方式 GET POST PUT DELETE PATCH + # http method: GET POST PUT DELETE PATCH method: POST - # 是否启用ssl/tls,即是http还是https,默认false + # if enabled https ssl: ^_^ssl^_^ payload: ^_^payload^_^ - # 请求头内容 + # http request header content headers: content-type: ^_^contentType^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 + ^_^headers^_^: ^_^headers^_^ + # http request params + params: + ^_^params^_^: ^_^params^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule parseType: jsonPath parseScript: '$.data' @@ -235,41 +251,49 @@ metrics: ```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... +# The monitoring type eg: linux windows tomcat mysql aws... app: hertzbeat_token +# The monitoring i18n name name: - zh-CN: HertzBeat监控(Token) - en-US: HertzBeat Monitor(Token) + zh-CN: HertzBeat(Token) + en-US: HertzBeat(Token) +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 HertzBeat监控(Token)进行测量监控。
您可以点击 “新建 HertzBeat监控(Token)” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor(Token). You could click the "New HertzBeat Monitor(Token)" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對HertzBeat監控（Token）進行量測監控。
您可以點擊“新建HertzBeat監控（Token）”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat_token + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat_token +# Input params define for monitoring(render web ui by the definition) params: - # field-字段名称标识符 + # field-param field key - field: host - # name-参数字段显示名称 + # name-param field display i18n name name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) type: host - # 是否是必输项 true-必填 false-可选 + # required-true or false required: true - field: port name: zh-CN: 端口 en-US: Port + # type-param field type(most mapping the html input type) type: number - # 当type为number时,用range表示范围 + # when type is number, range is required range: '[0,65535]' required: true - # 端口默认值 defaultValue: 1157 - # 参数输入框提示信息 - placeholder: '请输入端口' + placeholder: 'Please input port' - field: ssl name: zh-CN: 启动SSL en-US: SSL - # 当type为boolean时,前端用switch展示开关 + # type-param field type(boolean mapping the html switch tag) type: boolean required: false - field: contentType @@ -286,83 +310,72 @@ params: type: textarea placeholder: 'Available When POST PUT' required: false -# 采集指标配置列表 +# collect metrics config list metrics: -# 第一个监控指标 cpu -# 注意：内置监控指标有 (responseTime - 响应时间) + # metrics - auth - name: auth - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue priority: 0 - # 具体监控指标列表 + # collect metrics content fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field - field: token type: 1 - field: refreshToken type: 1 - # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: http - # 当protocol为http协议时具体的采集配置 + # the config content when protocol is http http: - # 主机host: ipv4 ipv6 域名 + # http host: ipv4 ipv6 domain host: ^_^host^_^ - # 端口 + # http port port: ^_^port^_^ - # url请求接口路径 + # http url url: /api/account/auth/form - # 请求方式 GET POST PUT DELETE PATCH + # http method: GET POST PUT DELETE PATCH method: POST - # 是否启用ssl/tls,即是http还是https,默认false + # if enabled https ssl: ^_^ssl^_^ payload: ^_^payload^_^ - # 请求头内容 + # http request header content headers: content-type: ^_^contentType^_^ ^_^headers^_^: ^_^headers^_^ - # 请求参数内容 + # http request params params: ^_^params^_^: ^_^params^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule parseType: jsonPath parseScript: '$.data' - name: summary - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 priority: 1 - # 具体监控指标列表 fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: category - type: 1 - field: app type: 1 + label: true + - field: category + type: 1 + - field: status + type: 0 - field: size type: 0 - - field: status + - field: availableSize type: 0 -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: http -# 当protocol为http协议时具体的采集配置 http: - # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ - # 端口 port: ^_^port^_^ - # url请求接口路径 url: /api/summary - # 请求方式 GET POST PUT DELETE PATCH method: GET - # 是否启用ssl/tls,即是http还是https,默认false ssl: ^_^ssl^_^ - # 认证 authorization: - # 认证方式: Basic Auth, Digest Auth, Bearer Token type: Bearer Token + # ^o^xxx^o^ ^o^ substitution represents the value of the acquisition metric xxx of the previous priority bearerTokenToken: ^o^token^o^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 parseType: jsonPath parseScript: '$.data.apps.*' diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md index ae29f265574..fef3c3d2fa8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md @@ -98,9 +98,8 @@ sidebar_label: JsonPath解析方式 **对应的监控模版YML可以配置为如下** ```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... +# 监控应用类型 eg: linux windows tomcat mysql aws... app: example name: zh-CN: 模拟应用类型 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md index 21b8015da77..9a0dca41ae3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md @@ -34,98 +34,158 @@ HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数， ```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 +# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: example_http +# The monitoring type eg: linux windows tomcat mysql aws... +app: a_example +# The monitoring i18n name name: - zh-CN: 模拟应用类型 + zh-CN: 模拟应用 en-US: EXAMPLE APP -# 监控参数定义. field 这些为输入参数变量，即可以用^_^host^_^的形式写到后面的配置中，系统自动变量值替换 -# 强制固定必须参数 - host +# The description and help of this monitoring type +help: + zh-CN: HertzBeat 支持自定义监控，您只需配置监控模版 YML 就能适配一款自定义的监控类型。
定义流程如下：HertzBeat 页面 -> 监控模版菜单 -> 新增监控类型 -> 配置自定义监控模版YML -> 点击保存应用 -> 使用新监控类型添加监控。 + en-US: "HertzBeat supports custom monitoring, and you only need to configure the monitoring template YML to adapt to a custom monitoring type.
Definition process as follow: HertzBeat Pages -> Main Menu -> Monitor Template -> edit and save -> apply this template." + zh-TW: HertzBeat支持自定義監控，您只需配寘監控模版YML就能適配一款自定義的監控類型。
定義流程如下：HertzBeat頁面->監控模版選單->新增監控類型->配寘自定義監控模版YML ->點擊保存應用->使用新監控類型添加監控。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/advanced/extend-point/ + en-US: https://hertzbeat.apache.org/docs/advanced/extend-point/ +# Input params define for monitoring(render web ui by the definition) params: - # field-字段名称标识符 + # field-param field key - field: host - # name-参数字段显示名称 + # name-param field display i18n name name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) type: host - # 是否是必输项 true-必填 false-可选 + # required-true or false required: true + # field-param field key - field: port + # name-param field display i18n name name: zh-CN: 端口 en-US: Port + # type-param field type(most mapping the html input type) type: number - # 当type为number时,用range表示范围 + # when type is number, range is required range: '[0,65535]' + # required-true or false required: true - # 端口默认值 + # default value defaultValue: 80 - # 参数输入框提示信息 - placeholder: '请输入端口' + # param field input placeholder + placeholder: 'Please Input Port' + # field-param field key - field: username + # name-param field display i18n name name: zh-CN: 用户名 en-US: Username + # type-param field type(most mapping the html input type) type: text - # 当type为text时,用limit表示字符串限制大小 + # when type is text, use limit to limit string length limit: 50 + # required-true or false required: false + # hide param-true or false + hide: true + # field-param field key - field: password + # name-param field display i18n name name: - zh-CN: 密码 + zh-CN: 用户密码 en-US: Password + # type-param field type(most mapping the html input tag) type: password + # required-true or false required: false + # hide param-true or false + hide: true + # field-param field key - field: ssl + # name-param field display i18n name name: zh-CN: 启动SSL - en-US: Enable SSL - # 当type为boolean时,前端用switch展示开关 + en-US: SSL + # type-param field type(boolean mapping the html switch tag) type: boolean + # required-true or false required: false + # field-param field key - field: method + # name-param field display i18n name name: zh-CN: 请求方式 en-US: Method + # type-param field type(radio mapping the html radio tag) type: radio + # required-true or false required: true - # 当type为radio单选框,checkbox复选框时,option表示可选项值列表 {name1:value1,name2:value2} + # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2} options: - - label: GET请求 + - label: GET value: GET - - label: POST请求 + - label: POST value: POST - - label: PUT请求 + - label: PUT value: PUT - - label: DELETE请求 + - label: DELETE value: DELETE -# 采集指标配置列表 + # field-param field key + - field: headers + # name-param field display i18n name + name: + zh-CN: 请求Headers + en-US: Headers + # type-param field type(key-value mapping the html key-value input tags) + type: key-value + # required-true or false + required: false + # when type is key-value, use keyAlias to config key alias name + keyAlias: Header Name + # when type is key-value, use valueAlias to config value alias name + valueAlias: Header Value +# collect metrics config list metrics: -# 第一个监控指标 cpu -# 注意：内置监控指标有 (responseTime - 响应时间) + # metrics - cpu - name: cpu - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 + # metrics name i18n label + i18n: + zh-CN: CPU 信息 + en-US: CPU Info + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue priority: 0 - # 具体监控指标列表 + # collect metrics content fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 + # field-metric name, i18n-metric name i18n label, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field - field: hostname type: 1 label: true + i18n: + zh-CN: 主机名称 + en-US: Host Name - field: usage type: 0 unit: '%' + i18n: + zh-CN: 使用率 + en-US: Usage - field: cores type: 0 + i18n: + zh-CN: 核数 + en-US: Cores - field: waitTime type: 0 unit: s -# (非必须)监控指标别名，与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换 + i18n: + zh-CN: 主机名称 + en-US: Host Name + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field aliasFields: - hostname - core1 @@ -133,59 +193,73 @@ metrics: - usage - allTime - runningTime -# (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 -# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime calculates: - hostname=hostname - cores=core1+core2 - usage=usage - waitTime=allTime-runningTime -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: http -# 当protocol为http协议时具体的采集配置 + # the config content when protocol is http http: - # 主机host: ipv4 ipv6 域名 + # http host: ipv4 ipv6 domain host: ^_^host^_^ - # 端口 + # http port port: ^_^port^_^ - # url请求接口路径 + # http url url: /metrics/cpu - # 请求方式 GET POST PUT DELETE PATCH + # http method: GET POST PUT DELETE PATCH method: GET - # 是否启用ssl/tls,即是http还是https,默认false + # if enabled https ssl: false - # 请求头内容 + # http request header content headers: - apiVersion: v1 - # 请求参数内容 + ^_^headers^_^: ^_^headers^_^ + # http request params params: param1: param1 param2: param2 - # 认证 + # http auth authorization: - # 认证方式: Basic Auth, Digest Auth, Bearer Token + # http auth type: Basic Auth, Digest Auth, Bearer Token type: Basic Auth basicAuthUsername: ^_^username^_^ basicAuthPassword: ^_^password^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - # todo xmlPath-xmlPath脚本,prometheus-Prometheus数据规则 + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule parseType: jsonPath parseScript: '$' - name: memory + i18n: + zh-CN: 内存信息 + en-US: Memory Info priority: 1 fields: - field: hostname type: 1 label: true + i18n: + zh-CN: 主机名称 + en-US: Hostname - field: total type: 0 unit: kb + i18n: + zh-CN: 总量 + en-US: Total - field: usage type: 0 unit: '%' + i18n: + zh-CN: 使用率 + en-US: Usage - field: speed type: 0 + i18n: + zh-CN: 速率 + en-US: Speed protocol: http http: host: ^_^host^_^ @@ -194,7 +268,6 @@ metrics: method: GET headers: apiVersion: v1 - # 查询参数，支持使用时间表达式 params: param1: param1 param2: param2 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md index c951f1bc190..d2b0ee36cdc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md @@ -38,6 +38,14 @@ app: example2 name: zh-CN: 模拟网站监测 en-US: EXAMPLE WEBSITE +# The description and help of this monitoring type +help: + zh-CN: HertzBeat 支持自定义监控，您只需配置监控模版 YML 就能适配一款自定义的监控类型。
定义流程如下：HertzBeat 页面 -> 监控模版菜单 -> 新增监控类型 -> 配置自定义监控模版YML -> 点击保存应用 -> 使用新监控类型添加监控。 + en-US: "HertzBeat supports custom monitoring, and you only need to configure the monitoring template YML to adapt to a custom monitoring type.
Definition process as follow: HertzBeat Pages -> Main Menu -> Monitor Template -> edit and save -> apply this template." + zh-TW: HertzBeat支持自定義監控，您只需配寘監控模版YML就能適配一款自定義的監控類型。
定義流程如下：HertzBeat頁面->監控模版選單->新增監控類型->配寘自定義監控模版YML ->點擊保存應用->使用新監控類型添加監控。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/advanced/extend-point/ + en-US: https://hertzbeat.apache.org/docs/advanced/extend-point/ # 监控所需输入参数定义(根据定义渲染页面UI) # Input params define for monitoring(render web ui by the definition) params: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md index c536fabf6c4..22578d67854 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md @@ -79,6 +79,14 @@ app: hertzbeat name: zh-CN: HertzBeat监控系统 en-US: HertzBeat Monitor +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 Hertzbeat 监控系统的通用指标进行测量监控。
您可以点击 “新建 HertzBeat监控系统” 并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: Hertzbeat monitors HertzBeat Monitor through general performance metric. You could click the "New HertzBeat Monitor" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: Hertzbeat對Hertzbeat監控系統的通用名額進行量測監控。
您可以點擊“新建HertzBeat監控系統”並進行配寘，或者選擇“更多操作”，導入已有配寘。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hertzbeat + en-US: https://hertzbeat.apache.org/docs/help/hertzbeat # Input params define for monitoring(render web ui by the definition) # 监控所需输入参数定义(根据定义渲染页面UI) params: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md index 188b68b3688..140a36fad07 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md @@ -73,11 +73,35 @@ Subject: [VOTE] New committer: ${NEW_COMMITTER_NAME} ```text Hi HertzBeat PPMC, -This is a formal vote about inviting ${NEW_COMMITTER_NAME} as our new committer. +This is a formal vote about inviting ${NEW_COMMITTER_NAME} as our community new committer. -${Work list}[1] +Work list: https://github.com/apache/hertzbeat/commits?author=${NEW_COMMITTER_NAME} -[1] https://github.com/apache/hertzbeat/commits?author=${NEW_COMMITTER_NAME} +Here is the list of ${NEW_COMMITTER_NAME}'s contributions in HertzBeat Community: + +> [27 commits](https://github.com/apache/hertzbeat/commits?author=xxx) +> +> 7,495 ++ 627 -- + +Submitted PR (27 commits) +- [ISSUE #4534] [feature] add new feature in hertzbeat #3445 +- xxx + +Submitted Issues (18 commits) + +- [bug] find some bugs in hertzbeat nodes #6565 +- xxx + +Please vote: + ++1: I support this proposal and will welcome ${NEW_COMMITTER_NAME} as a committer. ++0: I don't care. +-1: I object to this proposal and here are my reasons. + +This vote will be open for at least 7 days. + +Best Wishes, +ttt ``` 注意，投票将在今天一周后结束，即 diff --git a/home/sidebars.json b/home/sidebars.json index 9f15749657c..b39f3ee6997 100755 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -78,13 +78,6 @@ "advanced/extend-snmp" ] }, - { - "type": "category", - "label": "push", - "items": [ - "advanced/extend-push" - ] - }, { "type": "category", "label": "NGQL", diff --git a/home/src/pages/team/index.jsx b/home/src/pages/team/index.jsx index e1dfbeb1ca3..24ae677e472 100644 --- a/home/src/pages/team/index.jsx +++ b/home/src/pages/team/index.jsx @@ -1065,6 +1065,20 @@ export default function () { src="https://avatars.githubusercontent.com/u/17960863?v=4?s=100" width="100px;" alt="xfl12345"/>
xfl12345
📖 + Limbo
Limbo
💻 + 哈哈哈哈哈哈哈哈哈
哈哈哈哈哈哈哈哈哈
💻 + + + Leon Li
Leon + Li
💻 diff --git a/home/static/img/docs/cluster-arch.png b/home/static/img/docs/cluster-arch.png index 98a5489ae77..57fff7258a3 100644 Binary files a/home/static/img/docs/cluster-arch.png and b/home/static/img/docs/cluster-arch.png differ diff --git a/home/static/img/docs/custom-arch.png b/home/static/img/docs/custom-arch.png index 7e051de9a34..127af075899 100644 Binary files a/home/static/img/docs/custom-arch.png and b/home/static/img/docs/custom-arch.png differ diff --git a/home/static/img/docs/hertzbeat-arch.png b/home/static/img/docs/hertzbeat-arch.png index 913eb1eb22d..18970afdaef 100644 Binary files a/home/static/img/docs/hertzbeat-arch.png and b/home/static/img/docs/hertzbeat-arch.png differ diff --git a/home/static/img/docs/hertzbeat-arch.svg b/home/static/img/docs/hertzbeat-arch.svg index 2e05b10e2cd..c8c8c747665 100644 --- a/home/static/img/docs/hertzbeat-arch.svg +++ b/home/static/img/docs/hertzbeat-arch.svg @@ -11,7 +11,11 @@ font-family: "Cascadia"; src: url("https://excalidraw.com/Cascadia.woff2"); } + @font-face { + font-family: "Assistant"; + src: url("https://excalidraw.com/Assistant-Regular.woff2"); + } - queuealerternotifywarehouseh2/mysqlservercollectordispatchmanage datamemory/redislatest metric dataiotdb/tdenginehistory metric dataWEB UIHTTP/HTTPSdefault,jsonpath,prometheusparseJDBCmysql,oracle,sqlserver,postgreSQL,mariadbSSH SHELLlinux, zookeeper,ubuntu,centosSNMPwindows, network...JMXtomcat,jvm,kafka...Ping,Port,Site-map,Ssl-cert,Api,Website...OS,Database,Middleware,Service,Cloud-Native...HertzBeatmonitoring templateHertzBeatisolated network regionAisolated network regionBisolated network regionCcollectorCloud<->EdgecollectorcollectorcollectorClustermonitoringresourcemonitoring resourcecollectormonitoring resourcecollectormonitoring resource \ No newline at end of file + queuealerternotifywarehouseh2/pgservercollectordispatchmanage datamemory/redislatest metric datavm/tsdbhistory metric dataWEB UIHTTP/HTTPSdefault,jsonpath,prometheusparseJDBCmysql,oracle,sqlserver,postgreSQL,mariadbSSH SHELLlinux,zookeeper,ubuntu,centosSNMPwindows,network,switch...JMXtomcat,jvm,kafka,hadoop...Ping,Port,Site-map,Ssl-cert,Api,Website...OS,Database,Middleware,Service,Cloud-Native...Apache HertzBeat (incubating)template ymlHertzBeatisolated network regionAisolated network regionBisolated network regionCcollectorCloud<->EdgecollectorcollectorcollectorClustermonitoringresourcemonitoring resourcecollectormonitoring resourcecollectormonitoring resource \ No newline at end of file diff --git a/script/docker-compose/hertzbeat-postgresql-victoria-metrics/docker-compose.yaml b/script/docker-compose/hertzbeat-postgresql-victoria-metrics/docker-compose.yaml index 18438a51bcc..7e2dc48cf72 100644 --- a/script/docker-compose/hertzbeat-postgresql-victoria-metrics/docker-compose.yaml +++ b/script/docker-compose/hertzbeat-postgresql-victoria-metrics/docker-compose.yaml @@ -34,12 +34,13 @@ services: ports: - '5432:5432' environment: - - POSTGRES_USER=root - - POSTGRES_PASSWORD=123456 - - TZ=Asia/Shanghai + POSTGRES_USER: root + POSTGRES_PASSWORD: 123456 + TZ: Asia/Shanghai volumes: - - ./dbdata/pgdata/data:/var/lib/postgresql/data - - ./conf/sql:/docker-entrypoint-initdb.d/ + - ./dbdata/pgdata/data:/var/lib/postgresql/data + - ./conf/sql:/docker-entrypoint-initdb.d/ + - ./ext-lib:/opt/hertzbeat/ext-lib networks: - hertzbeat diff --git a/script/docker-compose/hertzbeat-postgresql-victoria-metrics/ext-lib/.gitignore b/script/docker-compose/hertzbeat-postgresql-victoria-metrics/ext-lib/.gitignore new file mode 100644 index 00000000000..c087c266df0 --- /dev/null +++ b/script/docker-compose/hertzbeat-postgresql-victoria-metrics/ext-lib/.gitignore @@ -0,0 +1,2 @@ +!.gitignore +*.jar diff --git a/script/docker-compose/hertzbeat-postgresql-victoria-metrics/ext-lib/README b/script/docker-compose/hertzbeat-postgresql-victoria-metrics/ext-lib/README new file mode 100644 index 00000000000..5898fde6b91 --- /dev/null +++ b/script/docker-compose/hertzbeat-postgresql-victoria-metrics/ext-lib/README @@ -0,0 +1,21 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +Please move external libs to this folder like: + +ojdbc8-21.5.0.0.jar +orai18n-21.5.0.0.jar +mysql-connector-java-8.0.30.jar +