mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
dd484104f9
#### Description This PR introduces a simple testable examples to the package [confmap](/confmap/xconfmap). it's basically a copy of the documentation example on https://opentelemetry.io/docs/collector/building/receiver/#designing-and-validating-receiver-settings #### Issue: https://github.com/open-telemetry/opentelemetry-collector/issues/5675#issuecomment-2796741807 #### Testing the testable example was executed successfully  #### Documentation this testable example follows https://go.dev/blog/examples#larger-examples format and should be automatically added to `xconfmap` package documentation Co-authored-by: Pablo Baeyens <[email protected]> Co-authored-by: Pablo Baeyens <[email protected]>
63 lines
1.4 KiB
Go
63 lines
1.4 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package xconfmap
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"time"
|
|
)
|
|
|
|
// Config represents the receiver config settings within the collector's config.yaml
|
|
type Config struct {
|
|
Interval time.Duration `mapstructure:"interval"`
|
|
NumberOfTraces int `mapstructure:"number_of_traces"`
|
|
}
|
|
|
|
// Validate checks if the receiver configuration is valid
|
|
// this function is automatically called by the collector when it loads the configurations
|
|
// for a component
|
|
func (cfg *Config) Validate() error {
|
|
if cfg.Interval.Minutes() < 1 {
|
|
return errors.New("when defined, the interval has to be set to at least 1 minute (1m)")
|
|
}
|
|
|
|
if cfg.NumberOfTraces < 1 {
|
|
return errors.New("number_of_traces must be greater or equal to 1")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Example usage validated configuration
|
|
func Example() {
|
|
// invalid number of traces
|
|
myCfg := Config{
|
|
Interval: time.Minute,
|
|
NumberOfTraces: 0,
|
|
}
|
|
err := myCfg.Validate()
|
|
fmt.Println(err)
|
|
|
|
// invalid interval
|
|
myCfg = Config{
|
|
Interval: time.Second,
|
|
NumberOfTraces: 1,
|
|
}
|
|
err = myCfg.Validate()
|
|
fmt.Println(err)
|
|
|
|
// valid config
|
|
myCfg = Config{
|
|
Interval: time.Minute,
|
|
NumberOfTraces: 1,
|
|
}
|
|
err = myCfg.Validate()
|
|
fmt.Println(err)
|
|
|
|
// Output:
|
|
// number_of_traces must be greater or equal to 1
|
|
// when defined, the interval has to be set to at least 1 minute (1m)
|
|
// <nil>
|
|
}
|