Luther Monson 94b1e032bb vendor 4 years ago
..
attributes 94b1e032bb vendor 4 years ago
backoff 94b1e032bb vendor 4 years ago
balancer 94b1e032bb vendor 4 years ago
binarylog 94b1e032bb vendor 4 years ago
codes 94b1e032bb vendor 4 years ago
connectivity 94b1e032bb vendor 4 years ago
credentials 94b1e032bb vendor 4 years ago
encoding 94b1e032bb vendor 4 years ago
grpclog 94b1e032bb vendor 4 years ago
internal 94b1e032bb vendor 4 years ago
keepalive 94b1e032bb vendor 4 years ago
metadata 94b1e032bb vendor 4 years ago
naming 94b1e032bb vendor 4 years ago
peer 94b1e032bb vendor 4 years ago
resolver 94b1e032bb vendor 4 years ago
serviceconfig 94b1e032bb vendor 4 years ago
stats 94b1e032bb vendor 4 years ago
status 94b1e032bb vendor 4 years ago
tap 94b1e032bb vendor 4 years ago
.travis.yml 94b1e032bb vendor 4 years ago
AUTHORS 94b1e032bb vendor 4 years ago
CODE-OF-CONDUCT.md 94b1e032bb vendor 4 years ago
CONTRIBUTING.md 94b1e032bb vendor 4 years ago
GOVERNANCE.md 94b1e032bb vendor 4 years ago
LICENSE 94b1e032bb vendor 4 years ago
MAINTAINERS.md 94b1e032bb vendor 4 years ago
Makefile 94b1e032bb vendor 4 years ago
README.md 94b1e032bb vendor 4 years ago
backoff.go 94b1e032bb vendor 4 years ago
balancer.go 94b1e032bb vendor 4 years ago
balancer_conn_wrappers.go 94b1e032bb vendor 4 years ago
balancer_v1_wrapper.go 94b1e032bb vendor 4 years ago
call.go 94b1e032bb vendor 4 years ago
clientconn.go 94b1e032bb vendor 4 years ago
codec.go 94b1e032bb vendor 4 years ago
codegen.sh 94b1e032bb vendor 4 years ago
dialoptions.go 94b1e032bb vendor 4 years ago
doc.go 94b1e032bb vendor 4 years ago
go.mod 94b1e032bb vendor 4 years ago
go.sum 94b1e032bb vendor 4 years ago
install_gae.sh 94b1e032bb vendor 4 years ago
interceptor.go 94b1e032bb vendor 4 years ago
picker_wrapper.go 94b1e032bb vendor 4 years ago
pickfirst.go 94b1e032bb vendor 4 years ago
preloader.go 94b1e032bb vendor 4 years ago
proxy.go 94b1e032bb vendor 4 years ago
resolver_conn_wrapper.go 94b1e032bb vendor 4 years ago
rpc_util.go 94b1e032bb vendor 4 years ago
server.go 94b1e032bb vendor 4 years ago
service_config.go 94b1e032bb vendor 4 years ago
stream.go 94b1e032bb vendor 4 years ago
trace.go 94b1e032bb vendor 4 years ago
version.go 94b1e032bb vendor 4 years ago
vet.sh 94b1e032bb vendor 4 years ago

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

With Go module support (Go 1.11+), simply import "google.golang.org/grpc" in your source code and go [build|run|test] will automatically download the necessary dependencies (Go modules ref).

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

Prerequisites

gRPC-Go requires Go 1.9 or later.

Documentation

Performance

Performance benchmark data for grpc-go and other languages is maintained in this dashboard.

Status

General Availability Google Cloud Platform Launch Stages.

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. Please refer to this issue in the golang repo regarding this concern.

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.