Google Git
Sign in
fuchsia / third_party / github.com / grpc / grpc-go / f6c335c7c19d817390ac7b807971a788fe7d748d
commitf6c335c7c19d817390ac7b807971a788fe7d748d[log] [tgz]
authorEaswar Swaminathan <easwars@google.com>Fri Nov 20 08:49:47 2020 -0800
committerGitHub <noreply@github.com>Fri Nov 20 08:49:47 2020 -0800
treebb20f49afabb4f7500e9c56926f22f214bf57da2
parent40076094f63b809cebb5fad728a08cac98373c7c [diff]
github: Bump up Go version in testing workflow (#4051)
1 file changed
tree: bb20f49afabb4f7500e9c56926f22f214bf57da2
  1. .github/
  2. attributes/
  3. backoff/
  4. balancer/
  5. benchmark/
  6. binarylog/
  7. channelz/
  8. cmd/
  9. codes/
  10. connectivity/
  11. credentials/
  12. Documentation/
  13. encoding/
  14. examples/
  15. grpclog/
  16. health/
  17. internal/
  18. interop/
  19. keepalive/
  20. metadata/
  21. peer/
  22. profiling/
  23. reflection/
  24. resolver/
  25. security/
  26. serviceconfig/
  27. stats/
  28. status/
  29. stress/
  30. tap/
  31. test/
  32. testdata/
  33. xds/
  34. .travis.yml
  35. AUTHORS
  36. backoff.go
  37. balancer_conn_wrappers.go
  38. balancer_conn_wrappers_test.go
  39. balancer_switching_test.go
  40. call.go
  41. call_test.go
  42. clientconn.go
  43. clientconn_state_transition_test.go
  44. clientconn_test.go
  45. CODE-OF-CONDUCT.md
  46. codec.go
  47. codec_test.go
  48. codegen.sh
  49. CONTRIBUTING.md
  50. dialoptions.go
  51. doc.go
  52. go.mod
  53. go.sum
  54. GOVERNANCE.md
  55. grpc_test.go
  56. install_gae.sh
  57. interceptor.go
  58. LICENSE
  59. MAINTAINERS.md
  60. Makefile
  61. picker_wrapper.go
  62. picker_wrapper_test.go
  63. pickfirst.go
  64. pickfirst_test.go
  65. preloader.go
  66. README.md
  67. regenerate.sh
  68. resolver_conn_wrapper.go
  69. resolver_conn_wrapper_test.go
  70. rpc_util.go
  71. rpc_util_test.go
  72. server.go
  73. server_test.go
  74. service_config.go
  75. service_config_test.go
  76. stream.go
  77. trace.go
  78. trace_test.go
  79. version.go
  80. vet.sh
README.md

gRPC-Go

Build Status GoDoc GoReportCard

The Go implementation of gRPC: A high performance, open source, general RPC framework that puts mobile and HTTP/2 first. For more information see the Go gRPC docs, or jump directly into the quick start.

Prerequisites

Installation

With Go module support (Go 1.11+), simply add the following import

import "google.golang.org/grpc"

to your code, and then go [build|run|test] will automatically fetch the necessary dependencies.

Otherwise, to install the grpc-go package, run the following command:

$ go get -u google.golang.org/grpc

Note: If you are trying to access grpc-go from China, see the FAQ below.

Learn more

FAQ

I/O Timeout Errors

The golang.org domain may be blocked from some countries. go get usually produces an error like the following when this happens:

$ go get -u google.golang.org/grpc
package google.golang.org/grpc: unrecognized import path "google.golang.org/grpc" (https fetch: Get https://google.golang.org/grpc?go-get=1: dial tcp 216.239.37.1:443: i/o timeout)

To build Go code, there are several options:

  • Set up a VPN and access google.golang.org through that.

  • Without Go module support: git clone the repo manually:

    git clone https://github.com/grpc/grpc-go.git $GOPATH/src/google.golang.org/grpc

    You will need to do the same for all of grpc's dependencies in golang.org, e.g. golang.org/x/net.

  • With Go module support: it is possible to use the replace feature of go mod to create aliases for golang.org packages. In your project's directory:

    go mod edit -replace=google.golang.org/grpc=github.com/grpc/grpc-go@latest
go mod tidy
go mod vendor
go build -mod=vendor

    Again, this will need to be done for all transitive dependencies hosted on golang.org as well. For details, refer to golang/go issue #28652.

Compiling error, undefined: grpc.SupportPackageIsVersion

If you are using Go modules:

Ensure your gRPC-Go version is required at the appropriate version in the same module containing the generated .pb.go files. For example, SupportPackageIsVersion6 needs v1.27.0, so in your go.mod file:

module <your module name>

require (
    google.golang.org/grpc v1.27.0
)

If you are not using Go modules:

Update the proto package, gRPC package, and rebuild the .proto files:

go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
go get -u google.golang.org/grpc
protoc --go_out=plugins=grpc:. *.proto

How to turn on logging

The default logger is controlled by environment variables. Turn everything on like this:

$ export GRPC_GO_LOG_VERBOSITY_LEVEL=99
$ export GRPC_GO_LOG_SEVERITY_LEVEL=info

The RPC failed with error "code = Unavailable desc = transport is closing"

This error means the connection the RPC is using was closed, and there are many possible reasons, including:

  1. mis-configured transport credentials, connection failed on handshaking
  2. bytes disrupted, possibly by a proxy in between
  3. server shutdown
  4. Keepalive parameters caused connection shutdown, for example if you have configured your server to terminate connections regularly to trigger DNS lookups. If this is the case, you may want to increase your MaxConnectionAgeGrace, to allow longer RPC calls to finish.

It can be tricky to debug this because the error happens on the client side but the root cause of the connection being closed is on the server side. Turn on logging on both client and server, and see if there are any transport errors.