diff options
Diffstat (limited to 'vendor/google.golang.org/grpc/README.md')
-rw-r--r-- | vendor/google.golang.org/grpc/README.md | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/vendor/google.golang.org/grpc/README.md b/vendor/google.golang.org/grpc/README.md index 72c7325..e3fb3c7 100644 --- a/vendor/google.golang.org/grpc/README.md +++ b/vendor/google.golang.org/grpc/README.md | |||
@@ -1,6 +1,6 @@ | |||
1 | # gRPC-Go | 1 | # gRPC-Go |
2 | 2 | ||
3 | [![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) | 3 | [![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) |
4 | 4 | ||
5 | 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. | 5 | 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. |
6 | 6 | ||
@@ -10,13 +10,13 @@ Installation | |||
10 | 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: | 10 | 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: |
11 | 11 | ||
12 | ``` | 12 | ``` |
13 | $ go get google.golang.org/grpc | 13 | $ go get -u google.golang.org/grpc |
14 | ``` | 14 | ``` |
15 | 15 | ||
16 | Prerequisites | 16 | Prerequisites |
17 | ------------- | 17 | ------------- |
18 | 18 | ||
19 | This requires Go 1.6 or later. | 19 | gRPC-Go requires Go 1.9 or later. |
20 | 20 | ||
21 | Constraints | 21 | Constraints |
22 | ----------- | 22 | ----------- |
@@ -43,3 +43,25 @@ Please update proto package, gRPC package and rebuild the proto files: | |||
43 | - `go get -u github.com/golang/protobuf/{proto,protoc-gen-go}` | 43 | - `go get -u github.com/golang/protobuf/{proto,protoc-gen-go}` |
44 | - `go get -u google.golang.org/grpc` | 44 | - `go get -u google.golang.org/grpc` |
45 | - `protoc --go_out=plugins=grpc:. *.proto` | 45 | - `protoc --go_out=plugins=grpc:. *.proto` |
46 | |||
47 | #### How to turn on logging | ||
48 | |||
49 | The default logger is controlled by the environment variables. Turn everything | ||
50 | on by setting: | ||
51 | |||
52 | ``` | ||
53 | GRPC_GO_LOG_VERBOSITY_LEVEL=99 GRPC_GO_LOG_SEVERITY_LEVEL=info | ||
54 | ``` | ||
55 | |||
56 | #### The RPC failed with error `"code = Unavailable desc = transport is closing"` | ||
57 | |||
58 | This error means the connection the RPC is using was closed, and there are many | ||
59 | possible reasons, including: | ||
60 | 1. mis-configured transport credentials, connection failed on handshaking | ||
61 | 1. bytes disrupted, possibly by a proxy in between | ||
62 | 1. server shutdown | ||
63 | |||
64 | It can be tricky to debug this because the error happens on the client side but | ||
65 | the root cause of the connection being closed is on the server side. Turn on | ||
66 | logging on __both client and server__, and see if there are any transport | ||
67 | errors. | ||