GRPC for low-memory environments
Go to file
Kazuyoshi Kato ababa3fc18
Merge pull request #178 from djdongjin/bump-versions
Add dependabot and bump up golang and dependency versions
2025-01-14 09:57:47 -08:00
.github Upgrade go, dependency, CI versions 2024-12-30 01:42:33 +00:00
cmd Add optional feature in protobuf compiler 2024-02-21 13:51:52 -08:00
example Add makefile and update protoc version 2022-03-04 18:17:11 -08:00
integration Fix linter 2024-02-02 12:14:32 -08:00
internal Regenerated pb.go files to fix mismatches 2022-08-30 21:17:24 +00:00
plugin Add apache license to files 2018-06-27 17:49:06 -04:00
proto Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
script Update protobuf version and add service prefix 2022-07-05 23:59:44 -07:00
.gitattributes Use CR+LF instead of LF regardless of OS 2022-02-21 23:47:19 +00:00
.gitignore Add makefile and update protoc version 2022-03-04 18:17:11 -08:00
.golangci.yml Upgrade go, dependency, CI versions 2024-12-30 01:42:33 +00:00
LICENSE Initial commit 2017-11-13 14:12:46 -08:00
Makefile Update GitHub actions CI workflow 2023-03-08 23:06:15 +00:00
PROTOCOL.md PROTOCOL: slight markdown touchup 2022-04-19 12:33:27 -04:00
Protobuild.toml Update protobuf version and add service prefix 2022-07-05 23:59:44 -07:00
README.md Fix CI build status badge in readme 2024-02-29 15:43:55 +00:00
channel.go channel: allow discovery of overflown message size. 2024-08-27 11:23:20 +03:00
channel_test.go channel_test: update oversize message test. 2024-08-21 17:53:44 +03:00
client.go switch to github.com/containerd/log for logs 2024-06-19 23:19:35 +02:00
client_test.go Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
codec.go Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
config.go server: implement UnaryServerInterceptor chaining. 2023-08-25 15:57:58 +03:00
doc.go Add ttrpc protocol definition 2022-03-02 11:42:10 -08:00
errors.go channel: allow discovery of overflown message size. 2024-08-27 11:23:20 +03:00
go.mod Upgrade go, dependency, CI versions 2024-12-30 01:42:33 +00:00
go.sum Upgrade go, dependency, CI versions 2024-12-30 01:42:33 +00:00
handshake.go Fix lint issues 2022-01-21 12:04:30 -08:00
interceptor.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
interceptor_test.go Upgrade go, dependency, CI versions 2024-12-30 01:42:33 +00:00
metadata.go Add MD.Clone 2024-12-27 16:12:45 +00:00
metadata_test.go Add MD.Clone 2024-12-27 16:12:45 +00:00
request.pb.go Regenerated pb.go files to fix mismatches 2022-08-30 21:17:24 +00:00
request.proto Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
server.go server: fix Serve() vs. immediate Shutdown() race. 2024-09-16 09:52:00 +03:00
server_linux_test.go Use google.golang.org/protobuf instead of github.com/gogo/protobuf 2022-02-16 23:11:27 +00:00
server_test.go Upgrade go, dependency, CI versions 2024-12-30 01:42:33 +00:00
services.go Add comment 2024-02-03 09:50:16 -08:00
services_test.go Fix method full name generation 2019-08-23 13:28:19 -07:00
stream.go Add recvClose channel to stream 2023-05-08 12:26:34 -07:00
stream_server.go Introduce streaming to client and server 2022-04-07 17:11:40 -07:00
stream_test.go Upgrade go, dependency, CI versions 2024-12-30 01:42:33 +00:00
test.proto Add stream tests 2022-04-07 17:11:40 -07:00
unixcreds_linux.go Merge pull request #100 from tklauser/ucred-wrap-err 2022-01-21 15:00:05 -08:00

README.md

ttrpc

Build Status

GRPC for low-memory environments.

The existing grpc-go project requires a lot of memory overhead for importing packages and at runtime. While this is great for many services with low density requirements, this can be a problem when running a large number of services on a single machine or on a machine with a small amount of memory.

Using the same GRPC definitions, this project reduces the binary size and protocol overhead required. We do this by eliding the net/http, net/http2 and grpc package used by grpc replacing it with a lightweight framing protocol. The result are smaller binaries that use less resident memory with the same ease of use as GRPC.

Please note that while this project supports generating either end of the protocol, the generated service definitions will be incompatible with regular GRPC services, as they do not speak the same protocol.

Protocol

See the protocol specification.

Usage

Create a gogo vanity binary (see cmd/protoc-gen-gogottrpc/main.go for an example with the ttrpc plugin enabled.

It's recommended to use protobuild to build the protobufs for this project, but this will work with protoc directly, if required.

Differences from GRPC

  • The protocol stack has been replaced with a lighter protocol that doesn't require http, http2 and tls.
  • The client and server interface are identical whereas in GRPC there is a client and server interface that are different.
  • The Go stdlib context package is used instead.

Status

TODO:

  • Add testing under concurrent load to ensure
  • Verify connection error handling

Project details

ttrpc is a containerd sub-project, licensed under the Apache 2.0 license. As a containerd sub-project, you will find the:

information in our containerd/project repository.