/
config.go
62 lines (51 loc) · 2.29 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
// Copyright Splunk, Inc.
// 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 configprovider
import (
"go.opentelemetry.io/collector/component"
)
// SourceSettings defines common settings of a Source configuration.
// Specific config sources can embed this struct and extend it with more fields if needed.
// When embedded it must be with `mapstructure:",squash"` tag.
type SourceSettings struct {
id component.ID `mapstructure:"-"`
}
// ID returns the ID of the component that this configuration belongs to.
func (s *SourceSettings) ID() component.ID {
return s.id
}
// SetIDName updates the name part of the ID for the component that this configuration belongs to.
func (s *SourceSettings) SetIDName(idName string) {
s.id = component.NewIDWithName(s.id.Type(), idName)
}
// NewSourceSettings return a new config.SourceSettings struct with the given ComponentID.
func NewSourceSettings(id component.ID) SourceSettings {
return SourceSettings{id}
}
// Source is the configuration of a config source. Specific config sources must implement this
// interface and will typically embed SourceSettings struct or a struct that extends it.
type Source interface {
// TODO: While config sources are experimental and not in the config package they can't
// reference the private interfaces config.identifiable and config.validatable.
// Defining the required methods of the interfaces temporarily here.
// From config.identifiable:
// ID returns the ID of the component that this configuration belongs to.
ID() component.ID
// SetIDName updates the name part of the ID for the component that this configuration belongs to.
SetIDName(idName string)
// From config.validatable:
// Validate validates the configuration and returns an error if invalid.
Validate() error
}