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

chore: remove dead object storage code from the ruler #12825

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 0 additions & 33 deletions pkg/ruler/base/storage.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,12 @@ import (

"github.com/go-kit/log"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
promRules "github.com/prometheus/prometheus/rules"

configClient "github.com/grafana/loki/v3/pkg/configs/client"
"github.com/grafana/loki/v3/pkg/ruler/rulestore"
"github.com/grafana/loki/v3/pkg/ruler/rulestore/bucketclient"
"github.com/grafana/loki/v3/pkg/ruler/rulestore/configdb"
"github.com/grafana/loki/v3/pkg/ruler/rulestore/local"
"github.com/grafana/loki/v3/pkg/ruler/rulestore/objectclient"
"github.com/grafana/loki/v3/pkg/storage"
"github.com/grafana/loki/v3/pkg/storage/bucket"
"github.com/grafana/loki/v3/pkg/storage/chunk/client"
"github.com/grafana/loki/v3/pkg/storage/chunk/client/alibaba"
"github.com/grafana/loki/v3/pkg/storage/chunk/client/aws"
Expand Down Expand Up @@ -121,31 +116,3 @@ func NewLegacyRuleStore(cfg RuleStoreConfig, hedgeCfg hedging.Config, clientMetr

return objectclient.NewRuleStore(client, loadRulesConcurrency, logger), nil
}

// NewRuleStore returns a rule store backend client based on the provided cfg.
func NewRuleStore(ctx context.Context, cfg rulestore.Config, cfgProvider bucket.TenantConfigProvider, loader promRules.GroupLoader, logger log.Logger, reg prometheus.Registerer) (rulestore.RuleStore, error) {
if cfg.Backend == configdb.Name {
c, err := configClient.New(cfg.ConfigDB)
if err != nil {
return nil, err
}

return configdb.NewConfigRuleStore(c), nil
}

if cfg.Backend == local.Name {
return local.NewLocalRulesClient(cfg.Local, loader)
}

bucketClient, err := bucket.NewClient(ctx, cfg.Config, "ruler-storage", logger, reg)
if err != nil {
return nil, err
}

store := bucketclient.NewBucketRuleStore(bucketClient, cfgProvider, logger)
if err != nil {
return nil, err
}

return store, nil
}
49 changes: 0 additions & 49 deletions pkg/storage/bucket/client.go
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
package bucket

import (
"context"
"errors"
"flag"
"fmt"
"strings"

"github.com/go-kit/log"
"github.com/prometheus/client_golang/prometheus"
"github.com/thanos-io/objstore"
opentracing "github.com/thanos-io/objstore/tracing/opentracing"

"github.com/grafana/loki/v3/pkg/storage/bucket/azure"
"github.com/grafana/loki/v3/pkg/storage/bucket/filesystem"
Expand Down Expand Up @@ -95,48 +91,3 @@ func (cfg *Config) Validate() error {

return nil
}

// NewClient creates a new bucket client based on the configured backend
func NewClient(ctx context.Context, cfg Config, name string, logger log.Logger, reg prometheus.Registerer) (client objstore.Bucket, err error) {
switch cfg.Backend {
case S3:
client, err = s3.NewBucketClient(cfg.S3, name, logger)
case GCS:
client, err = gcs.NewBucketClient(ctx, cfg.GCS, name, logger)
case Azure:
client, err = azure.NewBucketClient(cfg.Azure, name, logger)
case Swift:
client, err = swift.NewBucketClient(cfg.Swift, name, logger)
case Filesystem:
client, err = filesystem.NewBucketClient(cfg.Filesystem)
default:
return nil, ErrUnsupportedStorageBackend
}

if err != nil {
return nil, err
}

client = opentracing.WrapWithTraces(bucketWithMetrics(client, name, reg))

// Wrap the client with any provided middleware
for _, wrap := range cfg.Middlewares {
client, err = wrap(client)
if err != nil {
return nil, err
}
}

return client, nil
}

func bucketWithMetrics(bucketClient objstore.Bucket, name string, reg prometheus.Registerer) objstore.Bucket {
if reg == nil {
return bucketClient
}

return objstore.WrapWithMetrics(
bucketClient,
prometheus.WrapRegistererWith(prometheus.Labels{"component": name}, reg),
"")
}
58 changes: 0 additions & 58 deletions pkg/storage/bucket/client_test.go
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
package bucket

import (
"context"
"testing"

"github.com/grafana/dskit/flagext"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
yaml "gopkg.in/yaml.v2"

util_log "github.com/grafana/loki/v3/pkg/util/log"
)

const (
configWithS3Backend = `
backend: s3
Expand Down Expand Up @@ -46,49 +34,3 @@ gcs:
backend: unknown
`
)

func TestNewClient(t *testing.T) {
t.Parallel()

tests := map[string]struct {
config string
expectedErr error
}{
"should create an S3 bucket": {
config: configWithS3Backend,
expectedErr: nil,
},
"should create a GCS bucket": {
config: configWithGCSBackend,
expectedErr: nil,
},
"should return error on unknown backend": {
config: configWithUnknownBackend,
expectedErr: ErrUnsupportedStorageBackend,
},
}

for testName, testData := range tests {
testData := testData

t.Run(testName, func(t *testing.T) {
// Load config
cfg := Config{}
flagext.DefaultValues(&cfg)

err := yaml.Unmarshal([]byte(testData.config), &cfg)
require.NoError(t, err)

// Instance a new bucket client from the config
bucketClient, err := NewClient(context.Background(), cfg, "test", util_log.Logger, nil)
require.Equal(t, testData.expectedErr, err)

if testData.expectedErr == nil {
require.NotNil(t, bucketClient)
bucketClient.Close()
} else {
assert.Equal(t, nil, bucketClient)
}
})
}
}