Rename pdata Size to OtlpProtoSize, fix some other comments (#2726)

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
This commit is contained in:
Bogdan Drutu 2021-03-19 11:30:25 -07:00 committed by GitHub
parent e5175ed1cf
commit 94a6cdde67
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 40 additions and 32 deletions

View File

@ -63,8 +63,10 @@ func (ld Logs) InternalRep() internal.LogsWrapper {
return internal.LogsFromOtlp(ld.orig)
}
// ToOtlpProtoBytes returns the internal Logs to OTLP Collector ExportTraceServiceRequest
// ProtoBuf bytes. This is intended to export OTLP Protobuf bytes for OTLP/HTTP transports.
// ToOtlpProtoBytes converts this Logs to the OTLP Collector ExportLogsServiceRequest
// ProtoBuf bytes.
//
// Returns an nil byte-array if error is not nil.
func (ld Logs) ToOtlpProtoBytes() ([]byte, error) {
return ld.orig.Marshal()
}
@ -91,8 +93,9 @@ func (ld Logs) LogRecordCount() int {
return logCount
}
// Size returns the number of bytes in the internal representation of the logs.
func (ld Logs) Size() int {
// OtlpProtoSize returns the size in bytes of this Logs encoded as OTLP Collector
// ExportLogsServiceRequest ProtoBuf bytes.
func (ld Logs) OtlpProtoSize() int {
return ld.orig.Size()
}

View File

@ -46,14 +46,14 @@ func NewMetrics() Metrics {
return Metrics{orig: &otlpcollectormetrics.ExportMetricsServiceRequest{}}
}
// MetricsFromInternalRep creates Logs from the internal representation.
// MetricsFromInternalRep creates Metrics from the internal representation.
// Should not be used outside this module.
func MetricsFromInternalRep(wrapper internal.MetricsWrapper) Metrics {
return Metrics{orig: internal.MetricsToOtlp(wrapper)}
}
// MetricsFromOtlpProtoBytes converts OTLP Collector ExportMetricsServiceRequest
// ProtoBuf bytes to the internal Metrics.
// MetricsFromOtlpProtoBytes converts the OTLP Collector ExportMetricsServiceRequest
// ProtoBuf bytes to Metrics.
//
// Returns an invalid Metrics instance if error is not nil.
func MetricsFromOtlpProtoBytes(data []byte) (Metrics, error) {
@ -70,9 +70,10 @@ func (md Metrics) InternalRep() internal.MetricsWrapper {
return internal.MetricsFromOtlp(md.orig)
}
// ToOtlpProtoBytes returns the internal MetricData to the OTLP Collector
// ExportMetricsServiceRequest ProtoBuf bytes. This is intended to export
// OTLP Protobuf bytes for OTLP/HTTP transports.
// ToOtlpProtoBytes converts this Metrics to the OTLP Collector ExportMetricsServiceRequest
// ProtoBuf bytes.
//
// Returns an nil byte-array if error is not nil.
func (md Metrics) ToOtlpProtoBytes() ([]byte, error) {
return md.orig.Marshal()
}
@ -103,8 +104,9 @@ func (md Metrics) MetricCount() int {
return metricCount
}
// Size returns size in bytes.
func (md Metrics) Size() int {
// OtlpProtoSize returns the size in bytes of this Metrics encoded as OTLP Collector
// ExportMetricsServiceRequest ProtoBuf bytes.
func (md Metrics) OtlpProtoSize() int {
return md.orig.Size()
}

View File

@ -178,7 +178,7 @@ func TestMetricCount(t *testing.T) {
func TestMetricSize(t *testing.T) {
md := NewMetrics()
assert.Equal(t, 0, md.Size())
assert.Equal(t, 0, md.OtlpProtoSize())
rms := md.ResourceMetrics()
rms.Resize(1)
rms.At(0).InstrumentationLibraryMetrics().Resize(1)
@ -193,12 +193,12 @@ func TestMetricSize(t *testing.T) {
size := otlp.Size()
bytes, err := otlp.Marshal()
require.NoError(t, err)
assert.Equal(t, size, md.Size())
assert.Equal(t, len(bytes), md.Size())
assert.Equal(t, size, md.OtlpProtoSize())
assert.Equal(t, len(bytes), md.OtlpProtoSize())
}
func TestMetricsSizeWithNil(t *testing.T) {
assert.Equal(t, 0, NewMetrics().Size())
assert.Equal(t, 0, NewMetrics().OtlpProtoSize())
}
func TestMetricCountWithEmpty(t *testing.T) {

View File

@ -56,8 +56,10 @@ func (td Traces) InternalRep() internal.TracesWrapper {
return internal.TracesFromOtlp(td.orig)
}
// ToOtlpProtoBytes converts the internal Traces to OTLP Collector
// ExportTraceServiceRequest ProtoBuf bytes.
// ToOtlpProtoBytes converts this Traces to the OTLP Collector ExportTraceServiceRequest
// ProtoBuf bytes.
//
// Returns an nil byte-array if error is not nil.
func (td Traces) ToOtlpProtoBytes() ([]byte, error) {
return td.orig.Marshal()
}
@ -83,8 +85,9 @@ func (td Traces) SpanCount() int {
return spanCount
}
// Size returns size in bytes.
func (td Traces) Size() int {
// OtlpProtoSize returns the size in bytes of this Traces encoded as OTLP Collector
// ExportTraceServiceRequest ProtoBuf bytes.
func (td Traces) OtlpProtoSize() int {
return td.orig.Size()
}

View File

@ -53,7 +53,7 @@ func TestSpanCount(t *testing.T) {
func TestSize(t *testing.T) {
td := NewTraces()
assert.Equal(t, 0, td.Size())
assert.Equal(t, 0, td.OtlpProtoSize())
rms := td.ResourceSpans()
rms.Resize(1)
rms.At(0).InstrumentationLibrarySpans().Resize(1)
@ -63,12 +63,12 @@ func TestSize(t *testing.T) {
size := otlp.Size()
bytes, err := otlp.Marshal()
require.NoError(t, err)
assert.Equal(t, size, td.Size())
assert.Equal(t, len(bytes), td.Size())
assert.Equal(t, size, td.OtlpProtoSize())
assert.Equal(t, len(bytes), td.OtlpProtoSize())
}
func TestTracesSizeWithNil(t *testing.T) {
assert.Equal(t, 0, NewTraces().Size())
assert.Equal(t, 0, NewTraces().OtlpProtoSize())
}
func TestSpanCountWithEmpty(t *testing.T) {

View File

@ -136,7 +136,7 @@ func TestQueuedRetry_StopWhileWaiting(t *testing.T) {
// secondMockR.checkNumRequests(t, 1)
// ocs.checkSendItemsCount(t, 3)
ocs.checkDroppedItemsCount(t, 2)
// require.Zero(t, be.qrSender.queue.Size())
// require.Zero(t, be.qrSender.queue.OtlpProtoSize())
}
func TestQueuedRetry_DoNotPreserveCancellation(t *testing.T) {

View File

@ -269,7 +269,7 @@ func (bt *batchTraces) itemCount() uint32 {
}
func (bt *batchTraces) size() int {
return bt.traceData.Size()
return bt.traceData.OtlpProtoSize()
}
// resets the current batchTraces structure with zero values
@ -299,7 +299,7 @@ func (bm *batchMetrics) itemCount() uint32 {
}
func (bm *batchMetrics) size() int {
return bm.metricData.Size()
return bm.metricData.OtlpProtoSize()
}
// resets the current batchMetrics structure with zero/empty values.
@ -340,7 +340,7 @@ func (bm *batchLogs) itemCount() uint32 {
}
func (bm *batchLogs) size() int {
return bm.logData.Size()
return bm.logData.OtlpProtoSize()
}
// resets the current batchLogs structure with zero/empty values.

View File

@ -136,7 +136,7 @@ func TestBatchProcessorSentBySize(t *testing.T) {
sizeSum := 0
for requestNum := 0; requestNum < requestCount; requestNum++ {
td := testdata.GenerateTraceDataManySpansSameResource(spansPerRequest)
sizeSum += td.Size()
sizeSum += td.OtlpProtoSize()
assert.NoError(t, batcher.ConsumeTraces(context.Background(), td))
}
@ -320,7 +320,7 @@ func TestBatchMetricProcessor_BatchSize(t *testing.T) {
size := 0
for requestNum := 0; requestNum < requestCount; requestNum++ {
md := testdata.GenerateMetricsManyMetricsSameResource(metricsPerRequest)
size += md.Size()
size += md.OtlpProtoSize()
assert.NoError(t, batcher.ConsumeMetrics(context.Background(), md))
}
require.NoError(t, batcher.Shutdown(context.Background()))
@ -476,7 +476,7 @@ func getTestMetricName(requestNum, index int) string {
func BenchmarkTraceSizeBytes(b *testing.B) {
td := testdata.GenerateTraceDataManySpansSameResource(8192)
for n := 0; n < b.N; n++ {
fmt.Println(td.Size())
fmt.Println(td.OtlpProtoSize())
}
}
@ -558,7 +558,7 @@ func TestBatchLogProcessor_BatchSize(t *testing.T) {
size := 0
for requestNum := 0; requestNum < requestCount; requestNum++ {
ld := testdata.GenerateLogDataManyLogsSameResource(logsPerRequest)
size += ld.Size()
size += ld.OtlpProtoSize()
assert.NoError(t, batcher.ConsumeLogs(context.Background(), ld))
}
require.NoError(t, batcher.Shutdown(context.Background()))