Skip to content

Commit

Permalink
[receiver/podman] rename struct and function to keep expected receive…
Browse files Browse the repository at this point in the history
…r.Factory and pass checkapi (open-telemetry#27077)

Related to: open-telemetry#26304
  • Loading branch information
sakulali authored and JaredTan95 committed Oct 18, 2023
1 parent 8fc10ab commit 23ed615
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 23 deletions.
1 change: 0 additions & 1 deletion cmd/checkapi/allowlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,4 @@ receiver/collectdreceiver
receiver/dockerstatsreceiver
receiver/journaldreceiver
receiver/kafkareceiver
receiver/podmanreceiver
receiver/windowseventlogreceiver
14 changes: 7 additions & 7 deletions receiver/podmanreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/consumer"
rcvr "go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/receiver/scraperhelper"

"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/podmanreceiver/internal/metadata"
Expand All @@ -19,11 +19,11 @@ const (
defaultAPIVersion = "3.3.1"
)

func NewFactory() rcvr.Factory {
return rcvr.NewFactory(
func NewFactory() receiver.Factory {
return receiver.NewFactory(
metadata.Type,
createDefaultReceiverConfig,
rcvr.WithMetrics(createMetricsReceiver, metadata.MetricsStability))
receiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability))
}

func createDefaultConfig() *Config {
Expand All @@ -44,12 +44,12 @@ func createDefaultReceiverConfig() component.Config {

func createMetricsReceiver(
ctx context.Context,
params rcvr.CreateSettings,
params receiver.CreateSettings,
config component.Config,
consumer consumer.Metrics,
) (rcvr.Metrics, error) {
) (receiver.Metrics, error) {
podmanConfig := config.(*Config)
dsr, err := newReceiver(ctx, params, podmanConfig, consumer, nil)
dsr, err := newMetricsReceiver(ctx, params, podmanConfig, consumer, nil)
if err != nil {
return nil, err
}
Expand Down
18 changes: 9 additions & 9 deletions receiver/podmanreceiver/receiver.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,28 @@ import (
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/pdata/pmetric"
rcvr "go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/receiver/scrapererror"
"go.opentelemetry.io/collector/receiver/scraperhelper"
"go.uber.org/multierr"

"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/podmanreceiver/internal/metadata"
)

type receiver struct {
type metricsReceiver struct {
config *Config
set rcvr.CreateSettings
set receiver.CreateSettings
clientFactory clientFactory
scraper *ContainerScraper
}

func newReceiver(
func newMetricsReceiver(
_ context.Context,
set rcvr.CreateSettings,
set receiver.CreateSettings,
config *Config,
nextConsumer consumer.Metrics,
clientFactory clientFactory,
) (rcvr.Metrics, error) {
) (receiver.Metrics, error) {
err := config.Validate()
if err != nil {
return nil, err
Expand All @@ -46,7 +46,7 @@ func newReceiver(
clientFactory = newLibpodClient
}

recv := &receiver{
recv := &metricsReceiver{
config: config,
clientFactory: clientFactory,
set: set,
Expand All @@ -59,7 +59,7 @@ func newReceiver(
return scraperhelper.NewScraperControllerReceiver(&recv.config.ScraperControllerSettings, set, nextConsumer, scraperhelper.AddScraper(scrp))
}

func (r *receiver) start(ctx context.Context, _ component.Host) error {
func (r *metricsReceiver) start(ctx context.Context, _ component.Host) error {
var err error
podmanClient, err := r.clientFactory(r.set.Logger, r.config)
if err != nil {
Expand All @@ -79,7 +79,7 @@ type result struct {
err error
}

func (r *receiver) scrape(ctx context.Context) (pmetric.Metrics, error) {
func (r *metricsReceiver) scrape(ctx context.Context) (pmetric.Metrics, error) {
containers := r.scraper.getContainers()
results := make(chan result, len(containers))

Expand Down
8 changes: 4 additions & 4 deletions receiver/podmanreceiver/receiver_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,19 @@ func TestNewReceiver(t *testing.T) {
},
}
nextConsumer := consumertest.NewNop()
mr, err := newReceiver(context.Background(), receivertest.NewNopCreateSettings(), config, nextConsumer, nil)
mr, err := newMetricsReceiver(context.Background(), receivertest.NewNopCreateSettings(), config, nextConsumer, nil)

assert.NotNil(t, mr)
assert.Nil(t, err)
}

func TestNewReceiverErrors(t *testing.T) {
r, err := newReceiver(context.Background(), receivertest.NewNopCreateSettings(), &Config{}, consumertest.NewNop(), nil)
r, err := newMetricsReceiver(context.Background(), receivertest.NewNopCreateSettings(), &Config{}, consumertest.NewNop(), nil)
assert.Nil(t, r)
require.Error(t, err)
assert.Equal(t, "config.Endpoint must be specified", err.Error())

r, err = newReceiver(context.Background(), receivertest.NewNopCreateSettings(), &Config{Endpoint: "someEndpoint"}, consumertest.NewNop(), nil)
r, err = newMetricsReceiver(context.Background(), receivertest.NewNopCreateSettings(), &Config{Endpoint: "someEndpoint"}, consumertest.NewNop(), nil)
assert.Nil(t, r)
require.Error(t, err)
assert.Equal(t, "config.CollectionInterval must be specified", err.Error())
Expand All @@ -58,7 +58,7 @@ func TestScraperLoop(t *testing.T) {
client := make(mockClient)
consumer := make(mockConsumer)

r, err := newReceiver(context.Background(), receivertest.NewNopCreateSettings(), cfg, consumer, client.factory)
r, err := newMetricsReceiver(context.Background(), receivertest.NewNopCreateSettings(), cfg, consumer, client.factory)
require.NoError(t, err)
assert.NotNil(t, r)

Expand Down
2 changes: 1 addition & 1 deletion receiver/podmanreceiver/receiver_windows.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
"go.opentelemetry.io/collector/receiver"
)

func newReceiver(
func newMetricsReceiver(
_ context.Context,
settings receiver.CreateSettings,
config *Config,
Expand Down
2 changes: 1 addition & 1 deletion receiver/podmanreceiver/receiver_windows_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
)

func TestNewReceiver(t *testing.T) {
mr, err := newReceiver(context.Background(), receivertest.NewNopCreateSettings(), &Config{}, consumertest.NewNop(), nil)
mr, err := newMetricsReceiver(context.Background(), receivertest.NewNopCreateSettings(), &Config{}, consumertest.NewNop(), nil)
assert.Nil(t, mr)
assert.Error(t, err)
assert.Equal(t, "podman receiver is not supported on windows", err.Error())
Expand Down

0 comments on commit 23ed615

Please sign in to comment.