Merge pull request #15 from newrelic/rabolofia/infinite-tracing

Make it easier to use Infinite Tracing.

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## ChangeLog
 
+## 0.3.0
+
+* Added `ConfigSpansURLOverride` to facilitate setting the Trace Observer URL
+  for Infinite Tracing on the New Relic Edge.
+
 ## 0.2.0
 
 * The SDK will now check metrics for infinity and NaN.  Metrics with invalid

telemetry/config.go

@@ -40,14 +40,18 @@ type Config struct {
 	// MetricsURLOverride overrides the metrics endpoint if not not empty.
 	MetricsURLOverride string
 	// SpansURLOverride overrides the spans endpoint if not not empty.
+	//
+	// To enable Infinite Tracing on the New Relic Edge, set this field to your
+	// Trace Observer URL.  See
+	// https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/enable-configure/enable-distributed-tracing
 	SpansURLOverride string
 	// Product is added to the User-Agent header. eg. "NewRelic-Go-OpenCensus"
 	Product string
 	// ProductVersion is added to the User-Agent header. eg. "0.1.0".
 	ProductVersion string
 }
 
-// ConfigAPIKey sets the Config's APIKey which is required  and refers to your
+// ConfigAPIKey sets the Config's APIKey which is required and refers to your
 // New Relic Insights Insert API key.
 func ConfigAPIKey(key string) func(*Config) {
 	return func(cfg *Config) {
@@ -108,6 +112,14 @@ func ConfigBasicAuditLogger(w io.Writer) func(*Config) {
 	}
 }
 
+// ConfigSpansURLOverride sets the Config's SpansURLOverride field which
+// overrides the spans endpoint if not not empty.
+func ConfigSpansURLOverride(url string) func(*Config) {
+	return func(cfg *Config) {
+		cfg.SpansURLOverride = url
+	}
+}
+
 // configTesting is the config function to be used when testing. It sets the
 // APIKey but disables the harvest goroutine.
 func configTesting(cfg *Config) {

telemetry/example_test.go

@@ -89,3 +89,24 @@ func ExampleHarvester_RecordMetric() {
 		Interval:       5 * time.Second,
 	})
 }
+
+func ExampleConfigSpansURLOverride() {
+	h, _ := NewHarvester(
+		ConfigAPIKey(os.Getenv("NEW_RELIC_INSIGHTS_INSERT_API_KEY")),
+		// Use ConfigSpansURLOverride to enable Infinite Tracing on the New
+		// Relic Edge by passing it your Trace Observer URL, including scheme
+		// and path.
+		ConfigSpansURLOverride("https://nr-internal.aws-us-east-1.tracing.edge.nr-data.net/trace/v1"),
+	)
+	h.RecordSpan(Span{
+		ID:          "12345",
+		TraceID:     "67890",
+		Name:        "purple-span",
+		Timestamp:   time.Now(),
+		Duration:    time.Second,
+		ServiceName: "ExampleApplication",
+		Attributes: map[string]interface{}{
+			"color": "purple",
+		},
+	})
+}