Skip to content
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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Rawven
Copy link

@Rawven Rawven commented Sep 10, 2024

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:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit tests to verify the code.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Update the CHANGES log.

Summary by CodeRabbit

  • New Features

    • Enhanced monitoring capabilities for the Apollo client, including configuration options for enabling and customizing monitoring.
    • Integration with Prometheus for metrics export, with detailed configuration examples provided.
    • Introduction of a new API for retrieving various metrics and status information programmatically.
  • Documentation

    • Added comprehensive guides for monitoring features and integration with custom monitoring systems, specifically for Prometheus.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Sep 10, 2024
Copy link
Contributor

coderabbitai bot commented Sep 10, 2024

Walkthrough

The 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 app.properties and YAML files. The integration of Prometheus for metrics export is detailed, along with a new API for ConfigMonitor. Additionally, a Java client extension for custom monitoring systems is added, specifically for Prometheus, providing methods for metric registration and initialization.

Changes

Files Change Summary
docs/zh/client/java-sdk-user-guide.md, docs/zh/extension/java-client-how-to-use-custom-monitor-system.md Added sections on monitoring capabilities, configuration options, Prometheus integration, and custom monitoring extensions.
src/main/java/com/ctrip/framework/apollo/monitor/internal/exporter/* Introduced new classes and methods for metrics exporting, including ApolloClientMetricsExporter and PrometheusApolloClientMetricsExporter.

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
Loading

Poem

🐇 In the meadow where data flows,
Monitoring blooms, as knowledge grows.
With Prometheus by our side,
Metrics dance, and insights glide.
Hooray for changes, bright and new,
A leap for clients, just for you! 🌼

Tip

Announcements
  • The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
  • We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 31e6486 and 15f108b.

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)


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits

Files that changed from the base of the PR and between 31e6486 and 15f108b.

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)
Copy link
Contributor

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)

@Rawven
Copy link
Author

Rawven commented Sep 10, 2024

@Anilople PTAL

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant