Add the API ByteSize() to request

Author: sfc-gh-sili

.chloggen/add-byte-size-to-exporter-request-api.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: exporterhelper
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Added a new API ByteSize() to exporter.request
+
+# One or more tracking issues or pull requests related to the change
+issues: [3265]
+
+# (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]

exporter/exporterhelper/internal/retry_sender_test.go

@@ -418,6 +418,10 @@ func (mer *mockErrorRequest) ItemsCount() int {
 	return 7
 }
 
+func (mer *mockErrorRequest) ByteSize() int {
+	return 7
+}
+
 func (mer *mockErrorRequest) MergeSplit(context.Context, exporterbatcher.MaxSizeConfig, internal.Request) ([]internal.Request, error) {
 	return nil, nil
 }
@@ -464,6 +468,10 @@ func (m *mockRequest) ItemsCount() int {
 	return m.cnt
 }
 
+func (m *mockRequest) ByteSize() int {
+	return m.cnt
+}
+
 func (m *mockRequest) MergeSplit(context.Context, exporterbatcher.MaxSizeConfig, internal.Request) ([]internal.Request, error) {
 	return nil, nil
 }

exporter/exporterhelper/logs.go

@@ -72,6 +72,10 @@ func (req *logsRequest) setCachedItemsCount(count int) {
 	req.cachedItemsCount = count
 }
 
+func (req *logsRequest) ByteSize() int {
+	return logsMarshaler.LogsSize(req.ld)
+}
+
 type logsExporter struct {
 	*internal.BaseExporter
 	consumer.Logs

exporter/exporterhelper/metrics.go

@@ -72,6 +72,10 @@ func (req *metricsRequest) setCachedItemsCount(count int) {
 	req.cachedItemsCount = count
 }
 
+func (req *metricsRequest) ByteSize() int {
+	return metricsMarshaler.MetricsSize(req.md)
+}
+
 type metricsExporter struct {
 	*internal.BaseExporter
 	consumer.Metrics

exporter/exporterhelper/traces.go

@@ -72,6 +72,10 @@ func (req *tracesRequest) setCachedItemsCount(count int) {
 	req.cachedItemsCount = count
 }
 
+func (req *tracesRequest) ByteSize() int {
+	return tracesMarshaler.TracesSize(req.td)
+}
+
 type tracesExporter struct {
 	*internal.BaseExporter
 	consumer.Traces

exporter/exporterhelper/xexporterhelper/profiles.go

@@ -75,6 +75,10 @@ func (req *profilesRequest) setCachedItemsCount(count int) {
 	req.cachedItemsCount = count
 }
 
+func (req *profilesRequest) ByteSize() int {
+	return profilesMarshaler.ProfilesSize(req.pd)
+}
+
 type profileExporter struct {
 	*internal.BaseExporter
 	xconsumer.Profiles

exporter/exporterhelper/xexporterhelper/profiles_batch_test.go

@@ -152,6 +152,10 @@ func (req *dummyRequest) ItemsCount() int {
 	return 1
 }
 
+func (req *dummyRequest) ByteSize() int {
+	return 1
+}
+
 func (req *dummyRequest) MergeSplit(_ context.Context, _ exporterbatcher.MaxSizeConfig, _ exporterhelper.Request) (
 	[]exporterhelper.Request, error,
 ) {

exporter/internal/request.go

@@ -16,9 +16,10 @@ type Request interface {
 	// Export exports the request to an external endpoint.
 	Export(ctx context.Context) error
 	// ItemsCount returns a number of basic items in the request where item is the smallest piece of data that can be
-	// sent. For example, for OTLP exporter, this value represents the number of spans,
-	// metric data points or log records.
+	// sent. For example, for OTLP exporter, this value represents the number of spans, metric data points or log records.
 	ItemsCount() int
+	// ByteSize returns the serialized byte size of of the request.
+	ByteSize() int
 	// MergeSplit is a function that merge and/or splits this request with another one into multiple requests based on the
 	// configured limit provided in MaxSizeConfig.
 	// MergeSplit does not split if all fields in MaxSizeConfig are not initialized (zero).

exporter/internal/requesttest/fake_request.go

@@ -25,6 +25,10 @@ func (s *Sink) ItemsCount() int64 {
 	return s.itemsCount.Load()
 }
 
+func (s *Sink) ByteSize() int64 {
+	return s.itemsCount.Load()
+}
+
 func NewSink() *Sink {
 	return &Sink{
 		requestsCount: new(atomic.Int64),
@@ -60,6 +64,10 @@ func (r *FakeRequest) ItemsCount() int {
 	return r.Items
 }
 
+func (r *FakeRequest) ByteSize() int {
+	return r.Items
+}
+
 func (r *FakeRequest) MergeSplit(_ context.Context, cfg exporterbatcher.MaxSizeConfig, r2 internal.Request) ([]internal.Request, error) {
 	if r.MergeErr != nil {
 		return nil, r.MergeErr