apollo-java icon indicating copy to clipboard operation
apollo-java copied to clipboard

[OSPP]Add more observability in apollo config client

Open Rawven opened this issue 1 year ago • 9 comments

What's the purpose of this PR

discussions OSPP2024 test cases Test

Which issue(s) this PR fixes:

Issue

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

Summary by CodeRabbit

  • New Features

    • Introduced several monitoring APIs for exceptions, namespaces, running parameters, and thread pools, enhancing visibility into system performance.
    • Launched the ApolloClientBootstrapArgsMonitorApi, ApolloClientNamespaceMonitorApi, and ApolloClientThreadPoolMonitorApi to manage configuration parameters and resource metrics.
    • Enhanced monitoring capabilities with structured logging for metrics and events.
    • Added a ConfigMonitorInitializer class to facilitate the setup of monitoring components.
  • Improvements

    • Enhanced error handling in various services by using defined constants for logging.
    • Updated metrics collection mechanisms to track configuration loading durations and exception occurrences efficiently.
    • Added new configuration properties for improved control over monitoring settings.
  • Bug Fixes

    • Refined logging and error tracking to ensure consistency and accuracy in reporting metrics.
  • Tests

    • Introduced comprehensive unit tests for newly added monitoring features and functionality.
    • Added performance tests to validate the robustness of monitoring under stress conditions.
    • Implemented tests for the ApolloClientMonitorContext and ApolloClientMetricsExporter to ensure correct functionality.

Rawven avatar Aug 01 '24 09:08 Rawven

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

github-actions[bot] avatar Aug 01 '24 09:08 github-actions[bot]

I have read the CLA Document and I hereby sign the CLA

Rawven avatar Aug 01 '24 09:08 Rawven

## Walkthrough
The changes in this pull request involve an update to the `CHANGES.md` file, specifically the addition of a new entry for Apollo Java version 2.4.0. This entry documents the feature "Add more observability in apollo config client," which is linked to pull request #74. The update is part of the release notes and is positioned alongside existing entries that cover various fixes and features related to configuration bean definitions and open API query namespace support.

## Changes

| Files            | Change Summary                                                                                           |
|------------------|---------------------------------------------------------------------------------------------------------|
| `.../CHANGES.md` | Added new entry: "Add more observability in apollo config client" for Apollo Java version 2.4.0.       |

## Possibly related PRs
- #78: This PR updates the version to 2.4.0-SNAPSHOT and reflects changes in the `CHANGES.md` file, which is directly related to the addition of the new entry for "Add more observability in apollo config client" in the main PR.

> 🐇 "In the garden, changes sprout,  
> Observability, there's no doubt!  
> Apollo's notes now sing with glee,  
> Config insights, wild and free!  
> With every hop, we celebrate,  
> New features bloom, oh, isn’t it great!" 🌼

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 004df5241d0a66a8bfa330ee04a869b410929142 and d75df39770552a8741f078ab00c73ebe36ca215c.

📒 Files selected for processing (1)
  • CHANGES.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CHANGES.md

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

coderabbitai[bot] avatar Aug 01 '24 09:08 coderabbitai[bot]

@Anilople PTAL

Rawven avatar Aug 01 '24 10:08 Rawven

Congratulation to submit the pr, that will be a great start.

Anilople avatar Aug 03 '24 03:08 Anilople

A check failed, need to fix it

image

Anilople avatar Aug 03 '24 03:08 Anilople

Codecov Report

Attention: Patch coverage is 64.12121% with 296 lines in your changes missing coverage. Please review.

Project coverage is 68.07%. Comparing base (1fc9d27) to head (60958c4). Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...nal/tracer/ApolloClientMonitorMessageProducer.java 41.48% 52 Missing and 3 partials :warning:
...listener/impl/DefaultApolloClientNamespaceApi.java 49.36% 38 Missing and 2 partials :warning:
...ork/apollo/internals/ConfigMonitorInitializer.java 16.66% 31 Missing and 4 partials :warning:
...o/monitor/internal/ApolloClientMonitorContext.java 27.27% 16 Missing :warning:
...ener/AbstractApolloClientMonitorEventListener.java 65.90% 14 Missing and 1 partial :warning:
...tor/internal/jmx/ApolloClientJmxMBeanRegister.java 44.00% 13 Missing and 1 partial :warning:
...ernal/jmx/mbean/ApolloClientJmxNamespaceMBean.java 0.00% 14 Missing :warning:
...va/com/ctrip/framework/apollo/util/ConfigUtil.java 77.58% 7 Missing and 6 partials :warning:
.../exporter/AbstractApolloClientMetricsExporter.java 75.00% 8 Missing and 2 partials :warning:
...o/monitor/api/ApolloClientNamespaceMonitorApi.java 40.00% 9 Missing :warning:
... and 23 more
Additional details and impacted files
@@             Coverage Diff              @@
##               main      #74      +/-   ##
============================================
- Coverage     69.06%   68.07%   -1.00%     
- Complexity     1228     1412     +184     
============================================
  Files           172      206      +34     
  Lines          5260     6051     +791     
  Branches        570      615      +45     
============================================
+ Hits           3633     4119     +486     
- Misses         1362     1630     +268     
- Partials        265      302      +37     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Aug 03 '24 17:08 codecov[bot]

The overall design becomes complete and unit tests begin to be written.

Rawven avatar Aug 18 '24 05:08 Rawven

@apolloconfig/committers hello, guys, after a long time review and code change, I think it time to merge this pr.

Need help, please take a look, is there something to watch out or change, or other suggestion?

Anilople avatar Sep 21 '24 06:09 Anilople

@nobodyiam Sir, the unnecessary modifications and formatting issues have been resolved.

Rawven avatar Oct 12 '24 13:10 Rawven