-
-
Notifications
You must be signed in to change notification settings - Fork 10.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs]OSPP-Add more observability in apollo config client #5229
base: master
Are you sure you want to change the base?
Conversation
WalkthroughThe changes introduce enhancements to the Apollo client monitoring capabilities, particularly from version 2.4.0. A new configuration section allows users to enable and customize monitoring via Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ApolloClient
participant PrometheusExporter
participant CollectorRegistry
User->>ApolloClient: Configure monitoring
ApolloClient->>PrometheusExporter: Initialize exporter
PrometheusExporter->>CollectorRegistry: Register metrics
User->>ApolloClient: Request metrics
ApolloClient->>PrometheusExporter: Retrieve metrics
PrometheusExporter->>CollectorRegistry: Get metrics data
PrometheusExporter-->>User: Return Prometheus-compatible metrics
Poem
Tip Announcements
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (2)
Additional context usedLanguageTool
Markdownlint
Additional comments not posted (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (3)
docs/zh/extension/java-client-how-to-use-custom-monitor-system.md (3)
Line range hint
411-411
: Add alternate text to the image.Images should have alternate text for accessibility.
Add meaningful alternate text within the
[]
in the image markdown. For example:![Meaningful alt text describing the image](https://cdn.jsdelivr.net/gh/Rawven/image@main/2024-08-24-14-59-01-image.png)
Tools
LanguageTool
[uncategorized] ~82-~82: 您的意思是“"既"是”吗?
Context: ...ounterSample,registerOrUpdateGaugeSample即是用来注册Counter,Gauge类型指标的方法,只需要根据传来的参数正常注册...(JI11_JI2)
Markdownlint
141-141: null
Bare URL used(MD034, no-bare-urls)
Line range hint
542-542
: Add alternate text to the image.Images should have alternate text for accessibility.
Add meaningful alternate text within the
[]
in the image markdown. For example:![Meaningful alt text describing the image](https://raw.githubusercontent.com/Rawven/image/main/20240828003803.png)
Tools
LanguageTool
[uncategorized] ~82-~82: 您的意思是“"既"是”吗?
Context: ...ounterSample,registerOrUpdateGaugeSample即是用来注册Counter,Gauge类型指标的方法,只需要根据传来的参数正常注册...(JI11_JI2)
Markdownlint
141-141: null
Bare URL used(MD034, no-bare-urls)
Line range hint
576-576
: Specify the language for the fenced code block.Fenced code blocks should have a language specified for proper syntax highlighting.
Add the language after the opening triple backticks. For example:
```properties # TYPE apollo_client_thread_pool_queue_remaining_capacity gauge ...
Tools
LanguageTool
[uncategorized] ~82-~82: 您的意思是“"既"是”吗?
Context: ...ounterSample,registerOrUpdateGaugeSample即是用来注册Counter,Gauge类型指标的方法,只需要根据传来的参数正常注册...(JI11_JI2)
Markdownlint
141-141: null
Bare URL used(MD034, no-bare-urls)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/zh/client/java-sdk-user-guide.md (3 hunks)
- docs/zh/extension/java-client-how-to-use-custom-monitor-system.md (1 hunks)
Additional context used
LanguageTool
docs/zh/extension/java-client-how-to-use-custom-monitor-system.md
[uncategorized] ~82-~82: 您的意思是“"既"是”吗?
Context: ...ounterSample,registerOrUpdateGaugeSample即是用来注册Counter,Gauge类型指标的方法,只需要根据传来的参数正常注册...(JI11_JI2)
docs/zh/client/java-sdk-user-guide.md
[uncategorized] ~415-~415: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:方便"地"扩展
Context: ...Exporter的SPI使可用官方提供的或自己实现),这种设计是为了用户能更方便的扩展。多填,错填和不填则不启用任何Exporter。 具体使用见 扩展开发-j...(wb4)
Markdownlint
docs/zh/extension/java-client-how-to-use-custom-monitor-system.md
141-141: null
Bare URL used(MD034, no-bare-urls)
docs/zh/client/java-sdk-user-guide.md
411-411: null
Images should have alternate text (alt text)(MD045, no-alt-text)
576-576: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
542-542: null
Images should have alternate text (alt text)(MD045, no-alt-text)
659-659: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (1)
docs/zh/extension/java-client-how-to-use-custom-monitor-system.md (1)
Line range hint
415-415
:Tools
LanguageTool
[uncategorized] ~82-~82: 您的意思是“"既"是”吗?
Context: ...ounterSample,registerOrUpdateGaugeSample即是用来注册Counter,Gauge类型指标的方法,只需要根据传来的参数正常注册...(JI11_JI2)
Markdownlint
141-141: null
Bare URL used(MD034, no-bare-urls)
|
||
同时查看Prometheus控制台也能看到如下信息 | ||
|
||
![](https://raw.githubusercontent.com/Rawven/image/main/20240910002345.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add alternate text to the image.
Images should have alternate text for accessibility.
Add meaningful alternate text within the []
in the image markdown. For example:
![Meaningful alt text describing the image](https://raw.githubusercontent.com/Rawven/image/main/20240910002345.png)
Tools
Markdownlint
659-659: null
Images should have alternate text (alt text)(MD045, no-alt-text)
@Anilople PTAL |
What's the purpose of this PR
related pr apolloconfig/apollo-java#74
XXXXX
Which issue(s) this PR fixes:
Fixes #
Brief changelog
XXXXX
Follow this checklist to help us incorporate your contribution quickly and easily:
mvn clean test
to make sure this pull request doesn't break anything.CHANGES
log.Summary by CodeRabbit
New Features
Documentation