Files
Dmitry AnoshinandGitHub 538897ad3e [chore] Simplify experimental factory wrappers (#14395)
Removes unnecessary `factoryOpts` wrapper structs from all x-prefixed
components, simplifying factory option handling by applying options
directly to the factory.
2026-01-09 08:43:56 +00:00

94 lines
3.2 KiB
Go

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package xscraper // import "go.opentelemetry.io/collector/scraper/xscraper"
import (
"context"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/pipeline"
"go.opentelemetry.io/collector/scraper"
)
type Factory interface {
scraper.Factory
// CreateProfiles creates a Profiles scraper based on this config.
// If the scraper type does not support profiles,
// this function returns the error [pipeline.ErrSignalNotSupported].
CreateProfiles(ctx context.Context, set scraper.Settings, cfg component.Config) (Profiles, error)
// ProfilesStability gets the stability level of the Profiles scraper.
ProfilesStability() component.StabilityLevel
}
// FactoryOption apply changes to Options.
type FactoryOption interface {
// applyOption applies the option.
applyOption(o *factory)
}
var _ FactoryOption = (*factoryOptionFunc)(nil)
// factoryOptionFunc is a FactoryOption created through a function.
type factoryOptionFunc func(*factory)
func (f factoryOptionFunc) applyOption(o *factory) {
f(o)
}
type factory struct {
scraper.Factory
opts []scraper.FactoryOption
createProfilesFunc CreateProfilesFunc
profilesStabilityLevel component.StabilityLevel
}
func (f *factory) ProfilesStability() component.StabilityLevel {
return f.profilesStabilityLevel
}
func (f *factory) CreateProfiles(ctx context.Context, set scraper.Settings, cfg component.Config) (Profiles, error) {
if f.createProfilesFunc == nil {
return nil, pipeline.ErrSignalNotSupported
}
return f.createProfilesFunc(ctx, set, cfg)
}
// WithLogs overrides the default "error not supported" implementation for CreateLogs and the default "undefined" stability level.
func WithLogs(createLogs scraper.CreateLogsFunc, sl component.StabilityLevel) FactoryOption {
return factoryOptionFunc(func(o *factory) {
o.opts = append(o.opts, scraper.WithLogs(createLogs, sl))
})
}
// WithMetrics overrides the default "error not supported" implementation for CreateMetrics and the default "undefined" stability level.
func WithMetrics(createMetrics scraper.CreateMetricsFunc, sl component.StabilityLevel) FactoryOption {
return factoryOptionFunc(func(o *factory) {
o.opts = append(o.opts, scraper.WithMetrics(createMetrics, sl))
})
}
// CreateProfilesFunc is the equivalent of Factory.CreateProfiles().
type CreateProfilesFunc func(context.Context, scraper.Settings, component.Config) (Profiles, error)
// WithProfiles overrides the default "error not supported" implementation for CreateProfiles and the default "undefined" stability level.
func WithProfiles(createProfiles CreateProfilesFunc, sl component.StabilityLevel) FactoryOption {
return factoryOptionFunc(func(o *factory) {
o.profilesStabilityLevel = sl
o.createProfilesFunc = createProfiles
})
}
// NewFactory creates a Factory with experimental capabilities and wraps a scraper.Factory.
func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory {
f := &factory{}
for _, opt := range options {
opt.applyOption(f)
}
f.Factory = scraper.NewFactory(cfgType, createDefaultConfig, f.opts...)
return f
}