Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:add upload download add bandwidth limit #411

Merged
merged 4 commits into from
May 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ type StorageProviderConfig struct {
RateLimiter *localhttp.RateLimiterConfig
DiscontinueCfg *stopserving.DiscontinueConfig
MetadataCfg *metadata.MetadataConfig
BandwidthLimiter *localhttp.BandwidthLimiterConfig
}

// JSONMarshal marshal the StorageProviderConfig to json format
Expand Down Expand Up @@ -111,6 +112,7 @@ var DefaultStorageProviderConfig = &StorageProviderConfig{
RateLimiter: DefaultRateLimiterConfig,
DiscontinueCfg: stopserving.DefaultDiscontinueConfig,
MetadataCfg: DefaultMetadataConfig,
BandwidthLimiter: DefaultBandwidthLimiterConfig,
}

// DefaultSQLDBConfig defines the default configuration of SQL DB
Expand Down Expand Up @@ -208,6 +210,12 @@ var DefaultRateLimiterConfig = &localhttp.RateLimiterConfig{
},
}

var DefaultBandwidthLimiterConfig = &localhttp.BandwidthLimiterConfig{
Enable: false,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe you need to update the default configuration synchronously at config/config_template.toml.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

R: 100,
B: 1000,
}

// LoadConfig loads the config file from path
func LoadConfig(path string) *StorageProviderConfig {
f, err := os.Open(path)
Expand Down
7 changes: 7 additions & 0 deletions config/config_template.toml
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,16 @@ On = false
RateLimit = 1
RatePeriod = "S"

[BandwidthLimiter]
Enable = false
R = 100
B = 1000

[StopServingCfg]
BucketKeepAliveDays = 7

[MetadataCfg]
IsMasterDB = true
BsDBSwitchCheckIntervalSec = 3600


5 changes: 5 additions & 0 deletions config/subconfig.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,11 @@ func (cfg *StorageProviderConfig) MakeGatewayConfig() (*gateway.GatewayConfig, e
APILimits: apiLimitsMap,
HTTPLimitCfg: cfg.RateLimiter.HTTPLimitCfg,
}
gCfg.BandwidthLimitCfg = &localhttp.BandwidthLimiterConfig{
Enable: false,
R: 100,
B: 1000,
}
}
return gCfg, nil
}
Expand Down
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ require (
require (
github.com/cosmos/cosmos-proto v1.0.0-beta.1 // indirect
golang.org/x/mod v0.9.0 // indirect
golang.org/x/time v0.3.0 // indirect
golang.org/x/tools v0.7.0 // indirect
)

Expand Down
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -2258,6 +2258,8 @@ golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxb
golang.org/x/time v0.0.0-20200630173020-3af7569d3a1e/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/time v0.0.0-20210220033141-f8bda1e9f3ba/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
golang.org/x/time v0.3.0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/tools v0.0.0-20180525024113-a5b4c53f6e8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20180828015842-6cd1fcedba52/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
Expand Down
31 changes: 31 additions & 0 deletions pkg/middleware/http/tokenBucket.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package http

import (
"sync"

"github.com/bnb-chain/greenfield-storage-provider/pkg/log"
"golang.org/x/time/rate"
)

type BandwidthLimiterConfig struct {
Enable bool //Enable Whether to enable bandwidth limiting
R rate.Limit //R The speed at which tokens are generated R per second
B int //B The size of the token bucket
}

type BandwidthLimiter struct {
Limiter *rate.Limiter
}

var LimiterOnce sync.Once
var BandwidthLimit *BandwidthLimiter

func NewBandwidthLimiter(r rate.Limit, b int) {
log.Infof("config r: %v, b:%d", r, b)

LimiterOnce.Do(func() {
BandwidthLimit = &BandwidthLimiter{
Limiter: rate.NewLimiter(r, b),
}
})
}
3 changes: 3 additions & 0 deletions service/gateway/gateway.go
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,9 @@ func (gateway *Gateway) serve() {
log.Errorw("failed to new api limiter", "err", err)
return
}
if gateway.config.BandwidthLimitCfg.Enable {
localhttp.NewBandwidthLimiter(gateway.config.BandwidthLimitCfg.R, gateway.config.BandwidthLimitCfg.B)
}
gateway.registerHandler(router)
server := &http.Server{
Addr: gateway.config.HTTPAddress,
Expand Down
1 change: 1 addition & 0 deletions service/gateway/gateway_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ type GatewayConfig struct {
MetadataServiceAddress string
AuthServiceAddress string
APILimiterCfg *localhttp.APILimiterConfig
BandwidthLimitCfg *localhttp.BandwidthLimiterConfig
}
14 changes: 13 additions & 1 deletion service/gateway/object_handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
"github.com/bnb-chain/greenfield-storage-provider/model"
merrors "github.com/bnb-chain/greenfield-storage-provider/model/errors"
"github.com/bnb-chain/greenfield-storage-provider/pkg/log"
localHttp "github.com/bnb-chain/greenfield-storage-provider/pkg/middleware/http"
"github.com/bnb-chain/greenfield-storage-provider/service/downloader/types"
metatypes "github.com/bnb-chain/greenfield-storage-provider/service/metadata/types"
uploadertypes "github.com/bnb-chain/greenfield-storage-provider/service/uploader/types"
Expand Down Expand Up @@ -117,7 +118,12 @@ func (gateway *Gateway) getObjectHandler(w http.ResponseWriter, r *http.Request)
errDescription = makeErrorDescription(merrors.GRPCErrorToInnerError(err))
return
}

// If it is limited, it will block
if localHttp.BandwidthLimit != nil {
if err := localHttp.BandwidthLimit.Limiter.Wait(ctx); err != nil {
log.Errorw("failed to wait bandwidth limiter", "error", err)
}
}
if readN = len(resp.Data); readN == 0 {
log.Errorw("failed to get object due to return empty data", "response", resp)
continue
Expand Down Expand Up @@ -223,6 +229,12 @@ func (gateway *Gateway) putObjectHandler(w http.ResponseWriter, r *http.Request)
return
}
if readN > 0 {
// If it is limited, it will block
if localHttp.BandwidthLimit != nil {
if err := localHttp.BandwidthLimit.Limiter.Wait(ctx); err != nil {
log.Errorw("failed to wait bandwidth limiter", "error", err)
}
}
req := &uploadertypes.PutObjectRequest{
ObjectInfo: reqContext.objectInfo,
Payload: buf[:readN],
Expand Down