nrnats

README

v3/integrations/nrnats

Package nrnats instruments https://github.com/nats-io/nats.go.

import "github.com/newrelic/go-agent/v3/integrations/nrnats"

For more information, see godocs.

Documentation

Overview

Package nrnats instruments https://github.com/nats-io/nats.go.

This package can be used to simplify instrumenting NATS publishers and subscribers. Currently due to the nature of the NATS framework we are limited to two integration points: `StartPublishSegment` for publishers, and `SubWrapper` for subscribers.

NATS publishers

To generate an external segment for any method that publishes or responds to a NATS message, use the `StartPublishSegment` method. The resulting segment will also need to be ended. Example:

nc, _ := nats.Connect(nats.DefaultURL)
txn := currentTransaction()  // current newrelic.Transaction
subject := "testing.subject"
seg := nrnats.StartPublishSegment(txn, nc, subject)
err := nc.Publish(subject, []byte("Hello World"))
if nil != err {
	panic(err)
}
seg.End()

Or:

nc, _ := nats.Connect(nats.DefaultURL)
txn := currentTransaction()  // current newrelic.Transaction
subject := "testing.subject"
defer nrnats.StartPublishSegment(txn, nc, subject).End()
nc.Publish(subject, []byte("Hello World"))

StartPublishSegment can be used with a NATS Streamming Connection as well (https://github.com/nats-io/stan.go). Use the `NatsConn()` method on the `stan.Conn` interface (https://godoc.org/github.com/nats-io/stan#Conn) to access the `nats.Conn` object.

sc, _ := stan.Connect(clusterID, clientID)
txn := currentTransaction()
subject := "testing.subject"
defer nrnats.StartPublishSegment(txn, sc.NatsConn(), subject).End()
sc.Publish(subject, []byte("Hello World"))

NATS subscribers

The `nrnats.SubWrapper` function can be used to wrap the function for `nats.Subscribe` (https://godoc.org/github.com/nats-io/go-nats#Conn.Subscribe or https://godoc.org/github.com/nats-io/go-nats#EncodedConn.Subscribe) and `nats.QueueSubscribe` (https://godoc.org/github.com/nats-io/go-nats#Conn.QueueSubscribe or https://godoc.org/github.com/nats-io/go-nats#EncodedConn.QueueSubscribe) If the `newrelic.Application` parameter is non-nil, it will create a `newrelic.Transaction` and end the transaction when the passed function is complete. Example:

nc, _ := nats.Connect(nats.DefaultURL)
app := createNRApp()  // newrelic.Application
subject := "testing.subject"
nc.Subscribe(subject, nrnats.SubWrapper(app, myMessageHandler))

Full Publisher/Subscriber example: https://github.com/newrelic/go-agent/blob/master/v3/integrations/nrnats/examples/main.go

Index

• func StartPublishSegment(txn *newrelic.Transaction, nc *nats.Conn, subject string) *newrelic.MessageProducerSegment
• func SubWrapper(app *newrelic.Application, f func(msg *nats.Msg)) func(msg *nats.Msg)

Examples

• StartPublishSegment
• StartPublishSegment (Defer)

Functions

func StartPublishSegment

func StartPublishSegment(txn *newrelic.Transaction, nc *nats.Conn, subject string) *newrelic.MessageProducerSegment

StartPublishSegment creates and starts a `newrelic.MessageProducerSegment` (https://godoc.org/github.com/newrelic/go-agent#MessageProducerSegment) for NATS publishers. Call this function before calling any method that publishes or responds to a NATS message. Call `End()` (https://godoc.org/github.com/newrelic/go-agent#MessageProducerSegment.End) on the returned newrelic.MessageProducerSegment when the publish is complete. The `newrelic.Transaction` and `nats.Conn` parameters are required. The subject parameter is the subject of the publish call and is used in metric and span names.

Example

nc, _ := nats.Connect(nats.DefaultURL)
txn := currentTransaction()
subject := "testing.subject"

// Start the Publish segment
seg := nrnats.StartPublishSegment(txn, nc, subject)
err := nc.Publish(subject, []byte("Hello World"))
if nil != err {
	panic(err)
}
// Manually end the segment
seg.End()

Example (Defer)

nc, _ := nats.Connect(nats.DefaultURL)
txn := currentTransaction()
subject := "testing.subject"

// Start the Publish segment and defer End till the func returns
defer nrnats.StartPublishSegment(txn, nc, subject).End()
m, err := nc.Request(subject, []byte("request"), time.Second)
if nil != err {
	panic(err)
}
fmt.Println("Received reply message:", string(m.Data))

func SubWrapper

func SubWrapper(app *newrelic.Application, f func(msg *nats.Msg)) func(msg *nats.Msg)

SubWrapper can be used to wrap the function for nats.Subscribe (https://godoc.org/github.com/nats-io/go-nats#Conn.Subscribe or https://godoc.org/github.com/nats-io/go-nats#EncodedConn.Subscribe) and nats.QueueSubscribe (https://godoc.org/github.com/nats-io/go-nats#Conn.QueueSubscribe or https://godoc.org/github.com/nats-io/go-nats#EncodedConn.QueueSubscribe) If the `newrelic.Application` parameter is non-nil, it will create a `newrelic.Transaction` and end the transaction when the passed function is complete.