Implement ngt Statistics API

[kpango]

Description

Summary

This pull request introduces several significant updates and enhancements, primarily focusing on adding new API functionalities for index statistics and improving observability metrics.

The _test.go and pb.go diffs are just re-generated please ignore them.

Changes

1. Protobuf Updates:

   • Added Info.Index.Statistics to apis/proto/v1/payload/payload.proto.
   • Introduced IndexStatistics and IndexStatisticsDetail APIs in apis/proto/v1/vald/index.proto to return Info.Index.Statistics.

2. Handler Implementations:

   • Implemented IndexStatistics and IndexStatisticsDetail API handlers in pkg/gateway/lb/handler/grpc/handler.go.
   • Added the same API handlers in pkg/agent/core/ngt/service/ngt.go.

3. Algorithm Enhancements:

   • Added GraphStatistics struct and GetGraphStatistics(m statisticsType) (stats *GraphStatistics, err error) function in internal/core/algorithm/ngt/ngt.go to enable retrieval of index statistics.
   • Incorporated logic to obtain GraphStatistics post CreateIndex based on options in pkg/agent/core/ngt/service/ngt.go.

4. Metrics Export:

   • Added export processing for GraphStatistics metrics in internal/observability/metrics/agent/core/ngt/ngt.go.
   • Introduced type aliases for Int64ObservableGauge and Float64ObservableGauge in internal/observability/metrics/metrics.go.

5. Configuration and Formatting:

   • Updated .github/workflows/format.yml to add ignore settings for Format and license.
   • Enhanced Makefile under format/go to include formatting of artifacts generated from Proto.

Additional Notes

• These changes enhance the functionality of the Vald project by providing detailed index statistics, which are crucial for monitoring and performance tuning.
• The observability improvements will facilitate better metric tracking and reporting, contributing to overall system stability and performance.

Related Issue

Versions

• Go Version: 1.22.5
• Rust Version: 1.77.2
• Docker Version: 20.10.8
• Kubernetes Version: v1.30.3
• NGT Version: 2.2.3

Checklist

• I have read the CONTRIBUTING document and completed our CLA agreement.
• I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

[vdaas-ci]

[CHATOPS:HELP] ChatOps commands.

• 🙆‍♀️ /approve - approve
• 🍱 /format - format codes and add licenses
• ✅ /gen-test - generate test codes
• 🏷️ /label - add labels
• 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

[vdaas-ci]

[WARNING:INTCFG] Changes in interal/config may require you to change Helm charts. Please check.

[coderabbitai]

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

94 files out of 263 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[codecov]

Codecov Report

Attention: Patch coverage is 0.83333% with 357 lines in your changes missing coverage. Please review.

Project coverage is 17.56%. Comparing base (76eb8d7) to head (4d9ae3e).
Report is 4 commits behind head on main.

Files	Patch %	Lines
apis/grpc/v1/payload/payload.pb.go	0.48%	205 Missing ⚠️
internal/core/algorithm/ngt/ngt.go	0.00%	62 Missing ⚠️
internal/client/v1/client/vald/vald.go	0.00%	42 Missing ⚠️
apis/grpc/v1/vald/index_vtproto.pb.go	0.00%	40 Missing ⚠️
apis/grpc/v1/payload/payload.pb.json.go	0.00%	8 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2539      +/-   ##
==========================================
- Coverage   18.43%   17.56%   -0.88%     
==========================================
  Files         566      566              
  Lines       66342    68910    +2568     
==========================================
- Hits        12232    12104     -128     
- Misses      53320    55986    +2666     
- Partials      790      820      +30     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cloudflare-workers-and-pages]

Deploying vald with    Cloudflare Pages

Latest commit:	4d9ae3e
Status:	✅  Deploy successful!
Preview URL:	https://c7735d4b.vald.pages.dev
Branch Preview URL:	https://feature-agent-ngt-statistics.vald.pages.dev

View logs

[github-actions]

[FOSSA] The scan result will be available at https://app.fossa.com/projects/custom%2B21465%2Fvald/refs/branch/feature%2Fagent%2Fngt-statistics-api/95b178d630e75b8be858a229cab52a4d6e63764e

[vdaas-ci]

Profile Report

type	vald-agent-ngt	vald-lb-gateway	vald-discoverer	vald-manager-index
cpu
heap

other images