diff --git a/.chloggen/consumer-message.yaml b/.chloggen/consumer-message.yaml new file mode 100644 index 00000000000..fe6c6d7c039 --- /dev/null +++ b/.chloggen/consumer-message.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: 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] diff --git a/consumer/logs.go b/consumer/logs.go index 15166ef1196..701ce5f35c6 100644 --- a/consumer/logs.go +++ b/consumer/logs.go @@ -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 } diff --git a/consumer/metrics.go b/consumer/metrics.go index 47897f9363a..6a636a6caef 100644 --- a/consumer/metrics.go +++ b/consumer/metrics.go @@ -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 } diff --git a/consumer/traces.go b/consumer/traces.go index 60df2d04536..1fed65656f5 100644 --- a/consumer/traces.go +++ b/consumer/traces.go @@ -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 } diff --git a/consumer/xconsumer/profiles.go b/consumer/xconsumer/profiles.go index 88ba2eb5a38..7f0b36f55ce 100644 --- a/consumer/xconsumer/profiles.go +++ b/consumer/xconsumer/profiles.go @@ -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 }