You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 2.7 KiB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. # gRPC-Go
  2. [![Build Status](https://travis-ci.org/grpc/grpc-go.svg)](https://travis-ci.org/grpc/grpc-go) [![GoDoc](https://godoc.org/google.golang.org/grpc?status.svg)](https://godoc.org/google.golang.org/grpc) [![GoReportCard](https://goreportcard.com/badge/grpc/grpc-go)](https://goreportcard.com/report/github.com/grpc/grpc-go)
  3. The Go implementation of [gRPC](https://grpc.io/): A high performance, open source, general RPC framework that puts mobile and HTTP/2 first. For more information see the [gRPC Quick Start: Go](https://grpc.io/docs/quickstart/go.html) guide.
  4. Installation
  5. ------------
  6. To install this package, you need to install Go and setup your Go workspace on your computer. The simplest way to install the library is to run:
  7. ```
  8. $ go get -u google.golang.org/grpc
  9. ```
  10. Prerequisites
  11. -------------
  12. gRPC-Go requires Go 1.9 or later.
  13. Constraints
  14. -----------
  15. The grpc package should only depend on standard Go packages and a small number of exceptions. If your contribution introduces new dependencies which are NOT in the [list](https://godoc.org/google.golang.org/grpc?imports), you need a discussion with gRPC-Go authors and consultants.
  16. Documentation
  17. -------------
  18. See [API documentation](https://godoc.org/google.golang.org/grpc) for package and API descriptions and find examples in the [examples directory](examples/).
  19. Performance
  20. -----------
  21. See the current benchmarks for some of the languages supported in [this dashboard](https://performance-dot-grpc-testing.appspot.com/explore?dashboard=5652536396611584&widget=490377658&container=1286539696).
  22. Status
  23. ------
  24. General Availability [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages).
  25. FAQ
  26. ---
  27. #### Compiling error, undefined: grpc.SupportPackageIsVersion
  28. Please update proto package, gRPC package and rebuild the proto files:
  29. - `go get -u github.com/golang/protobuf/{proto,protoc-gen-go}`
  30. - `go get -u google.golang.org/grpc`
  31. - `protoc --go_out=plugins=grpc:. *.proto`
  32. #### How to turn on logging
  33. The default logger is controlled by the environment variables. Turn everything
  34. on by setting:
  35. ```
  36. GRPC_GO_LOG_VERBOSITY_LEVEL=99 GRPC_GO_LOG_SEVERITY_LEVEL=info
  37. ```
  38. #### The RPC failed with error `"code = Unavailable desc = transport is closing"`
  39. This error means the connection the RPC is using was closed, and there are many
  40. possible reasons, including:
  41. 1. mis-configured transport credentials, connection failed on handshaking
  42. 1. bytes disrupted, possibly by a proxy in between
  43. 1. server shutdown
  44. It can be tricky to debug this because the error happens on the client side but
  45. the root cause of the connection being closed is on the server side. Turn on
  46. logging on __both client and server__, and see if there are any transport
  47. errors.