[doc]: add monitoring documentation for various service discovery methods #3965
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for six service discovery monitoring integrations in HertzBeat: Consul, DNS, Eureka, HTTP, Nacos, and Zookeeper. The documentation provides detailed configuration guides, usage examples, and best practices for automatically discovering and monitoring service instances through these service discovery mechanisms.
Changes:
- Added navigation entries in sidebars.json for a new "service-discovery" category with 6 service discovery methods
- Created bilingual documentation (English and Chinese) for each service discovery integration
- Provided detailed configuration parameters, usage steps, examples, and use cases for each method
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 16 comments.
Show a summary per file
| File | Description |
|---|---|
| home/sidebars.json | Added service-discovery category with 6 entries for navigation |
| home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/zookeeper_sd.md | Chinese documentation for Zookeeper service discovery |
| home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nacos_sd.md | Chinese documentation for Nacos service discovery |
| home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/http_sd.md | Chinese documentation for HTTP service discovery |
| home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/eureka_sd.md | Chinese documentation for Eureka service discovery |
| home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns_sd.md | Chinese documentation for DNS service discovery |
| home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/consul_sd.md | Chinese documentation for Consul service discovery |
| home/docs/help/zookeeper_sd.md | English documentation for Zookeeper service discovery |
| home/docs/help/nacos_sd.md | English documentation for Nacos service discovery |
| home/docs/help/http_sd.md | English documentation for HTTP service discovery |
| home/docs/help/eureka_sd.md | English documentation for Eureka service discovery |
| home/docs/help/dns_sd.md | English documentation for DNS service discovery |
| home/docs/help/consul_sd.md | English documentation for Consul service discovery |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### 配置参数 | ||
|
|
||
| | 参数名称 | 参数帮助描述 | |
There was a problem hiding this comment.
The parameter table has inconsistent header formatting with a missing period. The table header should follow consistent punctuation style.
| | 参数名称 | 参数帮助描述 | | |
| | 参数名称 | 参数帮助描述。 | |
|
|
||
| ### 配置参数 | ||
|
|
||
| | 参数名称 | 参数帮助描述 | |
There was a problem hiding this comment.
The parameter table has inconsistent header formatting with a missing period. The table header should follow consistent punctuation style.
| | 参数名称 | 参数帮助描述 | | |
| | 参数名称 | 参数帮助描述。 | |
|
|
||
| Nacos Service Discovery allows HertzBeat to connect to your Nacos server and automatically discover all registered service instances. When a new service instance is registered or an existing instance goes offline, HertzBeat will automatically create or delete corresponding monitoring tasks, achieving automated monitoring in microservice environments. | ||
|
|
||
| ### PreRequisites |
There was a problem hiding this comment.
Inconsistent capitalization in section heading. "PreRequisites" should be "Prerequisites" (one word without camel case).
| ### PreRequisites | |
| ### Prerequisites |
|
|
||
| DNS Service Discovery allows HertzBeat to discover service instances by querying DNS records. This is a simple and reliable service discovery method that utilizes standard DNS infrastructure to find service instances. It is particularly suitable for environments using DNS SRV records or environments that need to discover services through DNS. | ||
|
|
||
| ### PreRequisites |
There was a problem hiding this comment.
Inconsistent capitalization in section heading. "PreRequisites" should be "Prerequisites" (one word without camel case).
| ### PreRequisites | |
| ### Prerequisites |
| | Target Name | Identify the name of this monitoring. The name needs to be unique | | ||
| | Eureka Service Discovery Url | Eureka server address. Example: `http://eureka-server:8761/eureka` | | ||
| | Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | | ||
| | Description remarks | For more information about identifying and describing this monitoring, users can note information here | |
There was a problem hiding this comment.
Missing period at the end of the parameter description. The sentence should end with proper punctuation for consistency with the table format.
| | Target Name | Identify the name of this monitoring. The name needs to be unique | | |
| | Eureka Service Discovery Url | Eureka server address. Example: `http://eureka-server:8761/eureka` | | |
| | Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | | |
| | Description remarks | For more information about identifying and describing this monitoring, users can note information here | | |
| | Target Name | Identify the name of this monitoring. The name needs to be unique. | | |
| | Eureka Service Discovery Url | Eureka server address. Example: `http://eureka-server:8761/eureka`. | | |
| | Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds.| | |
| | Description remarks | For more information about identifying and describing this monitoring, users can note information here. | |
|
|
||
| 1. Deploy Zookeeper server according to [Zookeeper official documentation](https://zookeeper.apache.org/doc/current/zookeeperStarted.html). | ||
| 2. Ensure Zookeeper server is accessible from HertzBeat. | ||
| 3. Verify Zookeeper is running properly using Zookeeper client tools |
There was a problem hiding this comment.
Missing period at the end of the sentence in the notes section. The sentence should end with proper punctuation.
| 3. Verify Zookeeper is running properly using Zookeeper client tools | |
| 3. Verify Zookeeper is running properly using Zookeeper client tools. |
|
|
||
| Consul Service Discovery allows HertzBeat to connect to your Consul server and automatically discover all registered service instances. When a new service instance is registered or an existing instance goes offline, HertzBeat will automatically create or delete corresponding monitoring tasks, achieving automated monitoring in microservice environments. | ||
|
|
||
| ### PreRequisites |
There was a problem hiding this comment.
Inconsistent capitalization in section heading. "PreRequisites" should be "Prerequisites" (one word without camel case).
| ### PreRequisites | |
| ### Prerequisites |
|
|
||
| | Parameter name | Parameter help description | | ||
| |---------------------|-------------------------------------------------------------------------------------------------------------------------| | ||
| | Target Name | Identify the name of this monitoring. The name needs to be unique | |
There was a problem hiding this comment.
Missing period at the end of the parameter description. The sentence should end with proper punctuation for consistency with the table format.
| | Target Name | Identify the name of this monitoring. The name needs to be unique | | |
| | Target Name | Identify the name of this monitoring. The name needs to be unique. | |
| | Target Name | Identify the name of this monitoring. The name needs to be unique | | ||
| | Eureka Service Discovery Url | Eureka server address. Example: `http://eureka-server:8761/eureka` | | ||
| | Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | | ||
| | Description remarks | For more information about identifying and describing this monitoring, users can note information here | |
There was a problem hiding this comment.
Missing period at the end of the parameter description. The sentence should end with proper punctuation for consistency with the table format.
| | Target Name | Identify the name of this monitoring. The name needs to be unique | | |
| | Eureka Service Discovery Url | Eureka server address. Example: `http://eureka-server:8761/eureka` | | |
| | Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | | |
| | Description remarks | For more information about identifying and describing this monitoring, users can note information here | | |
| | Target Name | Identify the name of this monitoring. The name needs to be unique. | | |
| | Eureka Service Discovery Url | Eureka server address. Example: `http://eureka-server:8761/eureka` | | |
| | Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. | | |
| | Description remarks | For more information about identifying and describing this monitoring, users can note information here. | |
|
|
||
| Zookeeper Service Discovery allows HertzBeat to connect to your Zookeeper server and automatically discover service instance information stored in specific path nodes. This is commonly used in Dubbo and other RPC frameworks that use Zookeeper as a registry center. When service instances change, HertzBeat will automatically create or delete corresponding monitoring tasks. | ||
|
|
||
| ### PreRequisites |
There was a problem hiding this comment.
Inconsistent capitalization in section heading. "PreRequisites" should be "Prerequisites" (one word without camel case).
| ### PreRequisites | |
| ### Prerequisites |
1 participant
This pull request adds comprehensive documentation for three new service discovery monitoring integrations in HertzBeat: Consul, DNS, and Eureka. Each document provides step-by-step guides, configuration parameters, usage examples, best practices, and use cases for automatically discovering and monitoring service instances via these service discovery mechanisms.
New Service Discovery Documentation:
Consul Service Discovery:
consul_sd.mdwith detailed instructions for configuring HertzBeat to monitor services registered in Consul, including prerequisites, configuration parameters, usage steps, and integration notes.DNS Service Discovery:
dns_sd.mdcovering how to use DNS records (SRV, A, AAAA, MX, NS) for automatic service discovery, with examples for different record types, Kubernetes integration, and best practices for DNS-based monitoring.Eureka Service Discovery:
eureka_sd.mdwith guidance on monitoring services registered in a Eureka registry, including setup, configuration, automatic discovery, and operational considerations.