Skip to content
Open
Show file tree
Hide file tree
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .chloggen/otelcol-telemetryfactory.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 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. otlpreceiver)
component: pkg/otelcol

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Require a telemetry factory to be injected through otelcol.Factories

# One or more tracking issues or pull requests related to the change
issues: [4970]

# (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: |
otelcol.Factories now has a required Telemetry field,
which contains the telemetry factory to be used by the service.
Set it to otelconftelemetry.NewFactory() for the existing behavior.

# 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]
5 changes: 4 additions & 1 deletion cmd/builder/internal/builder/templates/components.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"go.opentelemetry.io/collector/otelcol"
"go.opentelemetry.io/collector/processor"
"go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/service/telemetry/otelconftelemetry"
{{- range .Connectors}}
{{.Name}} "{{.Import}}"
{{- end}}
Expand All @@ -29,7 +30,9 @@ import (

func components() (otelcol.Factories, error) {
var err error
factories := otelcol.Factories{}
factories := otelcol.Factories{
Telemetry: otelconftelemetry.NewFactory(),
}

factories.Extensions, err = otelcol.MakeFactoryMap[extension.Factory](
{{- range .Extensions}}
Expand Down
5 changes: 4 additions & 1 deletion cmd/otelcorecol/components.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cmd/otelcorecol/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ require (
go.opentelemetry.io/collector/receiver v1.43.0
go.opentelemetry.io/collector/receiver/nopreceiver v0.137.0
go.opentelemetry.io/collector/receiver/otlpreceiver v0.137.0
go.opentelemetry.io/collector/service v0.137.0
golang.org/x/sys v0.36.0
)

Expand Down Expand Up @@ -135,7 +136,6 @@ require (
go.opentelemetry.io/collector/receiver/receiverhelper v0.137.0 // indirect
go.opentelemetry.io/collector/receiver/receivertest v0.137.0 // indirect
go.opentelemetry.io/collector/receiver/xreceiver v0.137.0 // indirect
go.opentelemetry.io/collector/service v0.137.0 // indirect
go.opentelemetry.io/collector/service/hostcapabilities v0.137.0 // indirect
go.opentelemetry.io/contrib/bridges/otelzap v0.13.0 // indirect
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.63.0 // indirect
Expand Down
2 changes: 2 additions & 0 deletions internal/e2e/metric_stability_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ import (
"go.opentelemetry.io/collector/processor/batchprocessor"
"go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/receiver/otlpreceiver"
"go.opentelemetry.io/collector/service/telemetry/otelconftelemetry"
)

func assertMetrics(t *testing.T, metricsAddr string, expectedMetrics map[string]bool) bool {
Expand Down Expand Up @@ -204,6 +205,7 @@ func testMetricStability(t *testing.T, configFile string, expectedMetrics map[st
Receivers: map[component.Type]receiver.Factory{otlpreceiver.NewFactory().Type(): otlpreceiver.NewFactory()},
Processors: map[component.Type]processor.Factory{batchprocessor.NewFactory().Type(): batchprocessor.NewFactory()},
Exporters: map[component.Type]exporter.Factory{debugexporter.NewFactory().Type(): debugexporter.NewFactory()},
Telemetry: otelconftelemetry.NewFactory(),
}, nil
},
ConfigProviderSettings: otelcol.ConfigProviderSettings{
Expand Down
17 changes: 12 additions & 5 deletions otelcol/collector.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ func (s State) String() string {

// CollectorSettings holds configuration for creating a new Collector.
type CollectorSettings struct {
// Factories service factories.
// Factories returns component factories for the collector.
//
// TODO(13263) This is a dangerous "bare" function value, should define an interface
// following style guidelines.
Factories func() (Factories, error)
Expand Down Expand Up @@ -178,6 +179,10 @@ func (col *Collector) setupConfigurationComponents(ctx context.Context) error {
if err != nil {
return fmt.Errorf("failed to initialize factories: %w", err)
}
if factories.Telemetry == nil {
factories.Telemetry = otelconftelemetry.NewFactory()
}

cfg, err := col.configProvider.Get(ctx, factories)
if err != nil {
return fmt.Errorf("failed to get config: %w", err)
Expand Down Expand Up @@ -219,10 +224,7 @@ func (col *Collector) setupConfigurationComponents(ctx context.Context) error {
},
AsyncErrorChannel: col.asyncErrorChannel,
LoggingOptions: col.set.LoggingOptions,

// TODO: inject the telemetry factory through factories.
// See https://github.com/open-telemetry/opentelemetry-collector/issues/4970
TelemetryFactory: otelconftelemetry.NewFactory(),
TelemetryFactory: factories.Telemetry,
}, cfg.Service)
if err != nil {
return err
Expand Down Expand Up @@ -272,6 +274,10 @@ func (col *Collector) DryRun(ctx context.Context) error {
if err != nil {
return fmt.Errorf("failed to initialize factories: %w", err)
}
if factories.Telemetry == nil {
factories.Telemetry = otelconftelemetry.NewFactory()
}

cfg, err := col.configProvider.Get(ctx, factories)
if err != nil {
return fmt.Errorf("failed to get config: %w", err)
Expand All @@ -291,6 +297,7 @@ func (col *Collector) DryRun(ctx context.Context) error {
ExportersFactories: factories.Exporters,
ConnectorsConfigs: cfg.Connectors,
ConnectorsFactories: factories.Connectors,
TelemetryFactory: factories.Telemetry,
}, service.Config{
Pipelines: cfg.Service.Pipelines,
})
Expand Down
Loading
Loading