Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pkg/stanze, receiver/filelog] Allow opting into scope name and version #31771

Closed
Show file tree
Hide file tree
Changes from all 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
27 changes: 27 additions & 0 deletions .chloggen/stanza-allow-setting-scope-2.yaml
Original file line number Diff line number Diff line change
@@ -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: filelogreceiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Set scope name and version on scraped logs

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [31771]

# (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: []
27 changes: 27 additions & 0 deletions .chloggen/stanza-allow-setting-scope.yaml
Original file line number Diff line number Diff line change
@@ -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: pkg/stanza

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add the option to set scope name and version

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [31771]

# (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: []
45 changes: 44 additions & 1 deletion pkg/stanza/adapter/converter.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
"sync"

"github.com/cespare/xxhash/v2"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/pdata/pcommon"
"go.opentelemetry.io/collector/pdata/plog"
"go.uber.org/zap"
Expand Down Expand Up @@ -71,13 +72,47 @@ type Converter struct {
// when Stop() is called.
wg sync.WaitGroup

logger *zap.Logger
logger *zap.Logger
buildInfo component.BuildInfo
packageName string
}

type converterOption interface {
apply(*Converter)
}

func withPackageName(name string) converterOption {
return packageNameOption{name}
}
Comment on lines +84 to +86
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The interface pattern allows this to be an opt-in solution, but feels kinda magical. I'm not sold on this idea, but it does provide the value without any breaking changes and I think we do need the component to provide the value since the ID is not the same as the package name.


type packageNameOption struct {
name string
}

func (o packageNameOption) apply(c *Converter) {
c.packageName = o.name
}

type packageNameProvider interface {
PackageName() string
}

func withBuildInfo(buildInfo component.BuildInfo) converterOption {
return buildInfoOption{buildInfo}
}

type buildInfoOption struct {
buildInfo component.BuildInfo
}

func (o buildInfoOption) apply(c *Converter) {
c.buildInfo = o.buildInfo
}

type useBuildInfo interface {
UseBuildInfo() bool
}

func withWorkerCount(workerCount int) converterOption {
return workerCountOption{workerCount}
}
Expand Down Expand Up @@ -162,6 +197,14 @@ func (c *Converter) workerLoop() {
} else {
sl = pLogs.ResourceLogs().At(resourceIdx).ScopeLogs().At(0)
}

if c.packageName != "" {
sl.Scope().SetName(c.packageName)
}
if c.buildInfo.Version != "" {
sl.Scope().SetVersion(c.buildInfo.Version)
}

convertInto(e, sl.LogRecords().AppendEmpty())
}

Expand Down
6 changes: 6 additions & 0 deletions pkg/stanza/adapter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ func createLogsReceiver(logReceiverType LogReceiverType) rcvr.CreateLogsFunc {
}

converterOpts := []converterOption{}
if p, ok := logReceiverType.(packageNameProvider); ok {
converterOpts = append(converterOpts, withPackageName(p.PackageName()))
}
if p, ok := logReceiverType.(useBuildInfo); ok && p.UseBuildInfo() {
converterOpts = append(converterOpts, withBuildInfo(params.BuildInfo))
}
if baseCfg.numWorkers > 0 {
converterOpts = append(converterOpts, withWorkerCount(baseCfg.numWorkers))
}
Expand Down
8 changes: 8 additions & 0 deletions receiver/filelogreceiver/filelog.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ func (f ReceiverType) Type() component.Type {
return metadata.Type
}

func (f ReceiverType) PackageName() string {
return "otelcol/filelogreceiver"
}

func (f ReceiverType) UseBuildInfo() bool {
return true
}

// CreateDefaultConfig creates a config with type and version
func (f ReceiverType) CreateDefaultConfig() component.Config {
return createDefaultConfig()
Expand Down