-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Mahad Zaryab <[email protected]>
- Loading branch information
1 parent
a9e5e47
commit 0a3822f
Showing
11 changed files
with
156 additions
and
138 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
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
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
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
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
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
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,83 @@ | ||
| // Copyright (c) 2024 The Jaeger Authors. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package badger | ||
|
|
||
| import ( | ||
| "flag" | ||
|
|
||
| "github.com/spf13/viper" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
||
| const ( | ||
| prefix = "badger" | ||
| suffixKeyDirectory = ".directory-key" | ||
| suffixValueDirectory = ".directory-value" | ||
| suffixEphemeral = ".ephemeral" | ||
| suffixSpanstoreTTL = ".span-store-ttl" | ||
| suffixSyncWrite = ".consistency" | ||
| suffixMaintenanceInterval = ".maintenance-interval" | ||
| suffixMetricsInterval = ".metrics-update-interval" // Intended only for testing purposes | ||
| suffixReadOnly = ".read-only" | ||
| ) | ||
|
|
||
| // AddFlags adds flags for Config. | ||
| func (c *Config) AddFlags(flagSet *flag.FlagSet) { | ||
| flagSet.Bool( | ||
| prefix+suffixEphemeral, | ||
| c.Ephemeral, | ||
| "Mark this storage ephemeral, data is stored in tmpfs.", | ||
| ) | ||
| flagSet.Duration( | ||
| prefix+suffixSpanstoreTTL, | ||
| c.TTL.Spans, | ||
| "How long to store the data. Format is time.Duration (https://golang.org/pkg/time/#Duration)", | ||
| ) | ||
| flagSet.String( | ||
| prefix+suffixKeyDirectory, | ||
| c.Directories.Keys, | ||
| "Path to store the keys (indexes), this directory should reside in SSD disk. Set ephemeral to false if you want to define this setting.", | ||
| ) | ||
| flagSet.String( | ||
| prefix+suffixValueDirectory, | ||
| c.Directories.Values, | ||
| "Path to store the values (spans). Set ephemeral to false if you want to define this setting.", | ||
| ) | ||
| flagSet.Bool( | ||
| prefix+suffixSyncWrite, | ||
| c.SyncWrites, | ||
| "If all writes should be synced immediately to physical disk. This will impact write performance.", | ||
| ) | ||
| flagSet.Duration( | ||
| prefix+suffixMaintenanceInterval, | ||
| c.MaintenanceInterval, | ||
| "How often the maintenance thread for values is ran. Format is time.Duration (https://golang.org/pkg/time/#Duration)", | ||
| ) | ||
| flagSet.Duration( | ||
| prefix+suffixMetricsInterval, | ||
| c.MetricsUpdateInterval, | ||
| "How often the badger metrics are collected by Jaeger. Format is time.Duration (https://golang.org/pkg/time/#Duration)", | ||
| ) | ||
| flagSet.Bool( | ||
| prefix+suffixReadOnly, | ||
| c.ReadOnly, | ||
| "Allows to open badger database in read only mode. Multiple instances can open same database in read-only mode. Values still in the write-ahead-log must be replayed before opening.", | ||
| ) | ||
| } | ||
|
|
||
| // InitFromViper initializes Config with properties from viper. | ||
| func (c *Config) InitFromViper(v *viper.Viper, logger *zap.Logger) { | ||
| initFromViper(c, v, logger) | ||
| } | ||
|
|
||
| func initFromViper(config *Config, v *viper.Viper, _ *zap.Logger) { | ||
| config.Ephemeral = v.GetBool(prefix + suffixEphemeral) | ||
| config.Directories.Keys = v.GetString(prefix + suffixKeyDirectory) | ||
| config.Directories.Values = v.GetString(prefix + suffixValueDirectory) | ||
| config.SyncWrites = v.GetBool(prefix + suffixSyncWrite) | ||
| config.TTL.Spans = v.GetDuration(prefix + suffixSpanstoreTTL) | ||
| config.MaintenanceInterval = v.GetDuration(prefix + suffixMaintenanceInterval) | ||
| config.MetricsUpdateInterval = v.GetDuration(prefix + suffixMetricsInterval) | ||
| config.ReadOnly = v.GetBool(prefix + suffixReadOnly) | ||
| } |
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,55 @@ | ||
| // Copyright (c) 2024 The Jaeger Authors. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package badger | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "go.uber.org/zap" | ||
|
|
||
| "github.com/jaegertracing/jaeger/pkg/config" | ||
| ) | ||
|
|
||
| func TestDefaultConfigParsing(t *testing.T) { | ||
| cfg := DefaultConfig() | ||
| v, command := config.Viperize(cfg.AddFlags) | ||
| command.ParseFlags([]string{}) | ||
| cfg.InitFromViper(v, zap.NewNop()) | ||
|
|
||
| assert.True(t, cfg.Ephemeral) | ||
| assert.False(t, cfg.SyncWrites) | ||
| assert.Equal(t, time.Duration(72*time.Hour), cfg.TTL.Spans) | ||
| } | ||
|
|
||
| func TestParseConfig(t *testing.T) { | ||
| cfg := DefaultConfig() | ||
| v, command := config.Viperize(cfg.AddFlags) | ||
| command.ParseFlags([]string{ | ||
| "--badger.ephemeral=false", | ||
| "--badger.consistency=true", | ||
| "--badger.directory-key=/var/lib/badger", | ||
| "--badger.directory-value=/mnt/slow/badger", | ||
| "--badger.span-store-ttl=168h", | ||
| }) | ||
| cfg.InitFromViper(v, zap.NewNop()) | ||
|
|
||
| assert.False(t, cfg.Ephemeral) | ||
| assert.True(t, cfg.SyncWrites) | ||
| assert.Equal(t, time.Duration(168*time.Hour), cfg.TTL.Spans) | ||
| assert.Equal(t, "/var/lib/badger", cfg.Directories.Keys) | ||
| assert.Equal(t, "/mnt/slow/badger", cfg.Directories.Values) | ||
| assert.False(t, cfg.ReadOnly) | ||
| } | ||
|
|
||
| func TestReadOnlyConfig(t *testing.T) { | ||
| cfg := DefaultConfig() | ||
| v, command := config.Viperize(cfg.AddFlags) | ||
| command.ParseFlags([]string{ | ||
| "--badger.read-only=true", | ||
| }) | ||
| cfg.InitFromViper(v, zap.NewNop()) | ||
| assert.True(t, cfg.ReadOnly) | ||
| } |
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
Oops, something went wrong.