1212// See the License for the specific language governing permissions and
1313// limitations under the License.
1414
15- package configparser
15+ package config
1616
1717import (
1818 "fmt"
@@ -35,58 +35,59 @@ const (
3535 KeyDelimiter = "::"
3636)
3737
38- // NewConfigMap creates a new empty ConfigMap instance.
39- func NewConfigMap () * ConfigMap {
40- return & ConfigMap {k : koanf .New (KeyDelimiter )}
38+ // NewMap creates a new empty config.Map instance.
39+ func NewMap () * Map {
40+ return & Map {k : koanf .New (KeyDelimiter )}
4141}
4242
43- // NewConfigMapFromFile creates a new ConfigMap by reading the given file.
44- func NewConfigMapFromFile (fileName string ) (* ConfigMap , error ) {
43+ // NewMapFromFile creates a new config.Map by reading the given file.
44+ func NewMapFromFile (fileName string ) (* Map , error ) {
4545 // Read yaml config from file.
46- p := NewConfigMap ()
46+ p := NewMap ()
4747 if err := p .k .Load (file .Provider (fileName ), yaml .Parser ()); err != nil {
4848 return nil , fmt .Errorf ("unable to read the file %v: %w" , fileName , err )
4949 }
5050 return p , nil
5151}
5252
53- // NewConfigMapFromBuffer creates a new ConfigMap by reading the given yaml buffer.
54- func NewConfigMapFromBuffer (buf io.Reader ) (* ConfigMap , error ) {
53+ // NewMapFromBuffer creates a new config.Map by reading the given yaml buffer.
54+ func NewMapFromBuffer (buf io.Reader ) (* Map , error ) {
5555 content , err := ioutil .ReadAll (buf )
5656 if err != nil {
5757 return nil , err
5858 }
5959
60- p := NewConfigMap ()
60+ p := NewMap ()
6161 if err := p .k .Load (rawbytes .Provider (content ), yaml .Parser ()); err != nil {
6262 return nil , err
6363 }
6464
6565 return p , nil
6666}
6767
68- // NewConfigMapFromStringMap creates a ConfigMap from a map[string]interface{}.
69- func NewConfigMapFromStringMap (data map [string ]interface {}) * ConfigMap {
70- p := NewConfigMap ()
68+ // NewMapFromStringMap creates a config.Map from a map[string]interface{}.
69+ func NewMapFromStringMap (data map [string ]interface {}) * Map {
70+ p := NewMap ()
7171 // Cannot return error because the koanf instance is empty.
7272 _ = p .k .Load (confmap .Provider (data , KeyDelimiter ), nil )
7373 return p
7474}
7575
76- // ConfigMap loads configuration.
77- type ConfigMap struct {
76+ // Map represents the raw configuration map for the OpenTelemetry Collector.
77+ // The config.Map can be unmarshalled into the Collector's config using the "configunmarshaler" package.
78+ type Map struct {
7879 k * koanf.Koanf
7980}
8081
8182// AllKeys returns all keys holding a value, regardless of where they are set.
8283// Nested keys are returned with a KeyDelimiter separator.
83- func (l * ConfigMap ) AllKeys () []string {
84+ func (l * Map ) AllKeys () []string {
8485 return l .k .Keys ()
8586}
8687
8788// Unmarshal unmarshalls the config into a struct.
8889// Tags on the fields of the structure must be properly set.
89- func (l * ConfigMap ) Unmarshal (rawVal interface {}) error {
90+ func (l * Map ) Unmarshal (rawVal interface {}) error {
9091 decoder , err := mapstructure .NewDecoder (decoderConfig (rawVal ))
9192 if err != nil {
9293 return err
@@ -95,7 +96,7 @@ func (l *ConfigMap) Unmarshal(rawVal interface{}) error {
9596}
9697
9798// UnmarshalExact unmarshalls the config into a struct, erroring if a field is nonexistent.
98- func (l * ConfigMap ) UnmarshalExact (intoCfg interface {}) error {
99+ func (l * Map ) UnmarshalExact (intoCfg interface {}) error {
99100 dc := decoderConfig (intoCfg )
100101 dc .ErrorUnused = true
101102 decoder , err := mapstructure .NewDecoder (dc )
@@ -106,12 +107,12 @@ func (l *ConfigMap) UnmarshalExact(intoCfg interface{}) error {
106107}
107108
108109// Get can retrieve any value given the key to use.
109- func (l * ConfigMap ) Get (key string ) interface {} {
110+ func (l * Map ) Get (key string ) interface {} {
110111 return l .k .Get (key )
111112}
112113
113114// Set sets the value for the key.
114- func (l * ConfigMap ) Set (key string , value interface {}) {
115+ func (l * Map ) Set (key string , value interface {}) {
115116 // koanf doesn't offer a direct setting mechanism so merging is required.
116117 merged := koanf .New (KeyDelimiter )
117118 _ = merged .Load (confmap .Provider (map [string ]interface {}{key : value }, KeyDelimiter ), nil )
@@ -120,34 +121,34 @@ func (l *ConfigMap) Set(key string, value interface{}) {
120121
121122// IsSet checks to see if the key has been set in any of the data locations.
122123// IsSet is case-insensitive for a key.
123- func (l * ConfigMap ) IsSet (key string ) bool {
124+ func (l * Map ) IsSet (key string ) bool {
124125 return l .k .Exists (key )
125126}
126127
127128// Merge merges the input given configuration into the existing config.
128129// Note that the given map may be modified.
129- func (l * ConfigMap ) Merge (in * ConfigMap ) error {
130+ func (l * Map ) Merge (in * Map ) error {
130131 return l .k .Merge (in .k )
131132}
132133
133134// Sub returns new Parser instance representing a sub-config of this instance.
134135// It returns an error is the sub-config is not a map (use Get()) and an empty Parser if
135136// none exists.
136- func (l * ConfigMap ) Sub (key string ) (* ConfigMap , error ) {
137+ func (l * Map ) Sub (key string ) (* Map , error ) {
137138 data := l .Get (key )
138139 if data == nil {
139- return NewConfigMap (), nil
140+ return NewMap (), nil
140141 }
141142
142143 if reflect .TypeOf (data ).Kind () == reflect .Map {
143- return NewConfigMapFromStringMap (cast .ToStringMap (data )), nil
144+ return NewMapFromStringMap (cast .ToStringMap (data )), nil
144145 }
145146
146147 return nil , fmt .Errorf ("unexpected sub-config value kind for key:%s value:%v kind:%v)" , key , data , reflect .TypeOf (data ).Kind ())
147148}
148149
149150// ToStringMap creates a map[string]interface{} from a Parser.
150- func (l * ConfigMap ) ToStringMap () map [string ]interface {} {
151+ func (l * Map ) ToStringMap () map [string ]interface {} {
151152 return maps .Unflatten (l .k .All (), KeyDelimiter )
152153}
153154
0 commit comments