search

vdaas / vald

Vald. A Highly Scalable Distributed Vector Search Engine
https://vald.vdaas.org
Apache License 2.0
1.51k stars 75 forks source link

[WIP] Implement ngt Statistics API #2533

Closed kpango closed 1 month ago

kpango commented 1 month ago

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

Related Issue

Versions

Checklist

Special notes for your reviewer

coderabbitai[bot] commented 1 month ago

[!IMPORTANT]

Review skipped

Ignore keyword(s) in the title.

Ignored keywords (3) * WIP * DO NOT MERGE * DNM

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
vdaas-ci commented 1 month ago

[CHATOPS:HELP] ChatOps commands.

cloudflare-pages[bot] commented 1 month ago

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: 714027d
Status: ✅  Deploy successful!
Preview URL: https://898c68e1.vald.pages.dev
Branch Preview URL: https://feature-agent-ngt-statistics.vald.pages.dev

View logs

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 0.94340% with 315 lines in your changes missing coverage. Please review.

Project coverage is 7.90%. Comparing base (76eb8d7) to head (e445bb1). Report is 1 commits behind head on main.

Files Patch % Lines
apis/grpc/v1/payload/payload.pb.go 0.48% 205 Missing :warning:
internal/core/algorithm/ngt/ngt.go 0.00% 62 Missing :warning:
apis/grpc/v1/vald/index_vtproto.pb.go 0.00% 40 Missing :warning:
apis/grpc/v1/payload/payload.pb.json.go 0.00% 8 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2533 +/- ## ========================================== - Coverage 18.43% 7.90% -10.54% ========================================== Files 566 162 -404 Lines 66342 35872 -30470 ========================================== - Hits 12232 2835 -9397 + Misses 53320 32736 -20584 + Partials 790 301 -489 ```

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

vdaas-ci commented 1 month ago

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