https://github.com/izumin5210/nrgrpc

📈 gRPC `stats.Handler` implementation to measure and send performances metrics to New Relic
https://github.com/izumin5210/nrgrpc

golang grpc newrelic

Last synced: 4 months ago
JSON representation

📈 gRPC `stats.Handler` implementation to measure and send performances metrics to New Relic

• Host: GitHub
• URL: https://github.com/izumin5210/nrgrpc
• Owner: izumin5210
• License: mit
• Created: 2017-10-03T00:59:04.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-10-13T23:57:34.000Z (over 2 years ago)
• Last Synced: 2024-10-06T05:44:11.203Z (4 months ago)
• Topics: golang, grpc, newrelic
• Language: Go
• Homepage: https://godoc.org/github.com/izumin5210/nrgrpc
• Size: 43 KB
• Stars: 9
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nrgrpc

[![Build Status](https://travis-ci.com/izumin5210/nrgrpc.svg?branch=master)](https://travis-ci.com/izumin5210/nrgrpc)

[![codecov](https://codecov.io/gh/izumin5210/nrgrpc/branch/master/graph/badge.svg)](https://codecov.io/gh/izumin5210/nrgrpc)

[![GoDoc](https://godoc.org/github.com/izumin5210/nrgrpc?status.svg)](https://godoc.org/github.com/izumin5210/nrgrpc)

[![Go project version](https://badge.fury.io/go/github.com%2Fizumin5210%2Fnrgrpc.svg)](https://badge.fury.io/go/github.com%2Fizumin5210%2Fnrgrpc)

[![Go Report Card](https://goreportcard.com/badge/github.com/izumin5210/nrgrpc)](https://goreportcard.com/report/github.com/izumin5210/nrgrpc)

[![license](https://img.shields.io/github/license/izumin5210/nrgrpc.svg)](./LICENSE)

gRPC `stats.Handler` implementation to measure and send performances metrics to New Relic.

## Example

### gRPC server

`nrgrpc.NewServerStatsHandler` creates a [`stats.Handler`](https://godoc.org/google.golang.org/grpc/stats#Handler) instance for gRPC servers.

When the handler is passed to a gRPC server with [`grpc.StatsHandler`](https://godoc.org/google.golang.org/grpc#StatsHandler),

it will set a [`newrelic.Transaction`](https://godoc.org/github.com/newrelic/go-agent#Transaction) into a request `context.Context` using [`newrelic.NewContext`](https://godoc.org/github.com/newrelic/go-agent#NewContext).

So you can retrieve `newrelic.Transaction` instances with [`newrelic.FromContext`](https://godoc.org/github.com/newrelic/go-agent#FromContext).

```go

func main() {

	lis, err := net.Listen("tcp", ":3000")

	if err != nil {

		panic(err)

	}

	// Initiailze a `newrelic.Appliation`

	cfg := newrelic.NewConfig("your_app","your_license_key")

	nrapp, err := newrelic.NewApplication(cfg)

	if err != nil {

		panic(err)

	}

	s := grpc.NewServer(

		// Create a `stats.Handler` from `newrelic.Application`

		grpc.StatsHandler(nrgrpc.NewServerStatsHandler(nrapp)),

	)

	// Register server implementations

	s.Serve(lis)

}

```

### gRPC client

```go

func main() {

	// Initiailze a `newrelic.Appliation`

	nrapp, err := newrelic.NewApplication(newrelic.Config{

		AppName: "your_app",

		License: "your_license_key",

	})

	if err != nil {

		panic(err)

	}

	// Create a `grpc.ClientConn` with `stats.Handler`

	conn, err := grpc.Dial(

		":3000",

		grpc.WithInsecure(),

		grpc.WithStatsHandler(nrgrpc.NewClientStatsHandler()),

	)

	if err != nil {

		panic(err)

	}

	// Register http handler using `https://godoc.org/github.com/newrelic/go-agent.WrapHandleFunc`.

	// This wrapper sets `newrelic.Transaction` into the `http.Request`'s context.

	nrhttp.WrapHandleFunc(app, "/foo", func(w http.ResponseWriter, r *http.Request) {

		resp, err := NewFooServiceClient.BarCall(r.Context(), &BarRequest{})

		// ...

	})

}

```