Support logs scraper

.chloggen/deprecate-addscraper-func.yaml

@@ -0,0 +1,25 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: deprecation
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: scraper/scraperhelper
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Deprecate AddScraper function in scraperhelper
+
+# One or more tracking issues or pull requests related to the change
+issues: [12116]
+
+# (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: Use `scraperhelper.AddMetricsScraper` instead of `scraperhelper.AddScraper`
+
+# 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/support-logs-scraper.yaml

@@ -0,0 +1,25 @@
+# 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. otlpreceiver)
+component: scraper
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Support logs scraper
+
+# One or more tracking issues or pull requests related to the change
+issues: [12116]
+
+# (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:
+
+# 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]

scraper/factory.go

@@ -29,12 +29,19 @@ type Settings struct {
 type Factory interface {
 	component.Factory
 
+	// CreateLogs creates a Logs scraper based on this config.
+	// If the scraper type does not support logs,
+	// this function returns the error [pipeline.ErrSignalNotSupported].
+	CreateLogs(ctx context.Context, set Settings, cfg component.Config) (Logs, error)
+
 	// CreateMetrics creates a Metrics scraper based on this config.
 	// If the scraper type does not support metrics,
 	// this function returns the error [pipeline.ErrSignalNotSupported].
-	// Implementers can assume `next` is never nil.
 	CreateMetrics(ctx context.Context, set Settings, cfg component.Config) (Metrics, error)
 
+	// LogsStability gets the stability level of the Logs scraper.
+	LogsStability() component.StabilityLevel
+
 	// MetricsStability gets the stability level of the Metrics scraper.
 	MetricsStability() component.StabilityLevel
 
@@ -59,7 +66,9 @@ func (f factoryOptionFunc) applyOption(o *factory) {
 type factory struct {
 	cfgType component.Type
 	component.CreateDefaultConfigFunc
+	CreateLogsFunc
 	CreateMetricsFunc
+	logsStabilityLevel    component.StabilityLevel
 	metricsStabilityLevel component.StabilityLevel
 }
 
@@ -69,13 +78,28 @@ func (f *factory) Type() component.Type {
 
 func (f *factory) unexportedFactoryFunc() {}
 
+func (f *factory) LogsStability() component.StabilityLevel {
+	return f.logsStabilityLevel
+}
+
 func (f *factory) MetricsStability() component.StabilityLevel {
 	return f.metricsStabilityLevel
 }
 
+// CreateLogsFunc is the equivalent of Factory.CreateLogs().
+type CreateLogsFunc func(context.Context, Settings, component.Config) (Logs, error)
+
 // CreateMetricsFunc is the equivalent of Factory.CreateMetrics().
 type CreateMetricsFunc func(context.Context, Settings, component.Config) (Metrics, error)
 
+// CreateLogs implements Factory.CreateLogs.
+func (f CreateLogsFunc) CreateLogs(ctx context.Context, set Settings, cfg component.Config) (Logs, error) {
+	if f == nil {
+		return nil, pipeline.ErrSignalNotSupported
+	}
+	return f(ctx, set, cfg)
+}
+
 // CreateMetrics implements Factory.CreateMetrics.
 func (f CreateMetricsFunc) CreateMetrics(ctx context.Context, set Settings, cfg component.Config) (Metrics, error) {
 	if f == nil {
@@ -84,6 +108,14 @@ func (f CreateMetricsFunc) CreateMetrics(ctx context.Context, set Settings, cfg
 	return f(ctx, set, cfg)
 }
 
+// WithLogs overrides the default "error not supported" implementation for CreateLogs and the default "undefined" stability level.
+func WithLogs(createLogs CreateLogsFunc, sl component.StabilityLevel) FactoryOption {
+	return factoryOptionFunc(func(o *factory) {
+		o.logsStabilityLevel = sl
+		o.CreateLogsFunc = createLogs
+	})
+}
+
 // WithMetrics overrides the default "error not supported" implementation for CreateMetrics and the default "undefined" stability level.
 func WithMetrics(createMetrics CreateMetricsFunc, sl component.StabilityLevel) FactoryOption {
 	return factoryOptionFunc(func(o *factory) {

scraper/factory_test.go

@@ -31,7 +31,9 @@ func TestNewFactory(t *testing.T) {
 		func() component.Config { return &defaultCfg })
 	assert.EqualValues(t, testType, f.Type())
 	assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig())
-	_, err := f.CreateMetrics(context.Background(), nopSettings(), &defaultCfg)
+	_, err := f.CreateLogs(context.Background(), nopSettings(), &defaultCfg)
+	require.ErrorIs(t, err, pipeline.ErrSignalNotSupported)
+	_, err = f.CreateMetrics(context.Background(), nopSettings(), &defaultCfg)
 	require.ErrorIs(t, err, pipeline.ErrSignalNotSupported)
 }
 
@@ -41,12 +43,17 @@ func TestNewFactoryWithOptions(t *testing.T) {
 	f := NewFactory(
 		testType,
 		func() component.Config { return &defaultCfg },
+		WithLogs(createLogs, component.StabilityLevelAlpha),
 		WithMetrics(createMetrics, component.StabilityLevelAlpha))
 	assert.EqualValues(t, testType, f.Type())
 	assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig())
 
+	assert.Equal(t, component.StabilityLevelAlpha, f.LogsStability())
+	_, err := f.CreateLogs(context.Background(), Settings{}, &defaultCfg)
+	require.NoError(t, err)
+
 	assert.Equal(t, component.StabilityLevelAlpha, f.MetricsStability())
-	_, err := f.CreateMetrics(context.Background(), Settings{}, &defaultCfg)
+	_, err = f.CreateMetrics(context.Background(), Settings{}, &defaultCfg)
 	require.NoError(t, err)
 }
 
@@ -87,6 +94,10 @@ func TestMakeFactoryMap(t *testing.T) {
 	}
 }
 
+func createLogs(context.Context, Settings, component.Config) (Logs, error) {
+	return NewLogs(newTestScrapeLogsFunc(nil))
+}
+
 func createMetrics(context.Context, Settings, component.Config) (Metrics, error) {
 	return NewMetrics(newTestScrapeMetricsFunc(nil))
 }

scraper/scraperhelper/controller.go

@@ -12,6 +12,7 @@
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/consumer"
+	"go.opentelemetry.io/collector/pdata/plog"
 	"go.opentelemetry.io/collector/pdata/pmetric"
 	"go.opentelemetry.io/collector/receiver"
 	"go.opentelemetry.io/collector/receiver/receiverhelper"
@@ -33,12 +34,28 @@
 	of(e)
 }
 
-// AddScraper configures the scraper.Metrics to be called with the specified options,
+// AddLogsScraper configures the scraper.Logs to be called with the specified options,
+// and at the specified collection interval.
+//
+// Observability information will be reported, and the scraped logs
+// will be passed to the next consumer.
+func AddLogsScraper(t component.Type, sc scraper.Logs) ControllerOption {
+	f := scraper.NewFactory(t, nil,
+		scraper.WithLogs(func(context.Context, scraper.Settings, component.Config) (scraper.Logs, error) {
+			return sc, nil
+		}, component.StabilityLevelAlpha))
+	return AddFactoryWithConfig(f, nil)
+}
+
+// Deprecated: [v0.118.0] use AddMetricsScraper.
+var AddScraper = AddMetricsScraper
+
+// AddMetricsScraper configures the scraper.Metrics to be called with the specified options,
 // and at the specified collection interval.
 //
 // Observability information will be reported, and the scraped metrics
 // will be passed to the next consumer.
-func AddScraper(t component.Type, sc scraper.Metrics) ControllerOption {
+func AddMetricsScraper(t component.Type, sc scraper.Metrics) ControllerOption {
 	f := scraper.NewFactory(t, nil,
 		scraper.WithMetrics(func(context.Context, scraper.Settings, component.Config) (scraper.Metrics, error) {
 			return sc, nil
@@ -192,6 +209,30 @@
 	return NewMetricsController(cfg, set, nextConsumer, options...)
 }
 
+// NewLogsController creates a receiver.Logs with the configured options, that can control multiple scraper.Logs.
+func NewLogsController(cfg *ControllerConfig,
+	rSet receiver.Settings,
+	nextConsumer consumer.Logs,
+	options ...ControllerOption,
+) (receiver.Logs, error) {
+	co := getOptions(options)
+	scrapers := make([]scraper.Logs, 0, len(co.factoriesWithConfig))
+	for _, fwc := range co.factoriesWithConfig {
+		set := getSettings(fwc.f.Type(), rSet)
+		s, err := fwc.f.CreateLogs(context.Background(), set, fwc.cfg)
+		if err != nil {
+			return nil, err
+		}
+		s, err = wrapObsLogs(s, rSet.ID, set.ID, set.TelemetrySettings)
+		if err != nil {
+			return nil, err
+		}
+		scrapers = append(scrapers, s)
+	}
+	return newController[scraper.Logs](
+		cfg, rSet, scrapers, func(c *controller[scraper.Logs]) { scrapeLogs(c, nextConsumer) }, co.tickerCh)
+}
+
 // NewMetricsController creates a receiver.Metrics with the configured options, that can control multiple scraper.Metrics.
 func NewMetricsController(cfg *ControllerConfig,
 	rSet receiver.Settings,
@@ -216,6 +257,25 @@
 		cfg, rSet, scrapers, func(c *controller[scraper.Metrics]) { scrapeMetrics(c, nextConsumer) }, co.tickerCh)
 }
 
+func scrapeLogs(c *controller[scraper.Logs], nextConsumer consumer.Logs) {
+	ctx, done := withScrapeContext(c.timeout)
+	defer done()
+
+	logs := plog.NewLogs()
+	for i := range c.scrapers {
+		md, err := c.scrapers[i].ScrapeLogs(ctx)
+		if err != nil && !scrapererror.IsPartialScrapeError(err) {
+			continue
+		}
+		md.ResourceLogs().MoveAndAppendTo(logs.ResourceLogs())
+	}
+
+	logRecordCount := logs.LogRecordCount()
+	ctx = c.obsrecv.StartMetricsOp(ctx)
+	err := nextConsumer.ConsumeLogs(ctx, logs)
+	c.obsrecv.EndMetricsOp(ctx, "", logRecordCount, err)
+}
+
 func scrapeMetrics(c *controller[scraper.Metrics], nextConsumer consumer.Metrics) {
 	ctx, done := withScrapeContext(c.timeout)
 	defer done()