-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
172 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
internal/resources/providers/gcplib/inventory/grpc_rate_limiter.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| // Licensed to Elasticsearch B.V. under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Elasticsearch B.V. licenses this file to you under | ||
| // the Apache License, Version 2.0 (the "License"); you may | ||
| // not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| package inventory | ||
|
|
||
| import ( | ||
| "context" | ||
| "time" | ||
|
|
||
| "github.com/elastic/elastic-agent-libs/logp" | ||
| "github.com/googleapis/gax-go/v2" | ||
| "golang.org/x/time/rate" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/codes" | ||
| ) | ||
|
|
||
| // a gax.CallOption that defines a retry strategy which retries the request on ResourceExhausted error. | ||
| var RetryOnResourceExhausted = gax.WithRetry(func() gax.Retryer { | ||
| return gax.OnCodes([]codes.Code{codes.ResourceExhausted}, gax.Backoff{ | ||
| Initial: 1 * time.Second, | ||
| Max: 1 * time.Minute, | ||
| Multiplier: 1.2, | ||
| }) | ||
| }) | ||
|
|
||
| type AssetsInventoryRateLimiter struct { | ||
| methods map[string]*rate.Limiter | ||
| log *logp.Logger | ||
| } | ||
|
|
||
| // a map of asset inventory client methods and their quotas. | ||
| // see https://cloud.google.com/asset-inventory/docs/quota | ||
| var methods = map[string]*rate.Limiter{ | ||
| // using per-project quota suffices for both single-account and organization-account, because it's more restrictive. | ||
| "/google.cloud.asset.v1.AssetService/ListAssets": rate.NewLimiter(rate.Every(time.Minute/100), 1), | ||
| } | ||
|
|
||
| func NewAssetsInventoryRateLimiter(log *logp.Logger) *AssetsInventoryRateLimiter { | ||
| return &AssetsInventoryRateLimiter{ | ||
| log: log, | ||
| methods: methods, | ||
| } | ||
| } | ||
|
|
||
| // Limits the rate of the method calls defined in the methods map. | ||
| func (rl *AssetsInventoryRateLimiter) Wait(ctx context.Context, method string, req any) { | ||
| limiter := rl.methods[method] | ||
| if limiter != nil { | ||
| err := limiter.Wait(ctx) | ||
| if err != nil { | ||
| rl.log.Errorf("Failed to wait for project quota on method: %s, request: %v, error: %w", method, req, err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Returns a grpc.DialOption that intercepts the unary RPCs and limits the rate of the method calls. | ||
| func (rl *AssetsInventoryRateLimiter) GetInterceptorDialOption() grpc.DialOption { | ||
| return grpc.WithUnaryInterceptor(func(ctx context.Context, method string, req, reply any, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error { | ||
| rl.Wait(ctx, method, req) | ||
| return invoker(ctx, method, req, reply, cc, opts...) | ||
| }) | ||
| } |
64 changes: 64 additions & 0 deletions
64
internal/resources/providers/gcplib/inventory/grpc_rate_limiter_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // Licensed to Elasticsearch B.V. under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Elasticsearch B.V. licenses this file to you under | ||
| // the Apache License, Version 2.0 (the "License"); you may | ||
| // not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| package inventory | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/elastic/elastic-agent-libs/logp" | ||
| "github.com/stretchr/testify/suite" | ||
| "golang.org/x/time/rate" | ||
| ) | ||
|
|
||
| type RateLimiterTestSuite struct { | ||
| suite.Suite | ||
| logger *logp.Logger | ||
| rateLimiter *AssetsInventoryRateLimiter | ||
| } | ||
|
|
||
| func TestInventoryRateLimiterTestSuite(t *testing.T) { | ||
| suite.Run(t, new(RateLimiterTestSuite)) | ||
| } | ||
|
|
||
| func (s *RateLimiterTestSuite) SetupTest() { | ||
| s.logger = logp.NewLogger("test") | ||
| s.rateLimiter = NewAssetsInventoryRateLimiter(s.logger) | ||
| } | ||
|
|
||
| func (s *RateLimiterTestSuite) TestRateLimiterWait() { | ||
| ctx := context.Background() | ||
| duration := time.Millisecond | ||
| s.rateLimiter.methods = map[string]*rate.Limiter{ | ||
| "someMethod": rate.NewLimiter(rate.Every(duration/1), 1), // 1 request per duration | ||
| } | ||
|
|
||
| totalRequests := 5 | ||
| startTime := time.Now() | ||
| for i := 0; i < totalRequests; i++ { | ||
| s.rateLimiter.Wait(ctx, "someMethod", nil) | ||
| fmt.Println("request", i) | ||
| } | ||
| endTime := time.Now() | ||
|
|
||
| actualDuration := endTime.Sub(startTime) | ||
| minDuration := duration * time.Duration((totalRequests - 1)) // 1st request is instant, 2nd and above wait 1duration each | ||
| s.Assert().True(actualDuration >= minDuration, fmt.Sprintf("expected %v to be greater or equal than %v", actualDuration, minDuration)) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters