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

Clarify that data cannot be accessed after Consume* func is called #12284

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
25 changes: 25 additions & 0 deletions .chloggen/consumer-message.yaml
Original file line number Diff line number Diff line change
@@ -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: consumer

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Clarify that data cannot be accessed after Consume* func is called.

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

# (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]
3 changes: 2 additions & 1 deletion consumer/logs.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ import (
// as needed, and sends it to the next processing node if any or to the destination.
type Logs interface {
internal.BaseConsumer
// ConsumeLogs receives plog.Logs for consumption.
// ConsumeLogs processes the logs. After the function returns, the logs are no longer accessible,
// and accessing them is considered undefined behavior.
ConsumeLogs(ctx context.Context, ld plog.Logs) error
}

Expand Down
3 changes: 2 additions & 1 deletion consumer/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ import (
// as needed, and sends it to the next processing node if any or to the destination.
type Metrics interface {
internal.BaseConsumer
// ConsumeMetrics receives pmetric.Metrics for consumption.
// ConsumeMetrics processes the metrics. After the function returns, the metrics are no longer accessible,
// and accessing them is considered undefined behavior.
ConsumeMetrics(ctx context.Context, md pmetric.Metrics) error
}

Expand Down
3 changes: 2 additions & 1 deletion consumer/traces.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ import (
// as needed, and sends it to the next processing node if any or to the destination.
type Traces interface {
internal.BaseConsumer
// ConsumeTraces receives ptrace.Traces for consumption.
// ConsumeTraces processes the traces. After the function returns, the traces are no longer accessible,
// and accessing them is considered undefined behavior.
ConsumeTraces(ctx context.Context, td ptrace.Traces) error
}

Expand Down
3 changes: 2 additions & 1 deletion consumer/xconsumer/profiles.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ var errNilFunc = errors.New("nil consumer func")
// as needed, and sends it to the next processing node if any or to the destination.
type Profiles interface {
internal.BaseConsumer
// ConsumeProfiles receives pprofile.Profiles for consumption.
// ConsumeProfiles processes the profiles. After the function returns, the profiles are no longer accessible,
// and accessing them is considered undefined behavior.
ConsumeProfiles(ctx context.Context, td pprofile.Profiles) error
}

Expand Down
Loading