[receiver/collectd] Move to use HTTPServerSettings with collectdrecei…

…ver (open-telemetry#28812)

**Description:**
Overhauls collectdreceiver to use the latest config helper features

**Link to tracking Issue:**
Fixes open-telemetry#28811

**Documentation:**
No impact to docs. User interface remains the same.
Separate changelog to notice API breaking changes, as the Config struct
is changing.

---------

Co-authored-by: Dmitrii Anoshin <[email protected]>

.chloggen/collectd-http-server-settings-api.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: collectdreceiver
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Move to use confighttp.HTTPServerSettings
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [28811]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

.chloggen/collectd-http-server-settings.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: collectdreceiver
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add support of confighttp.HTTPServerSettings
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [28811]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

receiver/collectdreceiver/README.md

@@ -29,10 +29,12 @@ value `field[a=b, k=v]`, this receiver will extract `a` and `b` as label keys
 and, `k` and `v` as the respective label values.
 
 ## Configuration
+The configuration includes the Opentelemetry collector's server [confighttp](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp#server-configuration),
+which allows for a variety of settings. Only the most relevant ones will be discussed here, but all are available.
 
 The following settings are required:
 
-- `endpoint` (default = `localhost:8081`): Address to reach the desired Docker daemon.
+- `endpoint` (default = `localhost:8081`): Endpoint exposed by this receiver to send data.
 
 The following settings are optional:
 

receiver/collectdreceiver/config.go

@@ -4,16 +4,29 @@
 package collectdreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/collectdreceiver"
 
 import (
+ "fmt"
+ "strings"
  "time"
 
- "go.opentelemetry.io/collector/config/confignet"
+ "go.opentelemetry.io/collector/config/confighttp"
 )
 
 // Config defines configuration for Collectd receiver.
 type Config struct {
- confignet.TCPAddr `mapstructure:",squash"`
+ confighttp.HTTPServerSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
+ Timeout time.Duration `mapstructure:"timeout"`
+ Encoding string `mapstructure:"encoding"`
+ AttributesPrefix string `mapstructure:"attributes_prefix"`
+}
 
- Timeout time.Duration `mapstructure:"timeout"`
- AttributesPrefix string `mapstructure:"attributes_prefix"`
- Encoding string `mapstructure:"encoding"`
+func (c *Config) Validate() error {
+ // CollectD receiver only supports JSON encoding. We expose a config option
+ // to make it explicit and obvious to the users.
+ if strings.ToLower(c.Encoding) != defaultEncodingFormat {
+ return fmt.Errorf(
+ "CollectD only support JSON encoding format. %s is not supported",
+ c.Encoding,
+ )
+ }
+ return nil
 }

receiver/collectdreceiver/config_test.go

@@ -4,14 +4,15 @@
 package collectdreceiver
 
 import (
+ "errors"
  "path/filepath"
  "testing"
  "time"
 
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
  "go.opentelemetry.io/collector/component"
- "go.opentelemetry.io/collector/config/confignet"
+ "go.opentelemetry.io/collector/config/confighttp"
  "go.opentelemetry.io/collector/confmap/confmaptest"
 
  "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/collectdreceiver/internal/metadata"
@@ -23,6 +24,7 @@ func TestLoadConfig(t *testing.T) {
  tests := []struct {
  id component.ID
  expected component.Config
+ wantErr error
  }{
  {
  id: component.NewIDWithName(metadata.Type, ""),
@@ -31,13 +33,14 @@ func TestLoadConfig(t *testing.T) {
  {
  id: component.NewIDWithName(metadata.Type, "one"),
  expected: &Config{
- TCPAddr: confignet.TCPAddr{
+ HTTPServerSettings: confighttp.HTTPServerSettings{
  Endpoint: "localhost:12345",
  },
- Timeout: time.Second * 50,
+ Timeout: 50 * time.Second,
  AttributesPrefix: "dap_",
  Encoding: "command",
  },
+ wantErr: errors.New("CollectD only support JSON encoding format. command is not supported"),
  },
  }
 
@@ -53,7 +56,11 @@ func TestLoadConfig(t *testing.T) {
  require.NoError(t, err)
  require.NoError(t, component.UnmarshalConfig(sub, cfg))
 
- assert.NoError(t, component.ValidateConfig(cfg))
+ if tt.wantErr == nil {
+ assert.NoError(t, component.ValidateConfig(cfg))
+ } else {
+ assert.Equal(t, tt.wantErr, component.ValidateConfig(cfg))
+ }
  assert.Equal(t, tt.expected, cfg)
  })
  }

receiver/collectdreceiver/factory.go

@@ -5,12 +5,10 @@ package collectdreceiver // import "github.com/open-telemetry/opentelemetry-coll
 
 import (
  "context"
- "fmt"
- "strings"
  "time"
 
  "go.opentelemetry.io/collector/component"
- "go.opentelemetry.io/collector/config/confignet"
+ "go.opentelemetry.io/collector/config/confighttp"
  "go.opentelemetry.io/collector/consumer"
  "go.opentelemetry.io/collector/receiver"
 
@@ -21,7 +19,6 @@ import (
 
 const (
  defaultBindEndpoint = "localhost:8081"
- defaultTimeout = time.Second * 30
  defaultEncodingFormat = "json"
 )
 
@@ -34,10 +31,10 @@ func NewFactory() receiver.Factory {
 }
 func createDefaultConfig() component.Config {
  return &Config{
- TCPAddr: confignet.TCPAddr{
+ HTTPServerSettings: confighttp.HTTPServerSettings{
  Endpoint: defaultBindEndpoint,
  },
- Timeout: defaultTimeout,
+ Timeout: 30 * time.Second,
  Encoding: defaultEncodingFormat,
  }
 }
@@ -49,14 +46,5 @@ func createMetricsReceiver(
  nextConsumer consumer.Metrics,
 ) (receiver.Metrics, error) {
  c := cfg.(*Config)
- c.Encoding = strings.ToLower(c.Encoding)
- // CollectD receiver only supports JSON encoding. We expose a config option
- // to make it explicit and obvious to the users.
- if c.Encoding != defaultEncodingFormat {
- return nil, fmt.Errorf(
- "CollectD only support JSON encoding format. %s is not supported",
- c.Encoding,
- )
- }
- return newCollectdReceiver(cs.Logger, c.Endpoint, c.Timeout, c.AttributesPrefix, nextConsumer, cs)
+ return newCollectdReceiver(cs.Logger, c, c.AttributesPrefix, nextConsumer, cs)
 }

receiver/collectdreceiver/go.mod

@@ -8,7 +8,7 @@ require (
  github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatatest v0.88.0
  github.com/stretchr/testify v1.8.4
  go.opentelemetry.io/collector/component v0.88.1-0.20231026220224-6405e152a2d9
- go.opentelemetry.io/collector/config/confignet v0.88.1-0.20231026220224-6405e152a2d9
+ go.opentelemetry.io/collector/config/confighttp v0.88.1-0.20231026220224-6405e152a2d9
  go.opentelemetry.io/collector/confmap v0.88.1-0.20231026220224-6405e152a2d9
  go.opentelemetry.io/collector/consumer v0.88.1-0.20231026220224-6405e152a2d9
  go.opentelemetry.io/collector/pdata v1.0.0-rcv0017.0.20231026220224-6405e152a2d9
@@ -19,9 +19,15 @@ require (
 require (
  github.com/cespare/xxhash/v2 v2.2.0 // indirect
  github.com/davecgh/go-spew v1.1.1 // indirect
+ github.com/felixge/httpsnoop v1.0.3 // indirect
+ github.com/fsnotify/fsnotify v1.7.0 // indirect
+ github.com/go-logr/logr v1.2.4 // indirect
+ github.com/go-logr/stdr v1.2.2 // indirect
  github.com/gogo/protobuf v1.3.2 // indirect
  github.com/golang/protobuf v1.5.3 // indirect
+ github.com/golang/snappy v0.0.4 // indirect
  github.com/json-iterator/go v1.1.12 // indirect
+ github.com/klauspost/compress v1.17.2 // indirect
  github.com/knadh/koanf/maps v0.1.1 // indirect
  github.com/knadh/koanf/providers/confmap v0.1.0 // indirect
  github.com/knadh/koanf/v2 v2.0.1 // indirect
@@ -32,10 +38,19 @@ require (
  github.com/modern-go/reflect2 v1.0.2 // indirect
  github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil v0.88.0 // indirect
  github.com/pmezard/go-difflib v1.0.0 // indirect
+ github.com/rs/cors v1.10.1 // indirect
  go.opencensus.io v0.24.0 // indirect
  go.opentelemetry.io/collector v0.88.1-0.20231026220224-6405e152a2d9 // indirect
+ go.opentelemetry.io/collector/config/configauth v0.88.1-0.20231026220224-6405e152a2d9 // indirect
+ go.opentelemetry.io/collector/config/configcompression v0.88.1-0.20231026220224-6405e152a2d9 // indirect
+ go.opentelemetry.io/collector/config/configopaque v0.88.1-0.20231026220224-6405e152a2d9 // indirect
  go.opentelemetry.io/collector/config/configtelemetry v0.88.1-0.20231026220224-6405e152a2d9 // indirect
+ go.opentelemetry.io/collector/config/configtls v0.88.1-0.20231026220224-6405e152a2d9 // indirect
+ go.opentelemetry.io/collector/config/internal v0.88.1-0.20231026220224-6405e152a2d9 // indirect
+ go.opentelemetry.io/collector/extension v0.88.1-0.20231026220224-6405e152a2d9 // indirect
+ go.opentelemetry.io/collector/extension/auth v0.88.1-0.20231026220224-6405e152a2d9 // indirect
  go.opentelemetry.io/collector/featuregate v1.0.0-rcv0017.0.20231026220224-6405e152a2d9 // indirect
+ go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.45.0 // indirect
  go.opentelemetry.io/otel v1.19.0 // indirect
  go.opentelemetry.io/otel/metric v1.19.0 // indirect
  go.opentelemetry.io/otel/trace v1.19.0 // indirect