Update New Relic exporter error conditions. (open-telemetry#3322)

* Update New Relic error text to include http response code. * Export cumulative metrics as gauges.
sakulali · May 4, 2021 · b2d3a11 · b2d3a11
1 parent 189e504
commit b2d3a11
Show file tree

Hide file tree

Showing 5 changed files with 82 additions and 43 deletions.
diff --git a/exporter/newrelicexporter/errors.go b/exporter/newrelicexporter/errors.go
@@ -15,6 +15,7 @@
 package newrelicexporter
 
 import (
+ "fmt"
  "net/http"
  "net/url"
  "strconv"
@@ -63,7 +64,9 @@ type httpError struct {
  Response *http.Response
 }
 
-func (e *httpError) Error() string { return "New Relic HTTP call failed" }
+func (e *httpError) Error() string {
+ return fmt.Sprintf("New Relic HTTP call failed. Status Code: %d", e.Response.StatusCode)
+}
 
 func (e *httpError) GRPCStatus() *grpcStatus.Status {
  mapEntry, ok := httpGrpcMapping[e.Response.StatusCode]

diff --git a/exporter/newrelicexporter/errors_test.go b/exporter/newrelicexporter/errors_test.go
@@ -90,7 +90,7 @@ func TestHttpError_GRPCStatus(t *testing.T) {
 
 func TestHttpError_Error(t *testing.T) {
  httpError := &httpError{Response: responseOf(http.StatusTeapot)}
- assert.Equal(t, httpError.Error(), "New Relic HTTP call failed")
+ assert.Equal(t, httpError.Error(), "New Relic HTTP call failed. Status Code: 418")
 }
 
 func responseOf(statusCode int) *http.Response {

diff --git a/exporter/newrelicexporter/newrelic.go b/exporter/newrelicexporter/newrelic.go
@@ -131,7 +131,7 @@ func (e exporter) pushTraceData(ctx context.Context, td pdata.Traces) (outputErr
 func (e exporter) buildTraceBatch(details *exportMetadata, td pdata.Traces) ([]telemetry.Batch, error) {
  var errs []error
 
- transform := newTransformer(e.buildInfo, details)
+ transform := newTransformer(e.logger, e.buildInfo, details)
  batches := make([]telemetry.Batch, 0, calcSpanBatches(td))
 
  for i := 0; i < td.ResourceSpans().Len(); i++ {
@@ -184,7 +184,7 @@ func (e exporter) pushLogData(ctx context.Context, ld pdata.Logs) (outputErr err
 func (e exporter) buildLogBatch(details *exportMetadata, ld pdata.Logs) ([]telemetry.Batch, error) {
  var errs []error
 
- transform := newTransformer(e.buildInfo, details)
+ transform := newTransformer(e.logger, e.buildInfo, details)
  batches := make([]telemetry.Batch, 0, calcLogBatches(ld))
 
  for i := 0; i < ld.ResourceLogs().Len(); i++ {
@@ -237,7 +237,7 @@ func (e exporter) pushMetricData(ctx context.Context, md pdata.Metrics) (outputE
 func (e exporter) buildMetricBatch(details *exportMetadata, md pdata.Metrics) ([]telemetry.Batch, error) {
  var errs []error
 
- transform := newTransformer(e.buildInfo, details)
+ transform := newTransformer(e.logger, e.buildInfo, details)
  batches := make([]telemetry.Batch, 0, calcMetricBatches(md))
 
  for i := 0; i < md.ResourceMetrics().Len(); i++ {

diff --git a/exporter/newrelicexporter/transformer.go b/exporter/newrelicexporter/transformer.go
@@ -25,6 +25,7 @@ import (
  "go.opentelemetry.io/collector/component"
  "go.opentelemetry.io/collector/consumer/pdata"
  tracetranslator "go.opentelemetry.io/collector/translator/trace"
+ "go.uber.org/zap"
 )
 
 const (
@@ -44,11 +45,12 @@ const (
 )
 
 type transformer struct {
+ logger *zap.Logger
  OverrideAttributes map[string]interface{}
  details *exportMetadata
 }
 
-func newTransformer(buildInfo *component.BuildInfo, details *exportMetadata) *transformer {
+func newTransformer(logger *zap.Logger, buildInfo *component.BuildInfo, details *exportMetadata) *transformer {
  overrideAttributes := make(map[string]interface{})
  if buildInfo != nil {
  overrideAttributes[collectorNameKey] = buildInfo.Command
@@ -57,7 +59,7 @@ func newTransformer(buildInfo *component.BuildInfo, details *exportMetadata) *tr
  }
  }
 
- return &transformer{OverrideAttributes: overrideAttributes, details: details}
+ return &transformer{logger: logger, OverrideAttributes: overrideAttributes, details: details}
 }
 
 func (t *transformer) CommonAttributes(resource pdata.Resource, lib pdata.InstrumentationLibrary) map[string]interface{} {
@@ -289,49 +291,71 @@ func (t *transformer) Metric(m pdata.Metric) ([]telemetry.Metric, error) {
  k.MetricTemporality = temporality
  t.details.metricMetadataCount[k]++
 
- if temporality != pdata.AggregationTemporalityDelta {
- return nil, &errUnsupportedMetricType{metricType: k.MetricType.String(), metricName: m.Name(), numDataPoints: sum.DataPoints().Len()}
- }
-
  points := sum.DataPoints()
  output = make([]telemetry.Metric, 0, points.Len())
  for l := 0; l < points.Len(); l++ {
  point := points.At(l)
  attributes := t.MetricAttributes(baseAttributes, point.LabelsMap())
 
- nrMetric := telemetry.Count{
- Name: m.Name(),
- Attributes: attributes,
- Value: float64(point.Value()),
- Timestamp: point.StartTimestamp().AsTime(),
- Interval: time.Duration(point.Timestamp() - point.StartTimestamp()),
+ if temporality != pdata.AggregationTemporalityDelta {
+ t.logger.Debug("Converting metric to gauge where AggregationTemporality != Delta",
+ zap.String("MetricName", m.Name()),
+ zap.Stringer("Temporality", temporality),
+ zap.Stringer("MetricType", dataType),
+ )
+ nrMetric := telemetry.Gauge{
+ Name: m.Name(),
+ Attributes: attributes,
+ Value: float64(point.Value()),
+ Timestamp: point.StartTimestamp().AsTime(),
+ }
+ output = append(output, nrMetric)
+ } else {
+ nrMetric := telemetry.Count{
+ Name: m.Name(),
+ Attributes: attributes,
+ Value: float64(point.Value()),
+ Timestamp: point.StartTimestamp().AsTime(),
+ Interval: time.Duration(point.Timestamp() - point.StartTimestamp()),
+ }
+ output = append(output, nrMetric)
  }
- output = append(output, nrMetric)
  }
  case pdata.MetricDataTypeDoubleSum:
  sum := m.DoubleSum()
  temporality := sum.AggregationTemporality()
  k.MetricTemporality = temporality
  t.details.metricMetadataCount[k]++
 
- if temporality != pdata.AggregationTemporalityDelta {
- return nil, &errUnsupportedMetricType{metricType: k.MetricType.String(), metricName: m.Name(), numDataPoints: sum.DataPoints().Len()}
- }
-
  points := sum.DataPoints()
  output = make([]telemetry.Metric, 0, points.Len())
  for l := 0; l < points.Len(); l++ {
  point := points.At(l)
  attributes := t.MetricAttributes(baseAttributes, point.LabelsMap())
 
- nrMetric := telemetry.Count{
- Name: m.Name(),
- Attributes: attributes,
- Value: point.Value(),
- Timestamp: point.StartTimestamp().AsTime(),
- Interval: time.Duration(point.Timestamp() - point.StartTimestamp()),
+ if temporality != pdata.AggregationTemporalityDelta {
+ t.logger.Debug("Converting metric to gauge where AggregationTemporality != Delta",
+ zap.String("MetricName", m.Name()),
+ zap.Stringer("Temporality", temporality),
+ zap.Stringer("MetricType", dataType),
+ )
+ nrMetric := telemetry.Gauge{
+ Name: m.Name(),
+ Attributes: attributes,
+ Value: point.Value(),
+ Timestamp: point.StartTimestamp().AsTime(),
+ }
+ output = append(output, nrMetric)
+ } else {
+ nrMetric := telemetry.Count{
+ Name: m.Name(),
+ Attributes: attributes,
+ Value: point.Value(),
+ Timestamp: point.StartTimestamp().AsTime(),
+ Interval: time.Duration(point.Timestamp() - point.StartTimestamp()),
+ }
+ output = append(output, nrMetric)
  }
- output = append(output, nrMetric)
  }
  case pdata.MetricDataTypeIntHistogram:
  t.details.metricMetadataCount[k]++

diff --git a/exporter/newrelicexporter/transformer_test.go b/exporter/newrelicexporter/transformer_test.go
@@ -28,6 +28,7 @@ import (
  "go.opentelemetry.io/collector/component"
  "go.opentelemetry.io/collector/consumer/pdata"
  "go.opentelemetry.io/collector/translator/internaldata"
+ "go.uber.org/zap"
 )
 
 func TestCommonAttributes(t *testing.T) {
@@ -44,7 +45,7 @@ func TestCommonAttributes(t *testing.T) {
  ilm.SetVersion("test version")
 
  details := newTraceMetadata(context.TODO())
- commonAttrs := newTransformer(buildInfo, &details).CommonAttributes(resource, ilm)
+ commonAttrs := newTransformer(zap.NewNop(), buildInfo, &details).CommonAttributes(resource, ilm)
  assert.Equal(t, "the-collector", commonAttrs[collectorNameKey])
  assert.Equal(t, "0.0.1", commonAttrs[collectorVersionKey])
  assert.Equal(t, "R1", commonAttrs["resource"])
@@ -68,15 +69,15 @@ func TestDoesNotCaptureResourceAttributeMetadata(t *testing.T) {
  ilm.SetVersion("test version")
 
  details := newTraceMetadata(context.TODO())
- commonAttrs := newTransformer(buildInfo, &details).CommonAttributes(resource, ilm)
+ commonAttrs := newTransformer(zap.NewNop(), buildInfo, &details).CommonAttributes(resource, ilm)
 
  assert.Greater(t, len(commonAttrs), 0)
  assert.Equal(t, 0, len(details.attributeMetadataCount))
 }
 
 func TestCaptureSpanMetadata(t *testing.T) {
  details := newTraceMetadata(context.TODO())
- transform := newTransformer(nil, &details)
+ transform := newTransformer(zap.NewNop(), nil, &details)
 
  tests := []struct {
  name string
@@ -150,7 +151,7 @@ func TestCaptureSpanMetadata(t *testing.T) {
 
 func TestCaptureSpanAttributeMetadata(t *testing.T) {
  details := newTraceMetadata(context.TODO())
- transform := newTransformer(nil, &details)
+ transform := newTransformer(zap.NewNop(), nil, &details)
 
  s := pdata.NewSpan()
  s.SetTraceID(pdata.NewTraceID([...]byte{1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}))
@@ -173,7 +174,7 @@ func TestCaptureSpanAttributeMetadata(t *testing.T) {
 
 func TestDoesNotCaptureSpanAttributeMetadata(t *testing.T) {
  details := newTraceMetadata(context.TODO())
- transform := newTransformer(nil, &details)
+ transform := newTransformer(zap.NewNop(), nil, &details)
 
  s := pdata.NewSpan()
  s.SetTraceID(pdata.NewTraceID([...]byte{1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1}))
@@ -191,7 +192,7 @@ func TestDoesNotCaptureSpanAttributeMetadata(t *testing.T) {
 func TestTransformSpan(t *testing.T) {
  now := time.Unix(100, 0)
  details := newTraceMetadata(context.TODO())
- transform := newTransformer(nil, &details)
+ transform := newTransformer(zap.NewNop(), nil, &details)
 
  tests := []struct {
  name string
@@ -466,7 +467,7 @@ func testTransformMetric(t *testing.T, metric pdata.Metric, want []telemetry.Met
 
 func testTransformMetricWithComparer(t *testing.T, metric pdata.Metric, want []telemetry.Metric, compare func(t *testing.T, want []telemetry.Metric, got []telemetry.Metric)) {
  details := newMetricMetadata(context.Background())
- transform := newTransformer(&component.BuildInfo{
+ transform := newTransformer(zap.NewNop(), &component.BuildInfo{
  Command: testCollectorName,
  Version: testCollectorVersion,
  }, &details)
@@ -483,7 +484,7 @@ func testTransformMetricWithComparer(t *testing.T, metric pdata.Metric, want []t
 
 func testTransformMetricWithError(t *testing.T, metric pdata.Metric, expectedErrorType interface{}) {
  details := newMetricMetadata(context.Background())
- transform := newTransformer(&component.BuildInfo{
+ transform := newTransformer(zap.NewNop(), &component.BuildInfo{
  Command: testCollectorName,
  Version: testCollectorVersion,
  }, &details)
@@ -552,6 +553,17 @@ func TestTransformSum(t *testing.T) {
  },
  },
  }
+ expectedGauge := []telemetry.Metric{
+ telemetry.Gauge{
+ Name: "sum",
+ Value: 42.0,
+ Timestamp: start.AsTime(),
+ Attributes: map[string]interface{}{
+ "unit": "1",
+ "description": "description",
+ },
+ },
+ }
 
  {
  m := pdata.NewMetric()
@@ -579,7 +591,7 @@ func TestTransformSum(t *testing.T) {
  dp.SetStartTimestamp(start)
  dp.SetTimestamp(end)
  dp.SetValue(42.0)
- t.Run("DoubleSum-Cumulative", func(t *testing.T) { testTransformMetricWithError(t, m, &errUnsupportedMetricType{}) })
+ t.Run("DoubleSum-Cumulative", func(t *testing.T) { testTransformMetric(t, m, expectedGauge) })
  }
  {
  m := pdata.NewMetric()
@@ -607,7 +619,7 @@ func TestTransformSum(t *testing.T) {
  dp.SetStartTimestamp(start)
  dp.SetTimestamp(end)
  dp.SetValue(42.0)
- t.Run("IntSum-Cumulative", func(t *testing.T) { testTransformMetricWithError(t, m, &errUnsupportedMetricType{}) })
+ t.Run("IntSum-Cumulative", func(t *testing.T) { testTransformMetric(t, m, expectedGauge) })
  }
 }
 
@@ -738,7 +750,7 @@ func TestUnsupportedMetricTypes(t *testing.T) {
 func TestTransformUnknownMetricType(t *testing.T) {
  metric := pdata.NewMetric()
  details := newMetricMetadata(context.Background())
- transform := newTransformer(&component.BuildInfo{
+ transform := newTransformer(zap.NewNop(), &component.BuildInfo{
  Command: testCollectorName,
  Version: testCollectorVersion,
  }, &details)
@@ -837,7 +849,7 @@ func TestTransformer_Log(t *testing.T) {
  for _, test := range tests {
  t.Run(test.name, func(t *testing.T) {
  details := newLogMetadata(context.TODO())
- transform := newTransformer(nil, &details)
+ transform := newTransformer(zap.NewNop(), nil, &details)
  got, _ := transform.Log(test.logFunc())
  assert.EqualValues(t, test.want, got)
  })
@@ -851,7 +863,7 @@ func TestCaptureLogAttributeMetadata(t *testing.T) {
  log.Body().SetStringVal("Hello World")
 
  details := newLogMetadata(context.TODO())
- transform := newTransformer(nil, &details)
+ transform := newTransformer(zap.NewNop(), nil, &details)
  _, err := transform.Log(log)
 
  require.NoError(t, err)
@@ -865,7 +877,7 @@ func TestDoesNotCaptureLogAttributeMetadata(t *testing.T) {
  log.Body().SetStringVal("Hello World")
 
  details := newLogMetadata(context.TODO())
- transform := newTransformer(nil, &details)
+ transform := newTransformer(zap.NewNop(), nil, &details)
  _, err := transform.Log(log)
 
  require.NoError(t, err)