The Go language implementation of gRPC. HTTP/2 based RPC
Перейти к файлу
Menghan Li a12250e98f
xds/cds: add env var for aggregated and DNS cluster (#4440)
2021-05-14 15:20:45 -07:00
.github github: testing action workflow improvements and update to test Go1.16 (#4358) 2021-04-22 14:59:51 -07:00
Documentation Fix typo in encoding.md (#4020) 2020-11-17 15:54:06 -08:00
admin xds: use different proto import for grpc services (#4285) 2021-03-23 13:26:01 -07:00
attributes roundrobin: strip attributes from addresses (#4024) 2020-11-30 14:20:03 -08:00
backoff client: add WithConnectParams to configure connection backoff and timeout (#2960) 2019-10-03 16:47:13 -07:00
balancer internal: regenerate proto (#4373) 2021-04-29 12:17:56 -07:00
benchmark benchmark: do not allow addition of values lower than the minimum allowed in histogram stats 2021-05-12 17:15:47 -07:00
binarylog cleanup: use different import alias for services than messages (#4148) 2021-01-12 12:23:41 -08:00
channelz cleanup: use testutils.MarshalAny in more places (#4404) 2021-05-10 09:35:55 -07:00
cmd/protoc-gen-go-grpc cmd/protoc-gen-go-grpc: add protoc and protoc-gen-go-grpc versions to top comment (#4313) 2021-04-09 16:30:59 -07:00
codes codes: document which error codes can be returned by the framework (#3699) 2020-07-09 13:32:33 -07:00
connectivity connectivity: Get rid of unused Reporter interface. (#3875) 2020-09-14 16:52:49 -07:00
credentials xds: moved shared matchers to internal/xds (#4441) 2021-05-14 17:02:10 -04:00
encoding encoding/proto: do not panic when types do not match (#4218) 2021-02-23 09:47:33 -08:00
examples example: correct the default value for server_host_override (#4407) 2021-05-14 14:09:26 -07:00
grpclog standardized experimental warnings (#3917) 2020-10-02 09:11:08 -07:00
health cmd/protoc-gen-go-grpc: add protoc and protoc-gen-go-grpc versions to top comment (#4313) 2021-04-09 16:30:59 -07:00
internal xds/cds: add env var for aggregated and DNS cluster (#4440) 2021-05-14 15:20:45 -07:00
interop interop/xds: support xds credentials in interop client (#4436) 2021-05-14 11:13:26 -07:00
keepalive
metadata metadata: reduce memory footprint in FromOutgoingContext (#4360) 2021-04-28 10:05:50 -07:00
peer
profiling cmd/protoc-gen-go-grpc: add protoc and protoc-gen-go-grpc versions to top comment (#4313) 2021-04-09 16:30:59 -07:00
reflection reflection: accept interface instead of grpc.Server struct in Register() (#4340) 2021-04-27 13:15:08 -07:00
resolver Move exponential backoff to DNS resolver from resolver.ClientConn (#4270) 2021-04-20 13:20:09 -04:00
security update go.mod and go.sum to point to latest go-control-plane (#4425) 2021-05-12 15:52:15 -07:00
serviceconfig standardized experimental warnings (#3917) 2020-10-02 09:11:08 -07:00
stats cleanup: use different import alias for services than messages (#4148) 2021-01-12 12:23:41 -08:00
status status: document nil error handling of FromError (#4196) 2021-02-09 09:47:07 -08:00
stress cmd/protoc-gen-go-grpc: add protoc and protoc-gen-go-grpc versions to top comment (#4313) 2021-04-09 16:30:59 -07:00
tap transport: allow InTapHandle to return status errors (#4365) 2021-05-07 14:37:52 -07:00
test client: fix ForceCodec to set content-type header appropriately (#4401) 2021-05-11 17:05:16 -07:00
testdata internal/credentials: fix a bug and add one more helper function SPIFFEIDFromCert (#3929) 2020-10-09 12:57:50 -07:00
xds xds/cds: add env var for aggregated and DNS cluster (#4440) 2021-05-14 15:20:45 -07:00
.travis.yml advancedtls: add examples for reloading from file system (#3976) 2020-10-27 09:58:31 -07:00
AUTHORS
CODE-OF-CONDUCT.md
CONTRIBUTING.md Remove Go 1.9 / AppEngine support; assume go1.12 build tag (#3767) 2020-07-30 16:15:35 -07:00
GOVERNANCE.md
LICENSE
MAINTAINERS.md
Makefile Makefile: enable module support in deps (#4062) 2020-11-24 16:53:57 -08:00
README.md README: change badge to pkg.go.dev (#3768) 2020-07-30 13:39:09 -07:00
SECURITY.md github: improve security policy documentation (#4130) 2020-12-22 13:01:38 -08:00
backoff.go standardized experimental warnings (#3917) 2020-10-02 09:11:08 -07:00
balancer_conn_wrappers.go Revert "grpc: call balancer.Close() before returning from ccBalancerWrapper.close()" (#4391) 2021-05-06 13:28:27 -07:00
balancer_switching_test.go testing: Avoid using context.Background (#3949) 2020-11-05 09:25:17 -08:00
call.go
call_test.go testing: Avoid using context.Background (#3949) 2020-11-05 09:25:17 -08:00
clientconn.go client: initialize safe config selector when creating ClientConn (#4398) 2021-05-07 15:24:10 -07:00
clientconn_state_transition_test.go Fix goroutine leaks (#4214) 2021-04-19 09:49:37 -07:00
clientconn_test.go testdata: Update testdata certs. (#3786) 2020-08-05 09:55:07 -07:00
codec.go revert buffer reuse (#3338) 2020-01-27 13:30:41 -08:00
codec_test.go
codegen.sh
dialoptions.go Move exponential backoff to DNS resolver from resolver.ClientConn (#4270) 2021-04-20 13:20:09 -04:00
doc.go all: refactor .pb.go generation (#3451) 2020-04-24 08:54:03 -07:00
go.mod update go.mod and go.sum to point to latest go-control-plane (#4425) 2021-05-12 15:52:15 -07:00
go.sum update go.mod and go.sum to point to latest go-control-plane (#4425) 2021-05-12 15:52:15 -07:00
grpc_test.go Modified tests to use tlogger. (#3343) 2020-02-06 13:03:20 -08:00
install_gae.sh internal: reintroduce legacy appengine build constraints (#3850) 2020-08-27 11:04:57 -07:00
interceptor.go Remove experimental comment from client interceptors (#3948) 2020-10-26 07:33:18 -07:00
picker_wrapper.go Implemented component logging (#3617) 2020-06-26 12:04:47 -07:00
picker_wrapper_test.go balancer: move Balancer and Picker to V2; delete legacy API (#3431) 2020-04-28 14:52:49 -07:00
pickfirst.go balancer: Add UpdateAddresses() to balancer.ClientConn interface (#4215) 2021-02-25 15:48:39 -08:00
pickfirst_test.go test: replace manual.GenerateAndRegisterManualResolver with grpc.WithResolvers (#3700) 2020-06-23 09:49:44 -07:00
preloader.go standardized experimental warnings (#3917) 2020-10-02 09:11:08 -07:00
regenerate.sh meshca: remove meshca certificate provider implementation (#4385) 2021-05-04 14:38:47 -07:00
resolver_conn_wrapper.go Move exponential backoff to DNS resolver from resolver.ClientConn (#4270) 2021-04-20 13:20:09 -04:00
resolver_conn_wrapper_test.go Move exponential backoff to DNS resolver from resolver.ClientConn (#4270) 2021-04-20 13:20:09 -04:00
rpc_util.go client: fix ForceCodec to set content-type header appropriately (#4401) 2021-05-11 17:05:16 -07:00
rpc_util_test.go internal/resolver/unix: Implemented unix resolver. (#3890) 2020-10-16 11:52:54 -07:00
server.go transport: allow InTapHandle to return status errors (#4365) 2021-05-07 14:37:52 -07:00
server_test.go
service_config.go xds: add ConfigSelector to support RouteAction timeouts (#3991) 2020-11-17 13:22:28 -08:00
service_config_test.go service config: add default method config support (#3684) 2020-07-06 17:56:02 -07:00
stream.go grpc: improve docs on StreamDesc (#4397) 2021-05-07 11:17:26 -07:00
trace.go trace: fix getting family for the method (#3216) 2019-12-19 13:23:11 -08:00
trace_test.go trace: fix getting family for the method (#3216) 2019-12-19 13:23:11 -08:00
version.go Change version to 1.39.0-dev (#4420) 2021-05-11 15:28:46 -07:00
vet.sh Invoke Go Vet Check in Sub-modules (#4302) 2021-04-02 11:19:22 -07:00

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.