The Go language implementation of gRPC. HTTP/2 based RPC
Go to file
Jean de Klerk 1b41b79fd1
internal: refactor transport to single retry mechanism (#2461)
Previously, the transport was able to reset via the retry loop,
or via the event closures calling resetTransport. This meant
a very large amount of synchronization was necessary: one
reset meant the other had to not reset; state had to be kept
at the addrconn; and very subtle interactions were hard to
reason about.

This change removes the ability for event closures to directly
reset the transport. Instead, they signal to to the retry
loop about the event, and the retry loop is always the single
place that retries occur.

This also allows us to refactor the address switching logic
into a much simpler for loop inside the retry loop instead of
using addrConn state to keep track of an index.
2018-12-17 13:10:13 -08:00
.github Add lock.yml for locking closed, stale PRs/issues (#2331) 2018-09-25 14:15:54 -07:00
Documentation examples: metadata (#2500) 2018-12-13 14:45:14 -08:00
balancer client: deprecates FailFast & replaces its use by WaitForReady. 2018-12-13 15:15:11 -08:00
benchmark cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
binarylog/grpc_binarylog_v1 binarylog: implement methodlogger (#2334) 2018-10-18 17:27:11 -07:00
channelz cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
codes codes: fix: marshal/unmarshal a Code to JSON fails (#2116) 2018-06-01 10:56:55 -07:00
connectivity cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
credentials client: deprecates FailFast & replaces its use by WaitForReady. 2018-12-13 15:15:11 -08:00
encoding Remove support for Go1.6-1.8 (#2428) 2018-11-01 15:43:42 -07:00
examples examples: deadline (#2494) 2018-12-14 15:36:21 -08:00
grpclog Fix "deprecated" function godoc comments to match standard formatting (#2027) 2018-05-02 08:52:49 -07:00
health health: shutdown server to set NOT_SERVING and disallow future updates (#2513) 2018-12-10 14:17:43 -08:00
internal internal: refactor transport to single retry mechanism (#2461) 2018-12-17 13:10:13 -08:00
interop cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
keepalive comment typo: MaxConnectionAgeGrace(#2515) 2018-12-09 23:18:17 -08:00
metadata cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
naming cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
peer cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
reflection client: deprecates FailFast & replaces its use by WaitForReady. 2018-12-13 15:15:11 -08:00
resolver cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
stats client: deprecates FailFast & replaces its use by WaitForReady. 2018-12-13 15:15:11 -08:00
status Remove support for Go1.6-1.8 (#2428) 2018-11-01 15:43:42 -07:00
stress client: deprecates FailFast & replaces its use by WaitForReady. 2018-12-13 15:15:11 -08:00
tap cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
test health check test: prevent double close of hcEnterChan (#2441) 2018-12-13 16:44:36 -08:00
testdata testdata: get test assets related to package root instead of GOPATH (#2272) 2018-08-22 09:00:39 -07:00
.travis.yml travis: remove Go 1.6 and 1.8 tests (#2415) 2018-11-01 08:50:05 -07:00
AUTHORS add AUTHORS and LICENSE 2017-06-08 14:37:28 +02:00
CONTRIBUTING.md documentation: add instructions for running tests locally (#2006) 2018-04-19 17:17:21 -07:00
LICENSE Make Apache 2.0 LICENSE file a verbatim copy (#1329) 2017-06-21 10:20:47 -07:00
Makefile Transport refactor (#2305) 2018-09-20 15:45:40 -07:00
README.md Remove support for Go1.6-1.8 (#2428) 2018-11-01 15:43:42 -07:00
backoff.go internal: move backoff to internal (#2141) 2018-06-13 16:07:37 -07:00
balancer.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
balancer_conn_wrappers.go grpclb: filter out grpclb addresses if balancer in use is not grpclb (#2509) 2018-12-13 10:54:42 -08:00
balancer_switching_test.go grpclb: filter out grpclb addresses if balancer in use is not grpclb (#2509) 2018-12-13 10:54:42 -08:00
balancer_test.go client: deprecates FailFast & replaces its use by WaitForReady. 2018-12-13 15:15:11 -08:00
balancer_v1_wrapper.go plumb lastConn error in v1 balancer (#2508) 2018-12-07 09:12:49 -08:00
call.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
call_test.go client: deprecates FailFast & replaces its use by WaitForReady. 2018-12-13 15:15:11 -08:00
clientconn.go internal: refactor transport to single retry mechanism (#2461) 2018-12-17 13:10:13 -08:00
clientconn_state_transition_test.go internal: refactor transport to single retry mechanism (#2461) 2018-12-17 13:10:13 -08:00
clientconn_test.go internal: refactor transport to single retry mechanism (#2461) 2018-12-17 13:10:13 -08:00
codec.go encoding: Introduce new method for registering and choosing codecs (#1813) 2018-01-23 11:39:40 -08:00
codec_test.go encoding: Introduce new method for registering and choosing codecs (#1813) 2018-01-23 11:39:40 -08:00
codegen.sh FIX: use /usr/bin/env bash in shebang 2016-12-17 20:45:30 +01:00
dialoptions.go health check test: prevent double close of hcEnterChan (#2441) 2018-12-13 16:44:36 -08:00
doc.go Fix missing and wrong license (#1422) 2017-08-04 13:46:18 -07:00
go.mod internal: update golint to use new url (#2393) 2018-10-31 14:39:18 -06:00
go.sum internal: update golint to use new url (#2393) 2018-10-31 14:39:18 -06:00
install_gae.sh testing: upgrade appengine sdk to version 1.9.68 (#2311) 2018-09-18 10:42:17 -07:00
interceptor.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
picker_wrapper.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
picker_wrapper_test.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
pickfirst.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
pickfirst_test.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
proxy.go proxy: support basic authentication (#2426) 2018-11-13 14:59:16 -08:00
proxy_test.go proxy: support basic authentication (#2426) 2018-11-13 14:59:16 -08:00
resolver_conn_wrapper.go resolverWrapper: remove the watcher goroutine (#2446) 2018-11-09 15:31:07 -08:00
resolver_conn_wrapper_test.go tests: fix leak in TestDialParseTargetUnknownScheme (#2320) 2018-09-27 13:50:06 -07:00
rpc_util.go client: deprecates FailFast & replaces its use by WaitForReady. 2018-12-13 15:15:11 -08:00
rpc_util_test.go transport: eliminate StreamError; use status errors instead (#2239) 2018-07-26 10:30:58 -07:00
server.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
server_test.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
service_config.go health: Client LB channel health checking (#2387) 2018-11-01 10:49:35 -07:00
service_config_test.go Change parseTimeout to not handle non-second durations (#1706) 2017-12-05 10:04:04 -08:00
stream.go cleanup: replace "x/net/context" import with "context" (#2439) 2018-11-12 13:30:41 -08:00
trace.go Truncate payload trace string, and turn trace off by default (#1509) 2017-09-08 11:13:41 -07:00
version.go Change version to 1.18.0-dev (#2498) 2018-12-04 16:43:20 -08:00
vet.sh health check test: prevent double close of hcEnterChan (#2441) 2018-12-13 16:44:36 -08: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 gRPC Quick Start: Go guide.

Installation

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:

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

Prerequisites

gRPC-Go requires Go 1.9 or later.

Constraints

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, you need a discussion with gRPC-Go authors and consultants.

Documentation

See API documentation for package and API descriptions and find examples in the examples directory.

Performance

See the current benchmarks for some of the languages supported in this dashboard.

Status

General Availability Google Cloud Platform Launch Stages.

FAQ

Compiling error, undefined: grpc.SupportPackageIsVersion

Please update 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 the environment variables. Turn everything on by setting:

GRPC_GO_LOG_VERBOSITY_LEVEL=99 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

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.