Backport PR #2539 to release/v1.7 for Implement ngt Statistics API #2547

vdaas-ci · 2024-07-26T06:50:49Z

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

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

Signed-off-by: kpango <[email protected]>

cloudflare-workers-and-pages · 2024-07-26T06:50:51Z

Deploying vald with Cloudflare Pages

Latest commit:	`cbea3d2`
Status:	✅ Deploy successful!
Preview URL:	https://7e5a1aaf.vald.pages.dev
Branch Preview URL:	https://backport-release-v1-7-featur-lcq8.vald.pages.dev

View logs

coderabbitai · 2024-07-26T06:51:26Z

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

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.

vdaas-ci · 2024-07-26T07:28:52Z

[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 · 2024-07-26T07:29:06Z

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

github-actions · 2024-07-26T07:50:28Z

pkg/gateway/lb/handler/grpc/handler.go

+		return merged
+	}
+
+	var indegrees, outdegrees []int32


🚫 [golangci] _{reported by reviewdog 🐶}
Consider pre-allocating indegrees (prealloc)

github-actions · 2024-07-26T07:50:28Z

pkg/gateway/lb/handler/grpc/handler.go

+	}
+
+	var indegrees, outdegrees []int32
+	var indegreeCounts [][]int64


🚫 [golangci] _{reported by reviewdog 🐶}
Consider pre-allocating indegreeCounts (prealloc)

github-actions · 2024-07-26T07:50:28Z

pkg/gateway/lb/handler/grpc/handler.go

+
+	var indegrees, outdegrees []int32
+	var indegreeCounts [][]int64
+	var outdegreeHistograms, indegreeHistograms [][]uint64


🚫 [golangci] _{reported by reviewdog 🐶}
Consider pre-allocating outdegreeHistograms (prealloc)

github-actions · 2024-07-26T07:50:28Z

cmd/agent/core/faiss/main_test.go

+// 	type want struct{}
+// 	type test struct {
+// 		name       string
+// 		want       want


🚫 [golangci] _{reported by reviewdog 🐶}
Duplicate words (want) found (dupword)

github-actions · 2024-07-26T07:50:28Z

internal/config/benchmark_test.go

+//
+// func TestObjectConfig_Bind(t *testing.T) {
+// 	type fields struct {
+// 		FilterConfig FilterConfig


🚫 [golangci] _{reported by reviewdog 🐶}
Duplicate words (FilterConfig) found (dupword)

github-actions · 2024-07-26T07:50:28Z

pkg/tools/benchmark/job/service/insert_test.go

+// 	type fields struct {
+// 		eg                 errgroup.Group
+// 		dataset            *config.BenchmarkDataset
+// 		jobType            jobType


🚫 [golangci] _{reported by reviewdog 🐶}
Duplicate words (jobType) found (dupword)

github-actions · 2024-07-26T07:50:28Z

pkg/tools/benchmark/job/service/job_test.go

+// 	type fields struct {
+// 		eg                 errgroup.Group
+// 		dataset            *config.BenchmarkDataset
+// 		jobType            jobType


🚫 [golangci] _{reported by reviewdog 🐶}
Duplicate words (jobType) found (dupword)

github-actions · 2024-07-26T07:50:29Z

pkg/tools/benchmark/job/service/job_test.go

+// 	type fields struct {
+// 		eg                 errgroup.Group
+// 		dataset            *config.BenchmarkDataset
+// 		jobType            jobType


🚫 [golangci] _{reported by reviewdog 🐶}
Duplicate words (jobType) found (dupword)

github-actions · 2024-07-26T07:50:29Z

internal/observability/metrics/agent/core/ngt/ngt.go

@@ -61,8 +158,8 @@ func New(n service.NGT) metrics.Metric {
 	}
 }

-func (n *ngtMetrics) View() ([]metrics.View, error) {
-	return []metrics.View{
+func (n *ngtMetrics) View() (mv []metrics.View, err error) {


🚫 [golangci] _{reported by reviewdog 🐶}
Function name: View, Cyclomatic Complexity: 2, Halstead Volume: 5766.49, Maintainability Index: 17 (maintidx)

github-actions · 2024-07-26T07:50:29Z

internal/observability/metrics/agent/core/ngt/ngt.go

 }

-func (n *ngtMetrics) Register(m metrics.Meter) error {
-	indexCount, err := m.Int64ObservableGauge(
+func (n *ngtMetrics) Register(m metrics.Meter) (err error) {


🚫 [golangci] _{reported by reviewdog 🐶}
Function name: Register, Cyclomatic Complexity: 51, Halstead Volume: 12248.73, Maintainability Index: 4 (maintidx)

codecov · 2024-07-26T07:56:05Z

Codecov Report

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

Please upload report for BASE (release/v1.7@cdc5b0d). Learn more about missing BASE report.

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               @@
##             release/v1.7    #2547   +/-   ##
===============================================
  Coverage                ?   17.55%           
===============================================
  Files                   ?      566           
  Lines                   ?    68910           
  Branches                ?        0           
===============================================
  Hits                    ?    12099           
  Misses                  ?    55992           
  Partials                ?      819

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

fix: git add chart directory for release (#2356) (#2357) [patch] release v1.7.11 (#2358) :bookmark: :robot: Release v1.7.11 (#2360) Change docker scan timeout longer (#2363) (#2364) refactor code using golangci-lint (#2362) (#2365) Create SECURITY.md (#2367) (#2368) add commit hash build image (#2359) (#2371) update docker build target platform selection rules (#2370) (#2374) Make agent export index metrics to Pod k8s resource (#2319) (#2372) backport ci deps others (#2386) Update workflow to release readreplica chart (#2383) (#2387) :green_heart: :recycle: Add Con-Bench helm chart to the Vald charts (#2388) (#2389) Delete unnecessary code for mirror (#2366) (#2391) change JP logo to EN logo (#2369) (#2392) Add rotate-all option to rotator (#2305) (#2393) fix: build error of internal kvs test (#2396) (#2398) Resolve kvs already closed before last saving (#2390) (#2394) :robot: Update license headers / Format Go codes and YAML files (#2397) (#2400) create continous benchmark doc (#2352) (#2395) fix: disable protobuf dispatch for client (#2401) (#2403) update deps (#2404) (#2405) [patch] release v1.7.12 (#2406) :bookmark: :robot: Release v1.7.12 (#2408) :pencil: Fix typo of file name (#2413) (#2415) Fix agent-faiss build failed (#2418) (#2419) Add tests for index information export (#2412) (#2414) Fix the logic to determine docker image (#2410) (#2420) Update build rule for nightly image (#2421) (#2422) Fix output settings to determine-docker-image-tag action and release branch build tag name (#2423) (#2425) Add `index-operator` template implementation (#2375) (#2424) fix: typo of execution rule (#2426) (#2427) Backport Flush API (#2434) update deps & add validation for Flush API when agent is Read Only (#2433) (#2436) docs: add hrichiksite as a contributor for doc (#2441) (#2442) fix: bugfix version update for docker build (#2445) (#2446) Fix index job logic to pass DNS A record (#2438) (#2448) Added snapshot timestamp annotations to read replica agent (#2428) (#2443) Fix operator-sdk version (#2447) (#2449) add file name lint (#2417) (#2450) fix: add extra option for ci-container build (#2451) (#2452) Add base of benchmark operator dashboard (#2430) (#2453) Implement index operator logic for read replica rotation (#2444) (#2456) add inner product distance type for ngt (#2454) (#2458) Fix e2e for read replica and add e2e for index operator (#2455) (#2459) Add unit tests for index operator (#2460) (#2461) Bugfix recreate benchmark job when operator reboot (#2463) (#2464) Refactor k8s types (#2462) (#2465) :robot: Automatically update PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE (#2457) (#2469) Fix workflow trigger for backport pr creation (#2471) (#2472) Automatically add backport main label for release-pr (#2473) (#2475) update deps (#2468) (#2476) Implement client metrics interceptor for continuous benchmark job (#2477) (#2480) :chart_with_upwards_trend: Add client metrics panels for continuous benchmark job (#2481) (#2483) Update continuous benchmark docs (#2485) (#2486) Sync release/v1.7 to main (#2495) add read replica and rotator docs (#2497) (#2499) add reviewer guideline (#2507) (#2508) update large top-K ratio handling logic (#2509) (#2511) Change default image tag from latest to nightly (#2516) (#2518) Bugfix that caused an error when argument has 3 or more nil arguments (#2517) (#2520) add faiss in values.yaml & valdrelease.yaml (#2514) (#2519) capitalize faq (#2512) (#2522) Backport docs updates to release/v1.7 (#2521) [CI] Add workflow to synchronize ubuntu base image (#2526) (#2527) fix: update schedule (#2528) (#2530) refactor index manager service add index service API to expose index informations (#2525) (#2532) fix conflict bug (#2537) fix: make format (#2534) (#2540) Backport PR #2542, #2538 to release/v1.7 (#2543) fix: add checkout option (#2545) (#2546) Implement ngt Statistics API (#2539) (#2547) Add workflow to check git conflict for backport PR (#2548) (#2550) [create-pull-request] automated change (#2552) (#2556) Update dependencies, C++ standard, and improve Dockerfiles for better build systems and localization (#2549) (#2557) Backport #2559 (#2560) [BUGFIX] index correction process (#2565) (#2566) change external docker image reference to ghcr.io registry (#2567) (#2568) [patch] Release v1.7.13 (#2569) :bookmark: :robot: Release v1.7.13 (#2570) add HTTP2 support for http.Client and Vald HTTP Server (#2572) (#2575) Signed-off-by: kpango <[email protected]>

Implement ngt Statistics API (#2539)

cbea3d2

Signed-off-by: kpango <[email protected]>

github-actions bot reviewed Jul 26, 2024

View reviewed changes

kpango approved these changes Jul 26, 2024

View reviewed changes

kpango merged commit bc93d26 into release/v1.7 Jul 26, 2024
181 checks passed

kpango deleted the backport/release/v1.7/feature/agent/ngt-statistics-api branch July 26, 2024 20:50

github-actions bot mentioned this pull request Aug 1, 2024

Monthly review time metrics report: 2024-07-01..2024-07-31 #2555

Closed

This was referenced Aug 1, 2024

[patch] Release v1.7.3 #2558

Closed

[patch] Release v1.7.13 #2561

Closed

[patch] Release v1.7.13 #2562

Closed

[patch] Release v1.7.13 #2569

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Backport PR #2539 to release/v1.7 for Implement ngt Statistics API #2547

Backport PR #2539 to release/v1.7 for Implement ngt Statistics API #2547

vdaas-ci commented Jul 26, 2024

cloudflare-workers-and-pages bot commented Jul 26, 2024 •

edited

Loading

coderabbitai bot commented Jul 26, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

vdaas-ci commented Jul 26, 2024

vdaas-ci commented Jul 26, 2024

github-actions bot Jul 26, 2024

github-actions bot Jul 26, 2024

github-actions bot Jul 26, 2024

github-actions bot Jul 26, 2024

github-actions bot Jul 26, 2024

github-actions bot Jul 26, 2024

github-actions bot Jul 26, 2024

github-actions bot Jul 26, 2024

github-actions bot Jul 26, 2024

github-actions bot Jul 26, 2024

codecov bot commented Jul 26, 2024

Backport PR #2539 to release/v1.7 for Implement ngt Statistics API #2547

Backport PR #2539 to release/v1.7 for Implement ngt Statistics API #2547

Conversation

vdaas-ci commented Jul 26, 2024

Description

Summary

Changes

Additional Notes

Related Issue

Versions

Checklist

Special notes for your reviewer

cloudflare-workers-and-pages bot commented Jul 26, 2024 • edited Loading

Deploying vald with Cloudflare Pages

coderabbitai bot commented Jul 26, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

vdaas-ci commented Jul 26, 2024

vdaas-ci commented Jul 26, 2024

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

github-actions bot Jul 26, 2024

Choose a reason for hiding this comment

codecov bot commented Jul 26, 2024

Codecov Report

cloudflare-workers-and-pages bot commented Jul 26, 2024 •

edited

Loading

coderabbitai bot commented Jul 26, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)