-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add --set flag to set component's properties
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
- Loading branch information
1 parent
e1a90a3
commit 2a02f47
Showing
6 changed files
with
239 additions
and
6 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed 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 service | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/pflag" | ||
| "github.com/spf13/viper" | ||
|
|
||
| "go.opentelemetry.io/collector/config" | ||
| ) | ||
|
|
||
| const ( | ||
| setFlagName = "set" | ||
| setFlagFileType = "properties" | ||
| ) | ||
|
|
||
| func addSetFlag(flagSet *pflag.FlagSet) { | ||
| flagSet.StringArray(setFlagName, []string{}, "Set arbitrary component config property. The component has to be defined in the config file. The flag has a higher precedence over config file. The arrays are overridden. Example --set=processors.batch.timeout=2s") | ||
| } | ||
|
|
||
| // addSetFlagProperties sets/overrides properties from set flag(s) to supplied viper instance. | ||
| // The implementation reads set flag(s) from the cmd and passes the content to viper as .properties file. | ||
| func addSetFlagProperties(v *viper.Viper, cmd *cobra.Command) error { | ||
| flagProperties, err := cmd.Flags().GetStringArray(setFlagName) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if len(flagProperties) == 0 { | ||
| return nil | ||
| } | ||
| b := &bytes.Buffer{} | ||
| for _, property := range flagProperties { | ||
| property = strings.TrimSpace(property) | ||
| if _, err := fmt.Fprintf(b, "%s\n", property); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| viperFlags := config.NewViper() | ||
| viperFlags.SetConfigType(setFlagFileType) | ||
| if err := viperFlags.ReadConfig(b); err != nil { | ||
| return fmt.Errorf("failed to read set flag config: %v", err) | ||
| } | ||
|
|
||
| for key, value := range viperFlags.AllSettings() { | ||
| v.Set(key, value) | ||
| } | ||
| return nil | ||
| } |
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,58 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed 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 service | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/viper" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestSetFlags(t *testing.T) { | ||
| cmd := &cobra.Command{} | ||
| addSetFlag(cmd.Flags()) | ||
|
|
||
| err := cmd.ParseFlags([]string{ | ||
| "--set=processors.batch.timeout=2s", | ||
| "--set=processors.batch/foo.timeout=3s", | ||
| "--set=receivers.otlp.protocols.grpc.endpoint=localhost:1818", | ||
| "--set=exporters.kafka.brokers=foo:9200,foo2:9200", | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| v := viper.New() | ||
| require.Equal(t, 0, len(v.AllSettings())) | ||
| err = addSetFlagProperties(v, cmd) | ||
| require.NoError(t, err) | ||
|
|
||
| settings := v.AllSettings() | ||
| assert.Equal(t, 3, len(settings)) | ||
| assert.Equal(t, "2s", v.Get("processors.batch.timeout")) | ||
| assert.Equal(t, "3s", v.Get("processors.batch/foo.timeout")) | ||
| assert.Equal(t, "foo:9200,foo2:9200", v.Get("exporters.kafka.brokers")) | ||
| assert.Equal(t, "localhost:1818", v.Get("receivers.otlp.protocols.grpc.endpoint")) | ||
| } | ||
|
|
||
| func TestSetFlags_empty(t *testing.T) { | ||
| cmd := &cobra.Command{} | ||
| addSetFlag(cmd.Flags()) | ||
| v := viper.New() | ||
| err := addSetFlagProperties(v, cmd) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, 0, len(v.AllSettings())) | ||
| } |
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